{"id": "1daa17712cd0-0", "text": "User Interface\nOverview\nSugar's user interface is dependent on the client (i.e. base, mobile, or portal) being used to access the system. Clients are the various platforms that use Sugar's APIs to render the user interface. Each platform type will have a specific path for its components. While the Developer Guide mainly covers the base client type, the following sections will outline the various metadata locations.\nClients\nClients are the various platforms that access and use\u00c2\u00a0Sidecar to render content. Depending on the platform you are using, the layout, view, and metadata will be driven based on its client type. The following sections describe the client types.\nbase\nThe base client is the Sugar application that you use to access your data from a web browser. The framework's specific views, layouts, and fields are rendered using\u00c2\u00a0Sidecar. \u00c2\u00a0Files specific to this client type can be found in the following directories:\n./clients/base/\n./custom/clients/base/\n./modules/<module>/clients/base/\n./custom/modules/<module>/clients/base/\nmobile\nThe mobile client is the SugarCRM mobile application\u00c2\u00a0that you use to access data from your mobile device. The framework-specific views, layouts, and fields for this application are\u00c2\u00a0found in the following directories:\n./clients/mobile/\n./custom/clients/mobile/\n./modules/<module>/clients/mobile/\n./custom/modules/<module>/clients/mobile/\nportal\nThe portal client is the customer self-service portal application that comes with Sugar\u00c2\u00a0Enterprise and Sugar Ultimate.\u00c2\u00a0The framework-specific views, layouts, and fields for this application are\u00c2\u00a0found in the following directories:\n./clients/portal/\n./custom/clients/portal/\n./modules/<module>/clients/portal/\n./custom/modules/<module>/clients/portal/", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/index.html"}
{"id": "1daa17712cd0-1", "text": "TopicsSidecarSidecar is a platform that moves processing to the client side to render pages as single-page web apps. Sidecar contains a complete Model-View-Controller (MVC) framework based on the Backbone.js library.EventsThe Backbone events module is a lightweight pub-sub pattern that gets mixed into each Backbone class (Model, View, Collection, Router, etc.). This means that you can listen to or dispatch custom named events from any Backbone object.RoutesRoutes determine where users are directed based on patterns in the URL.HandlebarsThe Handlebars library, located in ./sidecar/lib/handlebars/, is a JavaScript library that lets Sugar create semantic templates. Handlebars help render content for layouts, views, and fields for Sidecar. Using Handlebars, you can make modifications to the display of content such as adding HTML or CSS.LayoutsLayouts are component plugins that define the overall layout and positioning of the page. Layouts replace the previous concept of MVC views and are used system-wide to generate rows, columns, bootstrap fluid layouts, and pop-ups by wrapping and placing multiple views or nested layouts on a page.ViewsViews are component plugins that render data from a context. View components may contain field components and are typically made up of a controller JavaScript file (.js) and at least one Handlebars template (.hbs).FieldsFields are component plugins that render and format field values. They are made up of a controller JavaScript file (.js) and at least one Handlebars template (.hbt). For more information regarding the data handling of a field, please refer the data framework fields documentation. For information on creating custom field types, please refer the Creating Custom Field Types cookbook example.SubpanelsFor Sidecar, Sugar's subpanel layouts have been modified to work as simplified metadata. This page is an overview of the metadata framework for subpanels.DashletsDashlets are special view-component plugins that render data from a context and make use of the Dashlet plugin. They are typically made up", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/index.html"}
{"id": "1daa17712cd0-2", "text": "that render data from a context and make use of the Dashlet plugin. They are typically made up of a controller JavaScript file (.js) and at least one Handlebars template (.hbs).DrawersThe drawer layout widget, located in ./clients/base/layouts/drawer/, is used to display a window of additional content to the user. This window can then be closed to display the content the user was previously viewing.AlertsThe alert view widget, located in ./clients/base/views/alert/, displays helpful information such as loading messages, notices, and confirmation messages to the user.LanguageThe language library, located in ./sidecar/src/core/language.js, is used to manage the user's display language as well as fetch labels and lists. For more information on customizing languages, please visit the language framework documentation.MainLayoutSugar's Main navigation is split into two components: Top-Header and Sidebar. The Top-Header is primarily used for search, notifications, and user actions and the Sidebar is the primary tool used to navigate the front end of the Sugar application.Administration LinksAdministration links are the shortcut URLs found on the Administration page in the Sugar application. Developers can create additional administration links using the extension framework.Legacy MVCThe legacy MVC Architecture.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/index.html"}
{"id": "1daa17712cd0-3", "text": "Last modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/index.html"}
{"id": "3537f8ac3d5e-0", "text": "Layouts\nOverview\nLayouts are component plugins that define the overall layout and positioning of the page. Layouts replace the previous concept of MVC views and are used system-wide to generate rows, columns, bootstrap fluid layouts, and pop-ups by wrapping and placing multiple views or nested layouts on a page.\nLayout components are typically made up of a controller JavaScript file (.js) and a PHP file (.php), however, layout types vary and are not dependent on having both files.\nHierarchy Diagram\nThe layout components are loaded in the following manner:\nNote: The Sugar application client type is \"base\". For more information on the various client types, please refer to\u00c2\u00a0the User Interface page.\nSidecar Layout Routing\nSidecar uses routing to determine where to direct the user. To route the user to a specific page in Sugar, refer to the following default URL formats:\nBehavior\nURL Format\nRoute the user to the list layout for a module\nhttp://{site url}/#<module>/\nRoute the user to the record layout for a specific record\nhttp://{site url}/#<module>/f82d09cb-48cd-a1fb-beae-521cf39247b5\nRoute the user to a custom layout for the module\nhttp://{site url}/#<module>/layout/<layout>\nLayout Example\nThe list layout, located in ./clients/base/layouts/list/, handles the layout for the list view. The sections below outline the various files that render this view.\nJavaScript\nThe file list.js, shown below, contains the JavaScript used to place the layout content.\n./clients/base/layouts/list/list.js\n/**\n* Layout that places components using bootstrap fluid layout divs\n* @class View.Layouts.ListLayout\n* @extends View.FluidLayout\n*/\n({\n    /**\n     * Places a view's element on the page. \n     * @param {View.View} comp", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Layouts/index.html"}
{"id": "3537f8ac3d5e-1", "text": "* @param {View.View} comp\n     * @protected\n     * @method\n     */\n    _placeComponent: function(comp, def) {\n        var size = def.size || 12;\n        // Helper to create boiler plate layout containers\n        function createLayoutContainers(self) {\n            // Only creates the containers once\n            if (!self.$el.children()[0]) {\n                comp.$el.addClass('list');\n            }\n        }\n        createLayoutContainers(this);\n        // All components of this layout will be placed within the\n        // innermost container div.\n        this.$el.append(comp.el);\n    }\n})\nLayout Definition\nThe layout definition is contained as an array in list.php. This layout definition contains four views:\nmassupdate\nmassaddtolist\nrecordlist\nlist-bottom\n./clients/base/layouts/list/list.php\n<?php\n$viewdefs['base']['layout']['list'] = array(\n    'components' =>\n    array(\n        array(\n            'view' => 'massupdate',\n        ),\n        array(\n            'view' => 'massaddtolist',\n        ),\n        array(\n            'view' => 'recordlist',\n            'primary' => true,\n        ),\n        array(\n            'view' => 'list-bottom',\n        ),\n    ),\n    'type' => 'simple',\n    'name' => 'list',\n    'span' => 12,\n);\nApplication\nFor information on working with layouts, please refer to the Creating Layouts and Overriding Layouts pages for practical examples.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Layouts/index.html"}
{"id": "3537f8ac3d5e-2", "text": "TopicsCreating LayoutsThis example explains how to create a custom layout to define the various components that load on a page.Overriding LayoutsThis page explains how to override a stock layout component. For this example, we will extend the stock record view and create a custom view named \"my-record\" that will be used in our record layout's override. This example involves two steps:\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Layouts/index.html"}
{"id": "a9a9c9ff86a7-0", "text": "Overriding Layouts\nOverview\nThis page explains how to override a stock layout component. For this example, we will extend the stock record view and create a custom view named \"my-record\" that will be used in our record layout's override. This example involves two\u00c2\u00a0steps:\nOverride the Layout\nExtend the View\nThese steps are explained in the following sections.\nOverriding the Layout\nFirst,\u00c2\u00a0copy ./clients/base/layouts/record/record.php to ./custom/clients/base/layouts/record/record.php. Once copied, modify the following line from:\n'view' => 'record',\nTo:\n'view' => 'my-record',\nThat line will change the record layout from using the base record.js view, ./clients/base/views/record/record.js, to instead use a custom view that we will create in ./custom/clients/base/views/my-record/my-record.js. At this point, the\u00c2\u00a0custom layout override should be very similar to the example below:\n./custom/clients/base/layouts/record/record.php\n<?php\n$viewdefs['base']['layout']['record'] = array(\n    'components' => array(\n        array(\n            'layout' => array(\n                'type' => 'default',\n                'name' => 'sidebar',\n                'components' => array(\n                    array(\n                        'layout' => array(\n                            'type' => 'base',\n                            'name' => 'main-pane',\n                            'css_class' => 'main-pane span8',\n                            'components' => array(\n                                array(\n                                    'view' => 'my-record',\n                                    'primary' => true,\n                                ),\n                                array(\n                                    'layout' => 'extra-info',\n                                ),\n                                array(\n                                    'layout' => array(\n                                        'type' => 'filterpanel',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Layouts/Overriding_Layouts/index.html"}
{"id": "a9a9c9ff86a7-1", "text": "'layout' => array(\n                                        'type' => 'filterpanel',\n                                        'last_state' => array(\n                                            'id' => 'record-filterpanel',\n                                            'defaults' => array(\n                                                'toggle-view' => 'subpanels',\n                                            ),\n                                        ),\n                                        'refresh_button' => true,\n                                        'availableToggles' => array(\n                                            array(\n                                                'name' => 'subpanels',\n                                                'icon' => 'fa-table',\n                                                'label' => 'LBL_DATA_VIEW',\n                                            ),\n                                            array(\n                                                'name' => 'list',\n                                                'icon' => 'fa-table',\n                                                'label' => 'LBL_LISTVIEW',\n                                            ),\n                                            array(\n                                                'name' => 'activitystream',\n                                                'icon' => 'fa-clock-o',\n                                                'label' => 'LBL_ACTIVITY_STREAM',\n                                            ),\n                                        ),\n                                        'components' => array(\n                                            array(\n                                                'layout' => 'filter',\n                                                'xmeta' => array(\n                                                    'layoutType' => '',\n                                                ),\n                                                'loadModule' => 'Filters',\n                                            ),\n                                            array(\n                                                'view' => 'filter-rows',\n                                            ),\n                                            array(\n                                                'view' => 'filter-actions',\n                                            ),\n                                            array(\n                                                'layout' => 'activitystream',\n                                                'context' =>\n                                                array(\n                                                    'module' => 'Activities',\n                                                ),\n                                            ),\n                                            array(\n                                                'layout' => 'subpanels',\n                                            ),\n                                        ),\n                                    ),\n                                ),\n                            ),\n                        ),\n                    ),\n                    array(\n                        'layout' => array(\n                            'type' => 'base',\n                            'name' => 'dashboard-pane',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Layouts/Overriding_Layouts/index.html"}
{"id": "a9a9c9ff86a7-2", "text": "'type' => 'base',\n                            'name' => 'dashboard-pane',\n                            'css_class' => 'dashboard-pane',\n                            'components' => array(\n                                array(\n                                    'layout' => array(\n                                        'type' => 'dashboard',\n                                        'last_state' => array(\n                                            'id' => 'last-visit',\n                                        )\n                                    ),\n                                    'context' => array(\n                                        'forceNew' => true,\n                                        'module' => 'Home',\n                                    ),\n                                    'loadModule' => 'Dashboards',\n                                ),\n                            ),\n                        ),\n                    ),\n                    array(\n                        'layout' => array(\n                            'type' => 'base',\n                            'name' => 'preview-pane',\n                            'css_class' => 'preview-pane',\n                            'components' => array(\n                                array(\n                                    'layout' => 'preview',\n                                ),\n                            ),\n                        ),\n                    ),\n                ),\n            ),\n        ),\n    ),\n);\nExtending the View\nFor this example, we will extend the stock record view and create a custom view named my-record that will be used in our record layouts override.\n./custom/clients/base/views/my-record/my-record.js\n({\n    extendsFrom: 'RecordView',\n    initialize: function (options) {\n        this._super(\"initialize\", [options]);\n        //log this point\n        console.log(\"**** Override called\");\n    }\n})\nOnce the files are in place, navigate to Admin > Repair > Quick Repair and Rebuild.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Layouts/Overriding_Layouts/index.html"}
{"id": "3177da3143e2-0", "text": "Creating Layouts\nOverview\nThis example\u00c2\u00a0explains how\u00c2\u00a0to create a custom layout to define the various components that load on a\u00c2\u00a0page.\u00c2\u00a0\nCreating the Layout\nThis example creates a component named \"my-layout\", which\u00c2\u00a0will render a custom view named \"my-view\".\n./custom/clients/base/layouts/my-layout/my-layout.php\n<?php\n    $viewdefs['base']['layout']['my-layout'] = array(\n        'type' => 'simple',\n        'components' => array(\n            array(\n                'view' => 'my-view',\n            ),\n        ),\n    );\nCreating a View\nThe view component will render the actual content we want to see on the page. The view below will display a clickable cube icon that will spin when clicked by the user.\n./custom/clients/base/views/my-view/my-view.js\n({\n    className: 'my-view tcenter',\n    cubeOptions: {\n        spin: false\n    },\n    events: {\n        'click .sugar-cube': 'spinCube'\n    },\n    spinCube: function() {\n        this.cubeOptions.spin = !this.cubeOptions.spin;\n        this.render();\n    }\n})\n./custom/clients/base/views/my-view/my-view.hbs\n<style>\n    div.my-view\n    {\n        padding-top: 5%;\n    }\n    div.my-view .sugar-cube\n    {\n        fill:#bbbbbb;\n        height:200px;\n        width:200px;\n        display: inline;\n    }\n</style>\n<h1>My View</h1>\n{{{subFieldTemplate 'sugar-cube' 'detail' cubeOptions}}}\n<p>Click to spin the cube!</p>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Layouts/Creating_Layouts/index.html"}
{"id": "3177da3143e2-1", "text": "<p>Click to spin the cube!</p>\nOnce the files are in place, navigate to Admin > Repair and perform a Quick Repair and Rebuild.\nNavigating to the Layout\nTo see this new\u00c2\u00a0layout and view, navigate to http://{site url}/#<module>/layout/my-layout.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Layouts/Creating_Layouts/index.html"}
{"id": "033d501482fe-0", "text": "Language\nOverview\nThe language library, located in ./sidecar/src/core/language.js, is used to manage the user's display language as well as fetch labels and lists. For more information on customizing languages, please visit the language framework documentation.\nMethods\napp.lang.get(key, module, context)\nThe app.lang.get(key, module, context) method fetches a string for a given key. The method searches the module strings first and then falls back to the app strings. If the label is a template, it will be compiled and executed with the given context.\nParameters\nName\nRequired\nDescription\nkey\nyes\nThe key of the string to retrieve\nmodule\nno\nThe Sugar module that the label belongs to\ncontext\nno\nTemplate context\nExample\napp.lang.get('LBL_NAME', 'Accounts');\napp.lang.getAppString(key)\nThe app.lang.getAppString(key) method retrieves an application string for a given key.\nParameters\nName\nRequired\nDescription\nkey\nyes\nThe key of the string to retrieve\nExample\napp.lang.getAppString('LBL_MODULE');\napp.lang.getAppListStrings(key)\nThe app.lang.getAppListStrings(key) method retrieves an application list string or object.\nParameters\nName\nRequired\nDescription\nkey\nyes\nThe key of the string to retrieve\nExample\napp.lang.getAppListStrings('sales_stage_dom');\napp.lang.getModuleSingular(moduleKey)\nThe app.lang.getModuleSingular(moduleKey) method retrieves an application list string or object.\nParameters\nName\nRequired\nDescription\nmoduleKey\nyes\nThe module key of the singular module label to retrieve\nExample\napp.lang.getModuleSingular(\"Accounts\");\napp.lang.getLanguage()\nThe app.lang.getLanguage() method retrieves the current user's language key.\nExample\napp.lang.getLanguage();\napp.lang.updateLanguage(languageKey)", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Language/index.html"}
{"id": "033d501482fe-1", "text": "Example\napp.lang.getLanguage();\napp.lang.updateLanguage(languageKey)\nThe app.lang.updateLanguage(languageKey) method updates the current user's language key.\nParameters\nName\nRequired\nDescription\nlanguageKey\nyes\nLanguage key of the language to set for the user\nExample\napp.lang.updateLanguage('en_us');\nTesting in Console\nTo test out the language library, you can trigger actions\u00c2\u00a0in your browsers developer tools by using the global Apps variable as shown below:\nApp.lang.getAppListStrings('sales_stage_dom');\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Language/index.html"}
{"id": "3a76fdeb8516-0", "text": "Subpanels\nOverview\nFor Sidecar, Sugar's subpanel layouts have been modified to work as simplified metadata.\u00c2\u00a0This page is an\u00c2\u00a0overview of the metadata framework for subpanels.\u00c2\u00a0\nThe reason for this change is that previous versions of Sugar generated the metadata from various sources such as the SubPanelLayout and MetaDataManager classes. This eliminates the need for generating and processing the layouts and allows the metadata to be easily loaded to Sidecar.\nNote:\u00c2\u00a0Modules running in backward compatibility mode do not use the Sidecar subpanel layouts as they use the legacy MVC framework.\nHierarchy Diagram\nWhen loading the Sidecar subpanel layouts, the system processes the layout in the following manner:\nNote: The Sugar application's client type is \"base\". For more information on the various client types, please refer to\u00c2\u00a0the User Interface page.\nSubpanels and Subpanel Layouts\nSugar contains both a subpanels (plural) layout and a subpanel (singular) layout. The subpanels layout contains the collection of subpanels,\u00c2\u00a0whereas\u00c2\u00a0the subpanel layout renders the actual subpanel widget.\nAn example of a stock module's subpanels layout is:\n./modules/Bugs/clients/base/layouts/subpanels/subpanels.php\n<?php\n$viewdefs['Bugs']['base']['layout']['subpanels'] = array (\n  'components' => array (\n      array (\n          'layout' => 'subpanel',\n          'label' => 'LBL_DOCUMENTS_SUBPANEL_TITLE',\n          'context' => array (\n              'link' => 'documents',\n          ),\n      ),\n      array (\n          'layout' => 'subpanel',\n          'label' => 'LBL_CONTACTS_SUBPANEL_TITLE',\n          'context' => array (\n              'link' => 'contacts',\n          ),\n      ),\n      array (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Subpanels/index.html"}
{"id": "3a76fdeb8516-1", "text": "'link' => 'contacts',\n          ),\n      ),\n      array (\n          'layout' => 'subpanel',\n          'label' => 'LBL_ACCOUNTS_SUBPANEL_TITLE',\n          'context' => array (\n              'link' => 'accounts',\n          ),\n      ),\n      array (\n          'layout' => 'subpanel',\n          'label' => 'LBL_CASES_SUBPANEL_TITLE',\n          'context' => array (\n              'link' => 'cases',\n          ),\n      ),\n  ),\n  'type' => 'subpanels',\n  'span' => 12,\n);\nYou can see that the layout incorporates the use of the subpanel layout for each module. As most of the subpanel data is similar, this approach allows us to use less duplicate code. The subpanel layout, shown below, shows the three views that make up the subpanel widgets users see.\n./clients/base/layouts/subpanel/subpanel.php\n<?php\n$viewdefs['base']['layout']['subpanel']  = array (\n    'components' => array (\n        array (\n            'view' => 'panel-top',\n        )\n        array (\n            'view' => 'subpanel-list',\n        ),\n        array (\n            'view' => 'list-bottom',\n        ),\n    ),\n    'span' => 12,\n    'last_state' => array(\n        'id' => 'subpanel'\n    ),\n);\nAdding Subpanel Layouts", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Subpanels/index.html"}
{"id": "3a76fdeb8516-2", "text": "),\n);\nAdding Subpanel Layouts\nWhen a new relationship is deployed from Studio, the relationship creation process will generate the layouts using the extension framework. You should note that for stock relationships and custom deployed relationships, layouts are generated for both Sidecar and Legacy MVC Subpanel formats. This is done to ensure that any related modules, whether in Sidecar or Backward Compatibility mode, display a related subpanel as expected.\nSidecar Layouts\nCustom Sidecar layouts, located in ./custom/Extension/modules/<module>/Ext/clients/<client>/layouts/subpanels/, are compiled into ./custom/modules/<module>/Ext/clients/<client>/layouts/subpanels/subpanels.ext.php using the extension framework. When a relationship is saved, layout files are created for both the \"base\" and \"mobile\" client types.\nFor example, deploying a 1:M relationship from Bugs to Leads will generate the following Sidecar files:\n./custom/Extension/modules/Bugs/Ext/clients/base/layouts/subpanels/bugs_leads_1_Bugs.php\n<?php\n$viewdefs['Bugs']['base']['layout']['subpanels']['components'][] = array (\n  'layout' => 'subpanel',\n  'label' => 'LBL_BUGS_LEADS_1_FROM_LEADS_TITLE',\n  'context' =>\n  array (\n    'link' => 'bugs_leads_1',\n  ),\n);\n./custom/Extension/modules/Bugs/Ext/clients/mobile/layouts/subpanels/bugs_leads_1_Bugs.php\n<?php\n$viewdefs['Bugs']['mobile']['layout']['subpanels']['components'][] = array (\n  'layout' => 'subpanel',\n  'label' => 'LBL_BUGS_LEADS_1_FROM_LEADS_TITLE',\n  'context' =>\n  array (\n    'link' => 'bugs_leads_1',\n  ),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Subpanels/index.html"}
{"id": "3a76fdeb8516-3", "text": "array (\n    'link' => 'bugs_leads_1',\n  ),\n);\nNote: The additional legacy MVC layouts generated by a relationships deployment are described below.\nLegacy MVC Subpanel Layouts\nCustom Legacy MVC Subpanel layouts, located in ./custom/Extension/modules/<module>/Ext/Layoutdefs/, are compiled into ./custom/modules/<module>/Ext/Layoutdefs/layoutdefs.ext.php using the extension framework. You should also note that when a relationship is saved, wireless layouts, located in ./custom/Extension/modules/<module>/Ext/WirelessLayoutdefs/, are created and compiled into ./custom/modules/<module>/Ext/Layoutdefs/layoutdefs.ext.php.\nAn example of this is when deploying a 1-M relationship from Bugs to Leads, the following layoutdef files are generated:\n./custom/Extension/modules/Bugs/Ext/Layoutdefs/bugs_leads_1_Bugs.php\n<?php\n$layout_defs[\"Bugs\"][\"subpanel_setup\"]['bugs_leads_1'] = array (\n  'order' => 100,\n  'module' => 'Leads',\n  'subpanel_name' => 'default',\n  'sort_order' => 'asc',\n  'sort_by' => 'id',\n  'title_key' => 'LBL_BUGS_LEADS_1_FROM_LEADS_TITLE',\n  'get_subpanel_data' => 'bugs_leads_1',\n  'top_buttons' =>\n  array (\n    0 =>\n    array (\n      'widget_class' => 'SubPanelTopButtonQuickCreate',\n    ),\n    1 =>\n    array (\n      'widget_class' => 'SubPanelTopSelectButton',\n      'mode' => 'MultiSelect',\n    ),\n  ),\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Subpanels/index.html"}
{"id": "3a76fdeb8516-4", "text": "'mode' => 'MultiSelect',\n    ),\n  ),\n);\n./custom/Extension/modules/Bugs/Ext/WirelessLayoutdefs/bugs_leads_1_Bugs.php\n<?php\n$layout_defs[\"Bugs\"][\"subpanel_setup\"]['bugs_leads_1'] = array (\n  'order' => 100,\n  'module' => 'Leads',\n  'subpanel_name' => 'default',\n  'title_key' => 'LBL_BUGS_LEADS_1_FROM_LEADS_TITLE',\n  'get_subpanel_data' => 'bugs_leads_1',\n);\nFields Metadata\nSidecar's subpanel field layouts are initially defined by the subpanel list-view metadata.\nHierarchy Diagram\nThe subpanel list metadata is loaded in the following manner:\nNote: The Sugar application's client type is \"base\". For more information on the various client types, please refer to\u00c2\u00a0the User Interface page.\nSubpanel List Views\nBy default, all modules come with a default set of subpanel fields for when they are rendered as a subpanel. An example of this is can be found in the Bugs module:\n./modules/Bugs/clients/base/views/subpanel-list/subpanel-list.php\n<?php\n$subpanel_layout['list_fields'] = array (\n  'full_name' =>\n  array (\n    'type' => 'fullname',\n    'link' => true,\n    'studio' =>\n    array (\n      'listview' => false,\n    ),\n    'vname' => 'LBL_NAME',\n    'width' => '10%',\n    'default' => true,\n  ),\n  'date_entered' =>\n  array (\n    'type' => 'datetime',\n    'studio' =>\n    array (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Subpanels/index.html"}
{"id": "3a76fdeb8516-5", "text": "'type' => 'datetime',\n    'studio' =>\n    array (\n      'portaleditview' => false,\n    ),\n    'readonly' => true,\n    'vname' => 'LBL_DATE_ENTERED',\n    'width' => '10%',\n    'default' => true,\n  ),\n  'refered_by' =>\n  array (\n    'vname' => 'LBL_LIST_REFERED_BY',\n    'width' => '10%',\n    'default' => true,\n  ),\n  'lead_source' =>\n  array (\n    'vname' => 'LBL_LIST_LEAD_SOURCE',\n    'width' => '10%',\n    'default' => true,\n  ),\n  'phone_work' =>\n  array (\n    'vname' => 'LBL_LIST_PHONE',\n    'width' => '10%',\n    'default' => true,\n  ),\n  'lead_source_description' =>\n  array (\n    'name' => 'lead_source_description',\n    'vname' => 'LBL_LIST_LEAD_SOURCE_DESCRIPTION',\n    'width' => '10%',\n    'sortable' => false,\n    'default' => true,\n  ),\n  'assigned_user_name' =>\n  array (\n    'name' => 'assigned_user_name',\n    'vname' => 'LBL_LIST_ASSIGNED_TO_NAME',\n    'widget_class' => 'SubPanelDetailViewLink',\n    'target_record_key' => 'assigned_user_id',\n    'target_module' => 'Employees',\n    'width' => '10%',\n    'default' => true,\n  ),\n  'first_name' =>\n  array (\n    'usage' => 'query_only',\n  ),\n  'last_name' =>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Subpanels/index.html"}
{"id": "3a76fdeb8516-6", "text": "'usage' => 'query_only',\n  ),\n  'last_name' =>\n  array (\n    'usage' => 'query_only',\n  ),\n  'salutation' =>\n  array (\n    'name' => 'salutation',\n    'usage' => 'query_only',\n  ),\n);\nTo modify this layout, navigate to Admin > Studio > {Parent Module} > Subpanels > Bugs and make your changes. Once saved, Sugar will generate ./custom/modules/Bugs/clients/<client>/views/subpanel-for-<link>/subpanel-for-<link>.php which will be used for rendering the fields you selected.\nYou should note that, just as Sugar mimics the Sidecar layouts in the legacy MVC framework for modules in backward compatibility, it also mimics the field list in ./modules/<module>/metadata/subpanels/default.php and ./custom/modules/<module>/metadata/subpanels/default.php. This is done to ensure that any related modules, whether in Sidecar or Backward Compatibility mode, display the same field list as expected.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Subpanels/index.html"}
{"id": "80d585ae9be3-0", "text": "Legacy MVC\nOverview\nThe\u00c2\u00a0legacy MVC Architecture.\nYou should note that the MVC architecture is being deprecated and is being replaced with sidecar. Until the framework is fully deprecated, modules set in backward compatibility mode will still use the MVC framework.\nModel-View-Controller (MVC) Overview\nA model-view-controller, or MVC, is a design philosophy that creates a distinct separation between business-logic and display logic.\nModel : This is the data object built by the business/application logic needed to present in the user interface. For Sugar, it is represented by the SugarBean and all subclasses of the SugarBean.\nView : This is the display layer which is responsible for rendering data from the Model to the end-user.\nController : This is the layer that handles user events such as \"Save\" and determines what business logic actions to take to build the model, and which view to load for rendering the data to end users.\nSugarCRM MVC Implementation\nThe following is a sequence diagram that highlights some of the main components involved within the Sugar MVC framework.\n\u00c2\u00a0\nTopicsViewDisplaying information to the browser.ControllerThe basic actions of a module.MetadataAn overview of the legacy MVC metadata framework.ExamplesProvides an overview of example MVC customizations.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/index.html"}
{"id": "fef8b569439a-0", "text": "Controller\nOverview\nThe basic actions of a module.\nControllers\nThe main controller, named SugarController, addresses the basic actions of a module from EditView and DetailView to saving a record. Each module can override this SugarController by adding a controller.php file into its directory. This file extends the SugarController, and the naming convention for the class is: <module>Controller\nInside the controller, you define an action method. The naming convention for the method is: action_<action name>\nThere are more fine-grained control mechanisms that a developer can use to override the controller processing. For example, if a developer wanted to create a new save action, there are three places where they could possibly override.\naction_save: This is the broadest specification and gives the user full control over the save process.\npre_save: A user could override the population of parameters from the form.\npost_save: This is where the view is being set up. At this point, the developer could set a redirect URL, do some post-save processing, or set a different view.\nUpgrade-Safe Implementation\nYou can also add a custom Controller that extends the module's Controller if such a Controller already exists. For example, if you want to extend the Controller for a module, you should check if that module already has a module-specific controller. If so, you extend from that controller class. Otherwise, you extend from SugarController class. In both cases, you should place the custom controller class file in ./custom/modules/<module>/Controller.php instead of the module directory. Doing so makes your customization upgrade-safe.\nFile Structure\n./include/MVC/Controller/SugarController.php\n./include/MVC/Controller/ControllerFactory.php\n./modules/<module>/Controller.php\n./custom/modules/<module>/controller.php\nImplementation\nIf the module does not contain a controller.php file in ./modules/<module>/, you will create the following file:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Controller/index.html"}
{"id": "fef8b569439a-1", "text": "./custom/modules/<module>/controller.php\nclass <module>Controller extends SugarController\n{\n    function action_<action>()\n    {\n        $this->view = '<action lowercase>';\n    }\n}\nIf the module does contain a controller.php file, you will need to extend it by doing the following:\n./custom/modules/<module>/controller.php\nrequire_once 'modules/<module>/controller.php';\nclass Custom<module>Controller extends <module>Controller\n{\n    function action_<action>()\n    {\n        $this->view = '<action lowercase>';\n    }\n}\nNote: When creating or moving files you will need to rebuild the file map.\nMore information on rebuilding the file map can be found in the SugarAutoLoader.\nMapping Actions to Files\nYou can choose not to provide a custom action method as defined above, and instead, specify your mappings of actions to files in $action_file_map. Take a look at ./include/MVC/Controller/action_file_map.php as an example:\n$action_file_map['subpanelviewer'] = 'include/SubPanel/SubPanelViewer.php';\n$action_file_map['save2'] = 'include/generic/Save2.php';\n$action_file_map['deleterelationship'] = 'include/generic/DeleteRelationship.php';\n$action_file_map['import'] = 'modules/Import/index.php';\nHere the developer has the opportunity to map an action to a file. For example, Sugar uses a generic sub-panel file for handling subpanel actions. You can see above that there is an entry mapping the action 'subpanelviewer' to ./include/SubPanel/SubPanelViewer.php.\nThe base SugarController class loads the action mappings in the following path sequence:\n./include/MVC/Controller\n./modules/<module>\n./custom/modules/<module>\n./custom/include/MVC/Controller", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Controller/index.html"}
{"id": "fef8b569439a-2", "text": "./custom/modules/<module>\n./custom/include/MVC/Controller\nEach one loads and overrides the previous definition if in conflict. You can drop a new action_file_map in the later path sequence that extends or overrides the mappings defined in the previous one.\nUpgrade-Safe Implementation\nIf you want to add custom action_file_map.php to an existing module that came with the SugarCRM release, you should place the file at ./custom/modules/<module>/action_file_map.php\nFile Structure\n./include/MVC/Controller/action_file_map.php\n./modules/<module>/action_file_map.php\n./custom/modules/<module>/action_file_map.php\nImplementation\n$action_file_map['soapRetrieve'] = 'custom/SoapRetrieve/soap.php';\nClassic Support (Not Recommended)\nClassic support allows you to have files that represent actions within your module. Essentially, you can drop in a PHP file into your module and have that be handled as an action. This is not recommended, but is considered acceptable for backward compatibility. The better practice is to take advantage of the action_<action> structure.\nFile Structure\n./modules/<module>/<action>.php\nController Flow Overview\nFor example, if a request comes in for DetailView the controller will handle the request as follows:\nStart in index.php and load the SugarApplication instance.\nSugarApplication instantiates the SugarControllerFactory.\nSugarControllerFactory loads the appropriate Controller.\nSugarControllerFactory checks for ./custom/modules/<module>/Controller.php.\nIf not found, check for ./modules/<module>/Controller.php.\nIf not found, load SugarController.php.\nCalls on the appropriate action.\nLook for ./custom/modules/<module>/<action>.php. If found and ./custom/modules/<module>/views/view.<action>.php is not found, use this view.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Controller/index.html"}
{"id": "fef8b569439a-3", "text": "If not found check for modules/<module>/<action>.php. If found and ./modules/<module>/views/view.<action>.php is not found, then use the ./modules/<module>/<action>.php action.\nIf not found, check for the method action_<action> in the controller.\nIf not found, check for an action_file_mapping.\nIf not found, report error \"Action is not defined\".\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Controller/index.html"}
{"id": "8de86a97c55a-0", "text": "View\nOverview\nDisplaying information to the browser.\nWhat are Views?\nViews, otherwise known as actions, are typically used to render views or to process logic. Views are not just limited to HTML data. You can send JSON encoded data as part of a view or any other structure you wish. As with the controllers, there is a default class called SugarView which implements much of the basic logic for views, such as handling of headers and footers.\nThere are five main actions for a module:\nDisplay Actions\nDetail View: A detail view displays a read-only view of a particular record. Usually, this is accessed via the list view. The detail view displays the details of the object itself and related items (subpanels). Subpanels are miniature list views of items that are related to the parent object. For example, Tasks assigned to a Project, or Contacts for an Opportunity will appear in subpanels in the Project or Opportunity detail view. The file ./<module>/metadata/detailviewdefs.php defines a module's detail view page layout. The file ./<module>/metadata/subpaneldefs.php defines the subpanels that are displayed in the module's detail view page.\nEdit View: The edit view page is accessed when a user creates a new record or edits details of an existing one. Edit view can also be accessed directly from the list view. The file ./<module>/metadata/editviewdefs.php defines a module's edit view page layout.\nList View: This Controller action enables the search form and search results for a module. Users can perform actions such as delete, export, update multiple records (mass update), and drill into a specific record to view and edit the details. Users can see this view by default when they click one of the module tabs at the top of the page. Files in each module describe the contents of the list and search view.\nProcess Actions", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/View/index.html"}
{"id": "8de86a97c55a-1", "text": "Process Actions\nSave: This Controller action is processed when the user clicks Save in the record's edit view.\nDelete: This action is processed when the user clicks \"Delete\" in the detail view of a record or in the detail view of a record listed in a subpanel.\nImplementation\nClass File Structure\n./include/MVC/Views/SugarView.php\n./include/MVC/Views/view.<view>.php\n./custom/include/MVC/Views/view.<view>.php\n./modules/<module>/views/view.<view>.php\n./custom/modules/<module>/views/view.<view>.php\nClass Loading\nThe ViewFactory class loads the view based off the the following sequence loading the first file it finds:\n./custom/modules/<module>/views/view.<view>.php\n./modules/<module>/views/view.<view>.php\n./custom/include/MVC/View/view.<view>.php\n./include/MVC/Views/view.<view>.php\nMethods\nThere are two main methods to override within a view:\npreDisplay(): This performs pre-processing within a view. This method is relevant only for extending existing views. For example, the include/MVC/View/views/view.edit.php file uses it, and enables developers who wishes to extend this view to leverage all of the logic done in preDisplay() and either override the display() method completely or within your own display() method call parent::display().\ndisplay(): This method displays the data to the screen. Place the logic to display output to the screen here.\nCreating Views\nCreating a new/view action consists of a controller action and a view file. The first step is to define your controller action. If the module does not contain a controller.php file in ./modules/<module>/ you will create the following file:\n./custom/modules/<module>/controller.php\n<?php\nclass <module>Controller extends SugarController\n{\n    function action_MyView()", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/View/index.html"}
{"id": "8de86a97c55a-2", "text": "class <module>Controller extends SugarController\n{\n    function action_MyView()\n    {\n        $this->view = 'myview';\n    }\n}\nMore information on controllers can be found in the Controller section.\nThe next step is to define your view file. This example extends the ViewDetail class but you can extend any of the classes you choose in ./include/MVC/View/views/.\n./custom/modules/<module>/views/view.newview.php\n<?php\nrequire_once 'include/MVC/View/views/view.detail.php' ;\nclass <module>ViewMyView extends ViewDetail\n{\n    function display()\n    {\n        echo 'This is my new view<br>';\n    }\n}\nOverriding Views\nThe following section will demonstrate how to extend and override a view. When overriding existing actions and views, you won't need to make any changes to the controller. This approach will be very similar for any view you may choose to modify. If the module you are extending the view for does not contain an existing view in its modules views directory ( ./modules/<module>/views/ ), you will need to extend the views base class. Otherwise, you will extend the view class found within the file.\nIn the case of a detail view, you would check for the file ./modules/<module>/views/view.detail.php. If this file does not exist, you will create ./custom/modules/<module>/views/view.detail.php and extend the base ViewDetail class with the name <module>ViewDetail.\n./custom/modules/<module>/views/view.detail.php\n<?php\nrequire_once('include/MVC/View/views/view.detail.php');\nclass <module>ViewDetail extends ViewDetail\n{\n    function display()\n    {\n        echo 'This is my addition to the DetailView<br>';\n        //call parent display method\n        parent::display();\n    }\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/View/index.html"}
{"id": "8de86a97c55a-3", "text": "//call parent display method\n        parent::display();\n    }\n}\nIf ./modules/<module>/views/view.detail.php does exist, you would create ./custom/modules/<module>/views/view.detail.php and extend the base <module>ViewDetail class with the name Custom<module>ViewDetail.\n./custom/modules/<module>/views/view.detail.php\n<?php\nrequire_once('modules/<module>/views/view.detail.php');\nclass Custom<module>ViewDetail extends <module>ViewDetail\n{\n    function display()\n    {\n        echo 'This is my addition to the DetailView<br>';\n        //call parent display method\n        parent::display();\n    }\n}\nDisplay Options for Views\nThe Sugar MVC provides developers with granular control over how the screen looks when a view is rendered. Each view can have a config file associated with it. In the case of an edit view, the developer would create the file ./customs/modules/<module>/views/view.edit.config.php . When the edit view is rendered, this config file will be picked up. When loading the view, ViewFactory class will merge the view config files from the following possible locations with precedence order (high to low):\n./customs/modules/<module>/views/view.<view>.config.php\n./modules/<module>/views/view.<view>.config.php\n./custom/include/MVC/View/views/view.<view>.config.php\n./include/MVC/View/views/view.<view>.config.php\nImplementation\nThe format of these files is as follows:\n$view_config = array(\n    'actions' =>\n        array(\n            'popup' => array(\n            'show_header' => false,\n            'show_subpanels' => false,\n            'show_search' => false, \n            'show_footer' => false,\n            'show_JavaScript' => true,\n        ),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/View/index.html"}
{"id": "8de86a97c55a-4", "text": "'show_JavaScript' => true,\n        ),\n    ),\n    'req_params' => array(\n        'to_pdf' => array(\n            'param_value' => true,\n            'config' => array(\n                'show_all' => false\n            ),\n        ),\n    ),\n);\nTo illustrate this process, let us take a look at how the 'popup' action is processed. In this case, the system will go to the actions entry within the view_config and determine the proper configuration. If the request contains the parameter to_pdf, and is set to be true, then it will automatically cause the show_all configuration parameter to be set false, which means none of the options will be displayed.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/View/index.html"}
{"id": "b7b52ac14944-0", "text": "Examples\nProvides an overview of example MVC customizations.\u00c2\u00a0\nTopicsChanging the ListView Default Sort OrderThis article addresses the need to customize the advanced search layout options for modules in backward compatibility mode to change the default sort order from ascending to descending.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Examples/index.html"}
{"id": "f14b3f143ead-0", "text": "Changing the ListView Default Sort Order\nOverview\nThis article addresses the need to customize the advanced search layout options for modules in backward compatibility mode to change the default sort order from ascending to descending.\nCustomization Information\nThis customization is only for modules in backward compatibility mode and involves creating custom files that extend stock files. You should note that this customization does not address all scenarios within the view that may assign a sort order.\nExtending the Search Form\nFirst, we will need to extend the SearchForm class. To do this, we will create a CustomSearchForm class that extends the original SearchForm class located in ./include/SearchForm/SearchForm2.php. We will then override the _displayTabs method to check the $_REQUEST['sortOrder'] and default it to descending if it isn't set.\n./custom/include/SearchForm/SearchForm2.php\n<?php\nrequire_once 'include/SearchForm/SearchForm2.php';\nclass CustomSearchForm extends SearchForm\n{\n    /**\n     * displays the tabs (top of the search form)\n     *\n     * @param string $currentKey key in $this->tabs to show as the current tab\n     *\n     * @return string html\n     */\n    function _displayTabs($currentKey)\n    {\n        //check and set the default sort order\n        if (!isset($_REQUEST['sortOrder']))\n        {\n            $_REQUEST['sortOrder'] = 'DESC';\n        }\n        return parent::_displayTabs($currentKey);;\n    }\n}\n?>\nExtending the List View\nNext, we will need to extend the ListView. We will create a ViewCustomList class that extends the original ListView located in ./include/MVC/View/views/view.list.php. In the ViewCustomList class, we will override the prepareSearchForm and getSearchForm2 methods to call the CustomSearchForm class.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Examples/Changing_the_ListView_Default_Sort_Order/index.html"}
{"id": "f14b3f143ead-1", "text": "./custom/include/MVC/View/views/view.customlist.php\n<?php\nrequire_once 'include/MVC/View/views/view.list.php';\nclass ViewCustomList extends ViewList\n{\n    function prepareSearchForm()\n    {\n        $this->searchForm = null;\n        //search\n        $view = 'basic_search';\n        if(!empty($_REQUEST['search_form_view']) && $_REQUEST['search_form_view'] == 'advanced_search')\n            $view = $_REQUEST['search_form_view'];\n        $this->headers = true;\n        if(!empty($_REQUEST['search_form_only']) && $_REQUEST['search_form_only'])\n            $this->headers = false;\n        elseif(!isset($_REQUEST['search_form']) || $_REQUEST['search_form'] != 'false')\n        {\n            if(isset($_REQUEST['searchFormTab']) && $_REQUEST['searchFormTab'] == 'advanced_search')\n            {\n                $view = 'advanced_search';\n            }\n            else\n            {\n                $view = 'basic_search';\n            }\n        }\n        $this->view = $view;\n        $this->use_old_search = true;\n        if (SugarAutoLoader::existingCustom('modules/' . $this->module . '/SearchForm.html') &&\n            !SugarAutoLoader::existingCustom('modules/' . $this->module . '/metadata/searchdefs.php')) {\n            require_once('include/SearchForm/SearchForm.php');\n            $this->searchForm = new SearchForm($this->module, $this->seed);\n            }  else {\n            $this->use_old_search = false;\n            //Updated to require the extended CustomSearchForm class\n            require_once('custom/include/SearchForm/SearchForm2.php');\n            $searchMetaData = SearchForm::retrieveSearchDefs($this->module);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Examples/Changing_the_ListView_Default_Sort_Order/index.html"}
{"id": "f14b3f143ead-2", "text": "$searchMetaData = SearchForm::retrieveSearchDefs($this->module);\n            $this->searchForm = $this->getSearchForm2($this->seed, $this->module, $this->action);\n            $this->searchForm->setup($searchMetaData['searchdefs'], $searchMetaData['searchFields'], 'SearchFormGeneric.tpl', $view, $this->listViewDefs);\n            $this->searchForm->lv = $this->lv;\n        }\n    }\n    /**\n     * Returns the search form object\n     *\n     * @return SearchForm\n     */\n    protected function getSearchForm2($seed, $module, $action = \"index\")\n    {\n        //Updated to use the extended CustomSearchForm class\n        return new CustomSearchForm($seed, $module, $action);\n    }\n}\n?>\nExtending the Sugar Controller\nFinally, we will create a CustomSugarController class that extends the orginal SugarController located in ./include/MVC/Controller/SugarController.php. We will then need to override the do_action and post_action methods to execute their parent methods as well as the action_listview method to assign the custom view to the view attribute.\n./custom/include/MVC/Controller/SugarController.php\n<?php\n/**\n* Custom SugarCRM controller\n* @api\n*/\nclass CustomSugarController extends SugarController\n{\n    /**\n     * Perform the specified action.\n     * This can be overridde in a sub-class\n     */\n    private function do_action()\n    {\n        return parent::do_action();\n    }\n    /**\n     * Perform an action after to the specified action has occurred.\n     * This can be overridde in a sub-class\n     */\n    private function post_action()\n    {\n        return parent::post_action();", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Examples/Changing_the_ListView_Default_Sort_Order/index.html"}
{"id": "f14b3f143ead-3", "text": "private function post_action()\n    {\n        return parent::post_action();\n    }\n    /**\n     * Perform the listview action\n     */\n    protected function action_listview()\n    {\n        parent::action_listview();\n        //set the new custom view\n        $this->view = 'customlist';\n    }\n}\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Examples/Changing_the_ListView_Default_Sort_Order/index.html"}
{"id": "02125e64959d-0", "text": "Metadata\nOverview\nAn overview of the legacy MVC metadata framework.\nYou should note that the MVC architecture is being deprecated and is being replaced with sidecar. Until the framework is fully deprecated, modules set in backward compatibility mode will still use the legacy MVC framework.\nMetadata Framework\nBackground\nMetadata is defined as information about data. In Sugar, metadata refers to the framework of using files to abstract the presentation and business logic found in the system. The metadata framework is described in definition files that are processed using PHP. The processing usually includes the use of Smarty templates for rendering the presentation and JavaScript libraries to handle some business logic that affects conditional displays, input validation, and so on.\nApplication Metadata\nAll application modules are defined in the modules.php file. It contains several variables that define which modules are active and usable in the application.\nThe file is located under the '<sugar root>/include' folder. It contains the $moduleList() array variable which contains the reference to the array key to look up the string to be used to display the module in the tabs at the top of the application. The coding standard is for the value to be in the plural of the module name; for example, Contacts, Accounts, Widgets, and so on.\nThe $beanList() array stores a list of all active beans (modules) in the application. The $beanList entries are stored in a 'name' => 'value' fashion with the 'name' value being in the plural and the 'value' being in the singular of the module name. The 'value' of a $beanList() entry is used to lookup values in our next modules.php variable, the $beanFiles() array.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/index.html"}
{"id": "02125e64959d-1", "text": "The $beanFiles variable is also stored in a 'name' => 'value' fashion. The 'name', typically in singular, is a reference to the class name of the object, which is looked up from the $beanList 'value', and the 'value' is a reference to the class file.\nThe remaining relevant variables in the modules.php file are the $modInvisList variable which makes modules invisible in the regular user interface (i.e., no tab appears for these modules), and the $adminOnlyList which is an extra level of security for modules that are accessible only by administrators through the Admin page.\nModule Metadata\nThe following table lists the metadata definition files found in the modules/[module]/metadata directory, and a brief description of their purpose within the system.\nFile\nDescription\nadditionalDetails.php\nUsed to render the popup information displayed when a user hovers the mouse cursor over a row in the List View.\neditviewdefs.php\nUsed to render a record's EditView.\ndetailviewdefs.php\nUsed to render a record's DetailView.\nlistviewdefs.php\nUsed to render the List View display for a module.\nmetafiles.php\nUsed to override the location of the metadata definition file to be used. The EditView, DetailView, List View, and Popup code check for the presence of these files.\npopupdefs.php\nUsed to render and handle the search form and list view in popups.\nsearchdefs.php\nUsed to render a module's basic and advanced search form displays.\nsidecreateviewdefs.php\nUsed to render a module's quick create form shown in the side shortcut panel.\nsubpaneldefs.php\nUsed to render a module's subpanels shown when viewing a record's DetailView.\nSearchForm Metadata\nThe search form layout for each module is defined in the module's metadata file searchdefs.php. A sample of the Accounts searchdefs.php appears as:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/index.html"}
{"id": "02125e64959d-2", "text": "<?php\n    $searchdefs['Accounts'] = array(\n        'templateMeta' => array(\n            'maxColumns' => '3',\n            'widths' => array(\n                'label' => '10', \n                'field' => '30'\n            )\n        ),\n        'layout' => array(\n            'basic_search' => array(\n                'name',\n                'billing_address_city',\n                'phone_office',\n                array(\n                    'name' => 'address_street',\n                    'label' => 'LBL_BILLING_ADDRESS',\n                    'type' => 'name',\n                    'group' => 'billing_address_street'\n                ),\n                array( \n                    'name' => 'current_user_only',\n                    'label' => 'LBL_CURRENT_USER_FILTER',\n                    'type'=>'bool'\n                ),\n            ),\n            'advanced_search' => array(\n                'name',\n                array( \n                    'name' => 'address_street',\n                    'label' => 'LBL_ANY_ADDRESS',\n                    'type' => 'name'\n                ),\n                array( \n                    'name' => 'phone',\n                    'label' => 'LBL_ANY_PHONE',\n                    'type' => 'name'\n                ),\n                'website',\n                array( \n                    'name' => 'address_city',\n                    'label' => 'LBL_CITY',\n                    'type' => 'name'\n                ),\n                array( \n                    'name' => 'email',\n                    'label' =>'LBL_ANY_EMAIL',\n                    'type' => 'name'\n                ),\n                'annual_revenue',\n                array( \n                    'name' => 'address_state',\n                    'label' =>'LBL_STATE',\n                    'type' => 'name'", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/index.html"}
{"id": "02125e64959d-3", "text": "'label' =>'LBL_STATE',\n                    'type' => 'name'\n                ),\n                'employees',\n                array( \n                    'name' => 'address_postalcode',\n                    'label' =>'LBL_POSTAL_CODE',\n                    'type' => 'name'\n                ),\n                array(\n                    'name' => 'billing_address_country',\n                    'label' =>'LBL_COUNTRY',\n                    'type' => 'name'\n                ),\n                'ticker_symbol',\n                'sic_code',\n                'rating',\n                'ownership',\n                array( \n                    'name' => 'assigned_user_id',\n                    'type' => 'enum',\n                    'label' => 'LBL_ASSIGNED_TO',\n                    'function' => array(\n                        'name' =>'get_user_array',\n                        'params' => array(false)\n                    )\n                ),\n                'account_type',\n                'industry',\n            ),\n        ),\n    );\n?>\nThe searchdefs.php file contains the Array variable $searchDefs with one entry. The key is the name of the module as defined in $moduleList array defined in include/modules.php. The $searchDefsarray is another array that describes the search form layout and fields.\nThe 'templateMeta' key points to another array that controls the maximum number of columns in each row of the search form ('maxColumns'), as well as layout spacing attributes as defined by 'widths'. In the above example, the generated search form files will allocate 10% of the width spacing to the labels and 30% for each field respectively.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/index.html"}
{"id": "02125e64959d-4", "text": "The 'layout' key points to another nested array which defines the fields to display in the basic and advanced search form tabs. Each individual field definition maps to a SugarField widget. See the SugarField widget section for an explanation about SugarField widgets and how they are rendered for the search form, DetailView, and EditView.\nThe searchdefs.php file is invoked from the MVC framework whenever a module's list view is rendered (see include/MVC/View/views/view.list.php). Within view.list.php, checks are made to see if the module has defined a SearchForm.html file. If this file exists, the MVC will run in classic mode and use the aforementioned include/SearchForm/SearchForm.php file to process the search form. Otherwise, the new search form processing is invoked using include/SearchForm/SearchForm2.php and the searchdefs.php file is scanned for, first under the custom/modules/[module]/metadata directory and then in modules/[module]/metadata.\nThe processing flow for the search form using the metadata subpaneldefs.php file is similar to that of EdiView and DetailView.\nDetailView and EditView Metadata\nMetadata files are PHP files that declare nested Array values that contain information about the view, such as buttons, hidden values, field layouts, and more. Following is a visual diagram representing how the Array values declared in the Metadata file are nested:\nThe following diagram highlights the process of how the application determines which Metadata file is to be used when rendering a request for a view:\nThe \"Classic Mode\" on the right hand side of the diagram represents the SugarCRM pre-5.x rendering of a Detail/Editview. This section will focus on the MVC/Metadata mode.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/index.html"}
{"id": "02125e64959d-5", "text": "When the view is first requested, the preDisplay method will attempt to find the correct Metadata file to use. Typically, the Metadata file will exist in the [root level]/modules/[module]/metadata directory, but in the event of edits to a layout through the Studio interface, a new Metadata file will be created and placed in the [root level]/custom/modules/[module]/metadata directory. This is done so that changes to layouts may be restored to their original state through Studio, and also to allow changes made to layouts to be upgrade-safe when new patches and upgrades are applied to the application. The metafiles.php file that may be loaded allows for the loading of Metadata files with alternate naming conventions or locations. An example of the metafiles.php contents can be found for the Accounts module (though it is not used by default in the application).\n$metafiles['Accounts'] = array(\n    'detailviewdefs' => 'modules/Accounts/metadata/detailviewdefs.php',\n    'editviewdefs' => 'modules/Accounts/metadata/editviewdefs.php',\n    'ListViewdefs' => 'modules/Accounts/metadata/ListViewdefs.php',\n    'searchdefs' => 'modules/Accounts/metadata/searchdefs.php',\n    'popupdefs' => 'modules/Accounts/metadata/popupdefs.php',\n    'searchfields' => 'modules/Accounts/metadata/SearchFields.php',\n);\nAfter the Metadata file is loaded, the preDisplay method also creates an EditView object and checks if a Smarty template file needs to be built for the given Metadata file. The EditView object does the bulk of the processing for a given Metadata file (creating the template, setting values, setting field level ACL controls if applicable, etc.). Please see the EditView process diagram for more detailed information about these steps.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/index.html"}
{"id": "02125e64959d-6", "text": "After the preDisplay method is called in the view code, the display method is called, resulting in a call to the EditView object's process method, as well as the EditView object's display method.\nThe EditView class is responsible for the bulk of the Metadata file processing and creation of the resulting display. The EditView class also checks to see if the resulting Smarty template is already created. It also applies the field level ACL controls for Sugar Sell, Serve, Ultimate, Enterprise, Corporate, and Professional.\nThe classes responsible for displaying the Detail View and SearchForm also extend and use the EditView class. The ViewEdit, ViewDetail and ViewSidequickcreate classes use the EditView class to process and display their contents. Even the file that renders the quick create form display (SubpanelQuickCreate.php) uses the EditView class. DetailView (in DetailView2.php) and SearchForm (in SearchForm2.php) extend the EditView class while SubpanelQuickCreate.php uses an instance of the EditView class. The following diagram highlights these relationships.\nThe following diagram highlights the EditView class's main responsibilities and their relationships with other classes in the system. We will use the example of a DetailView request although the sequence will be similar for other views that use the EditView class.\nOne thing to note is the EditView class's interaction with the TemplateHandler class. The TemplateHandler class is responsible for generating a Smarty template in the cache/modules/<module> directory. For example, for the Accounts module, the TemplateHandler will create the Smarty file, cache/modules/Accounts/DetailView.tpl, based on the Metadata file definition and other supplementary information from the EditView class. The TemplateHandler class actually uses Smarty itself to generate the resulting template that is placed in the aforementioned cache directory.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/index.html"}
{"id": "02125e64959d-7", "text": "Some of the modules that are available in the SugarCRM application also extend the ViewDetail class. One example of this is the DetailView for the Projects module. As mentioned in the MVC section, it is possible to extend the view classes by placing a file in the modules/<module>/views directory. In this case, a view.detail.php file exists in the modules/Projects/views folder. This may serve as a useful example in studying how to extend a view and apply additional field/layout settings not provided by the EditView class.\nThe following diagram shows the files involved with the DetailView example in more detail:\nA high level processing summary of the components for DetailViews follows:\nThe MVC framework receives a request to process the DetaiView.php (A) action for a module. For example, a record is selected from the list view shown on the browser with URL:\nindex.php?action=DetailView&module=Opportunities&record=46af9843-ccdf-f489-8833\nAt this point the new MVC framework checks to see if there is a DetailView.php (A2) file in the modules/Opportunity directory that will override the default DetailView.php implementation. The presence of a DetailView.php file will trigger the \"classic\" MVC view. If there is no DetailView.php (A2) file in the directory, the MVC will also check if you have defined a custom view to handle the DetailView rendering in MVC (that is, checks if there is a file modules/Opportunity/views/view.detail.php). See the documentation for the MVC architecture for more information. Finally, if neither the DetailView.php (A2) nor the view.detail.php exists, then the MVC will invoke include/DetailView/DetailView.php (A).\nThe MVC framework (see views.detail.php in include/MVC/View/views folder) creates an instance of the generic DetailView (A)\n// Call DetailView2 constructor", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/index.html"}
{"id": "02125e64959d-8", "text": "// Call DetailView2 constructor\n$dv = new DetailView2();\n// Assign by reference the Sugar_Smarty object created from MVC\n// We have to explicitly assign by reference to back support PHP 4.x\n$dv->ss =& $this->ss;\n// Call the setup function\n$dv->setup($this->module, $this->bean, $metadataFile, 'include/DetailView/DetailView.tpl');\n// Process this view\n$dv->process();\n// Return contents to the buffer\necho $dv->display();\nWhen the setup method is invoked, a TemplateHandler instance (D) is created. A check is performed to determine which detailviewdefs.php metadata file to used in creating the resulting DetailView. The first check is performed to see if a metadata file was passed in as a parameter. The second check is performed against the custom/studio/modules/[Module] directory to see if a metadata file exists. For the final option, the DetailView constructor will use the module's default detailviewdefs.php metadata file located under the modules/[Module]/metadata directory. If there is no detailviewdefs.php file in the modules/[Module]/metadata directory, but a DetailView.html exists, then a \"best guess\" version is created using the metadata parser file in include/SugarFields/Parsers/DetailViewMetaParser.php (not shown in diagram).\nThe TemplateHandler also handles creating the quick search (Ajax code to do look ahead typing) as well as generating the JavaScript validation rules for the module. Both the quick search and JavaScript code should remain static based on the definitions of the current definition of the metadata file. When fields are added or removed from the file through Studio, this template and the resulting updated quick search and JavaScript code will be rebuilt.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/index.html"}
{"id": "02125e64959d-9", "text": "It should be noted that the generic DetailView (A) defaults to using the generic DetailView.tpl smarty template file (F). This may also be overridden through the constructor parameters. The generic DetailView (A) constructor also retrieves the record according to the record id and populates the $focus bean variable.\nThe process() method is invoked on the generic DetailView.php instance:\nfunction process()\n{\n    //Format fields first\n    if($this->formatFields) \n    {\n        $this->focus->format_all_fields();\n    }\n    parent::process();\n}\nThis, in turn, calls the EditView->process() method since DetailView extends from EditView. The EditView->process() method will eventually call the EditView->render() method to calculate the width spacing for the DetailView labels and values. The number of columns and the percentage of width to allocate to each column may be defined in the metadata file. The actual values are rounded as a total percentage of 100%. For example, given the templateMeta section's maxColumns and widths values:\n'templateMeta' => array(\n    'maxColumns' => '2',\n    'widths' => array(\n        array(\n            'label' => '10', \n            'field' => '30'\n        ),\n        array(\n            'label' => '10', \n            'field' => '30'\n        )\n    ),\n),\nWe can see that the labels and fields are mapped as a 1-to-3 ratio. The sum of the widths only equals a total of 80 (10 + 30 x 2) so the actual resulting values written to the Smarty template will be at a percentage ratio of 12.5-to-37.5. The resulting fields defined in the metadata file will be rendered as a table with the column widths as defined:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/index.html"}
{"id": "02125e64959d-10", "text": "The actual metadata layout will allow for variable column lengths throughout the displayed table. For example, the metadata portion defined as:\n'panels' => array(\n    'default' => array(\n        array(\n            'name',\n            array(\n                'name' => 'amount',\n                'label' => '{$MOD.LBL_AMOUNT} ({$CURRENCY})',\n            ),\n        ),\n        array(\n            'account_name',\n        ),\n        array(\n            '',\n            'opportunity_type',\n        )\n    )\n)\nThis specifies a default panel under the panels section with three rows. The first row has two fields (name and amount). The amount field has some special formatting using the label override option. The second row contains the account_name field and the third row contains the opportunity_type column.\nNext, the process() method populates the $fieldDefs array variable with the vardefs.php file (G) definition and the $focus bean's value. This is done by calling the toArray () method on the $focus bean instance and combining these values with the field definition specified in the vardefs.php file (G).\nThe display() method is then invoked on the generic DetailView instance for the final step. When the display() method is invoked, variables to the DetailView.tpl Smarty template are assigned and the module's HTML code is sent to the output buffer.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/index.html"}
{"id": "02125e64959d-11", "text": "Before HTML code is sent back, the TemplateHandler (D) first performs a check to see if an existing DetailView template already exists in the cache respository (H). In this case, it will look for file cache/modules/Opportunity/DetailView.tpl. The operation of creating the Smarty template is expensive so this operation ensures that the work will not have to be redone. As a side note, edits made to the DetailView or EditView through the Studio application will clear the cache file and force the template to be rewritten so that the new changes are reflected.\nIf the cache file does not exist, the TemplateHandler (D) will create the template file and store it in the cache directory. When the fetch() method is invoked on the Sugar_Smarty class (E) to create the template, the DetailView.tpl file is parsed.\nTopicsExamplesLegacy MVC metadata examples.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/index.html"}
{"id": "eeb75bb5de8c-0", "text": "Examples\nLegacy MVC metadata examples.\nTopicsHiding the Quotes Module PDF ButtonsHow to hide the PDF buttons on a Quote.Manipulating Buttons on Legacy MVC LayoutsHow to add custom buttons to the EditView and DetailView layouts.Manipulating Layouts ProgrammaticallyHow to manipulate and merge layouts programmatically.Modifying Layouts to Display Additional ColumnsHow to add additional columns to layouts.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/Examples/index.html"}
{"id": "9b014ffdc085-0", "text": "Manipulating Buttons on Legacy MVC Layouts\nOverview\nHow to add custom buttons to the EditView and DetailView layouts.\nNote: This customization is only applicable for modules in backward compatibility mode.\nMetadata\nBefore adding buttons to your layouts, you will need to understand how the metadata framework is used. Detailed information on the metadata framework can be found in the Legacy Metadata section.\nCustom Layouts\nBefore you can add a button to your layout, you will first need to make sure you have a custom layout present. The stock layouts are located in ./modules/<module>/metadata/ and must be recreated in ./custom/modules/<module>/metadata/.\nThere are two ways to recreate a layout in the custom directory if it does not already exist. The first is to navigate to:\nStudio > {Module} > Layouts > {View}\nOnce there, you can click the \"Save & Deploy\" button. This will create the layoutdef for you. Alternatively, you can also manually copy the layoutdef from the stock folder to the custom folder.\nEditing Layouts\nWhen editing layouts you have three options in having your changes reflected in the UI.\nDeveloper Mode\nYou can turn on Developer Mode:\nAdmin > System Settings\nDeveloper Mode will remove the caching of the metadata framework. This will cause your changes to be reflected when the page is refreshed. Make sure this setting is deactivated when you are finished with your customization.\nQuick Repair and Rebuild\nYou can run a Quick Repair and Rebuild:\nAdmin > Repair > Quick Repair and Rebuild\nDoing this will rebuild the cache for the metadata.\nSaving & Deploying the Layout in Studio\nYou may also choose to load the layout in studio and then save & deploy it:\nAdmin > Studio > {Module} > Layouts > {View}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/Examples/Manipulating_Buttons_on_Layouts/index.html"}
{"id": "9b014ffdc085-1", "text": "Admin > Studio > {Module} > Layouts > {View}\nThis process can be a bit confusing, however, once a layout is changed, you can then choose to load the layout in studio and then click \"Save & Deploy\" . This will rebuild the cache for that specific layout. Please note that any time you change the layout, you will have to reload the Studio layout view before deploying in order for this to work correctly.\nAdding Custom Buttons\nWhen adding buttons, there are several things to consider when determining how the button should be rendered. The following sections will outline these scenarios when working with the accounts editviewdefs located in ./custom/modules/Accounts/metadata/editviewdefs.php.\nJavaScript Actions\nIf you are adding a button solely to execute JavaScript (no form submissions), you can do so by adding the button HTML to:\n$viewdefs['<Module>']['<View>']['templateMeta']['form']['buttons']\nExample\n<?php\n$viewdefs['Accounts'] =\narray (\n  'DetailView' =>\n  array (\n    'templateMeta' =>\n    array (\n      'form' =>\n      array (\n        'buttons' =>\n        array (\n          0 => 'EDIT',\n          1 => 'DUPLICATE',\n          2 => 'DELETE',\n          3 => 'FIND_DUPLICATES',\n          4 => 'CONNECTOR',\n          5 =>\n          array (\n            'customCode' => '<input id=\"JavaScriptButton\" title=\"JavaScript Button\" class=\"button\" type=\"button\" name=\"JavaScriptButton\" value=\"JavaScript Button\" onclick=\"alert(\\'Button JavaScript\\')\">',\n          ),\n        ),\n      ),\nSubmitting the Stock View Form", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/Examples/Manipulating_Buttons_on_Layouts/index.html"}
{"id": "9b014ffdc085-2", "text": "),\n        ),\n      ),\nSubmitting the Stock View Form\nIf you intend to submit the stock layout form ('formDetailView' or 'formEditView') to a new action, you can do so by adding a the button HTML with an onclick event as shown below to:\n$viewdefs['<Module>']['<View>']['templateMeta']['form']['buttons']\nExample\n<?php\n$viewdefs['Accounts'] =\narray (\n  'DetailView' =>\n  array (\n    'templateMeta' =>\n    array (\n      'form' =>\n      array (\n        'hidden' =>\n        array (\n          0 => '<input type=\"hidden\" id=\"customFormField\" name=\"customFormField\" value=\"\">',\n        ),\n        'buttons' =>\n        array (\n          0 => 'EDIT',\n          1 => 'DUPLICATE',\n          2 => 'DELETE',\n          3 => 'FIND_DUPLICATES',\n          4 => 'CONNECTOR',\n          5 =>\n          array (\n            'customCode' => '<input id=\"SubmitStockFormButton\" title=\"Submit Stock Form Button\" class=\"button\" type=\"button\" name=\"SubmitStockFormButton\" value=\"Submit Stock Form Button\" onclick=\"var _form = document.getElementById(\\'formDetailView\\'); _form.customFormField.value = \\'CustomValue\\'; _form.action.value = \\'CustomAction\\'; SUGAR.ajaxUI.submitForm(_form);\">',\n          ),\n        ),\n      ),\nYou should note in this example that there is also a 'hidden' index. This is where you should add any custom hidden inputs:\n  $viewdefs['<Module>'][\n  '<View>'][\n  'templateMeta'][\n  'form'][\n  'hidden']\nSubmitting Custom Forms", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/Examples/Manipulating_Buttons_on_Layouts/index.html"}
{"id": "9b014ffdc085-3", "text": "'templateMeta'][\n  'form'][\n  'hidden']\nSubmitting Custom Forms\nIf you intend to submit a custom form, you will first need to set 'closeFormBeforeCustomButtons' to true. This will close out the current views form and allow you to create your own.\n$viewdefs['<Module>']['<View>']['templateMeta']['form']['closeFormBeforeCustomButtons']\nNext, you will add the form and button HTML as shown below to:\n$viewdefs['<Module>']['<View>']['templateMeta']['form']['buttons']\nExample\n<?php\n$viewdefs['Accounts'] =\narray (\n  'DetailView' =>\n  array (\n    'templateMeta' =>\n    array (\n      'form' =>\n      array (\n        'closeFormBeforeCustomButtons' => true,\n        'buttons' =>\n        array (\n          0 => 'EDIT',\n          1 => 'DUPLICATE',\n          2 => 'DELETE',\n          3 => 'FIND_DUPLICATES',\n          4 => 'CONNECTOR',\n          5 =>\n          array (\n            'customCode' => '<form action=\"index.php\" method=\"POST\" name=\"CustomForm\" id=\"form\"><input type=\"hidden\" name=\"customFormField\" name=\"customFormField\" value=\"CustomValue\"><input id=\"SubmitCustomFormButton\" title=\"Submit Custom Form Button\" class=\"button\" type=\"submit\" name=\"SubmitCustomFormButton\" value=\"Submit Custom Form Button\"></form>',\n          ),\n        ),\n      ),\nRemoving Buttons\nTo remove a button from the detail view will require modifying the ./modules/<module>/metadata/detailviewdefs.php.\nThe code is originally defined as:\n$viewdefs[$module_name] = array (\n    'DetailView' => array (\n        'templateMeta' => array (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/Examples/Manipulating_Buttons_on_Layouts/index.html"}
{"id": "9b014ffdc085-4", "text": "'DetailView' => array (\n        'templateMeta' => array (\n            'form' => array (\n                'buttons' => array (\n                    'EDIT',\n                    'DUPLICATE',\n                    'DELETE',\n                    'FIND_DUPLICATES'\n                ),\n            ),\nTo remove one or more buttons, simply remove the 'buttons' attribute(s) that you do not want on the view.\n$viewdefs[$module_name] = array (\n    'DetailView' => array (\n        'templateMeta' => array (\n            'form' => array (\n                'buttons' => array (\n                    'DELETE',\n                ),\n            ),\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/Examples/Manipulating_Buttons_on_Layouts/index.html"}
{"id": "7878859e520f-0", "text": "Modifying Layouts to Display Additional Columns\nOverview\nHow to add additional columns to layouts.\nBy default, the editview, detailview, and quickcreate layouts for each module display two columns of fields. The number of columns to display can be customized on a per-module basis with the following steps.\nNote: This customization is only applicable for modules in backward compatibility mode.\nResolution\nSugarCloud\nFirst, you will want to ensure your layouts are deployed in the custom directory. If you have not previously customized your layouts via Studio, go to Admin > Studio > {Module Name} > Layouts. From there, select each layout you wish to add additional columns to and click 'Save & Deploy'. This action will create a corresponding layout file under the ./custom/modules/{Module Name}/metadata/ directory. The files will be named editviewdefs.php, detailviewdefs.php, and quickcreatedefs.php depending on the layouts deployed.\nTo access your custom files, go to Admin > Diagnostic Tool, uncheck all the boxes except for \"SugarCRM Custom directory\" and then click \"Execute Diagnostic\". This will generate an archive of your instance's custom directory to download, and you will find the layout files in the above path. Open the custom layout file, locate the 'maxColumns' value, and change it to the number of columns you would like to have on screen:\n'maxColumns' => '3',\nOnce that is updated, locate the 'widths' array to define the spacing for your new column(s). You should have a label and field entry for each column in your layout:\n'widths' => array (\n    0 => array (\n        'label' => '10',\n        'field' => '30',\n    ),\n    1 => array (\n        'label' => '10',\n        'field' => '30',\n    ),\n    2 => array (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/Examples/Modifying_Layouts_to_Display_Additional_Columns/index.html"}
{"id": "7878859e520f-1", "text": "'field' => '30',\n    ),\n    2 => array (\n        'label' => '10',\n        'field' => '30',\n    ),\n),\nAfter this is completed, you will need to create a module-loadable package to install the changes on your SugarCloud instance. More information on creating this package can be found in\u00c2\u00a0Creating an Installable Package that Creates New Fields. To upload and install the package, go to Admin > Module Loader.\nNote: Sugar Sell Essentials customers do not have the ability to upload custom file packages to Sugar using Module Loader.\nOnce the installation completes, you can navigate to Studio and add fields to your new column in the layout. For any rows that already contain two fields, the second field will automatically span the second and third column. Simply click the minus (-) icon to contract the field to one column and expose the new column space:\nAfter you have added the desired fields in Studio, click 'Save & Deploy', and you are ready to go!\nOn-Site\nFirst, you will want to ensure your layouts are deployed in the custom directory. If you have not previously customized your layouts via Studio, go to Admin > Studio > {Module Name} > Layouts. From there, select each layout you wish to add additional columns to and click 'Save & Deploy'. This action will create a corresponding layout file under the ./custom/modules/{Module Name}/metadata/ directory. The files will be named editviewdefs.php, detailviewdefs.php, and quickcreatedefs.php depending on the layouts deployed.\nNext, open the custom layout file, locate the 'maxColumns' value, and change it to the number of columns you would like to have on screen:\n'maxColumns' => '3',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/Examples/Modifying_Layouts_to_Display_Additional_Columns/index.html"}
{"id": "7878859e520f-2", "text": "'maxColumns' => '3',\nOnce that is updated, locate the 'widths' array to define the spacing for your new column(s). You should have a label and field entry for each column in your layout:\n'widths' => array (\n    0 => array (\n        'label' => '10',\n        'field' => '30',\n    ),\n    1 => array (\n        'label' => '10',\n        'field' => '30',\n    ),\n    2 => array (\n        'label' => '10',\n        'field' => '30',\n    ),\n),\nOnce this is completed, you can navigate to Studio and add fields to your new column in the layout. For any rows that already contain two fields, the second field will automatically span the second and third column. Simply click the minus (-) icon to contract the field to one column and expose the new column space:\nAfter you have added the desired fields in Studio, click 'Save & Deploy', and you are ready to go!\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/Examples/Modifying_Layouts_to_Display_Additional_Columns/index.html"}
{"id": "121ae268bdfb-0", "text": "Manipulating Layouts Programmatically\nOverview\nHow to manipulate and merge layouts programmatically.\nNote: This customization is only applicable for modules in backward compatibility mode.\nThe ParserFactory\nThe ParserFactory can be used to manipulate layouts such as editviewdefs or detailviewdefs. This is a handy when creating custom plugins and needing to merge changes into an existing layout. The following example will demonstrate how to add a button to the detail view:\n<?php\n//Instantiate the parser factory for the Accounts DetailView.\nrequire_once('modules/ModuleBuilder/parsers/ParserFactory.php');\n$parser = ParserFactory::getParser('detailview', 'Accounts');\n//Button to add\n$button = array(\n    'customCode'=>'<input type=\"button\" name=\"customButton\" value=\"Custom Button\">'\n);\n//Add button into the parsed layout\narray_push($parser->_viewdefs['templateMeta']['form']['buttons'], $button);\n//Save the layout\n$parser->handleSave(false);\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/Examples/Manipulating_Layouts_Programmatically/index.html"}
{"id": "792544b4014b-0", "text": "Hiding the Quotes Module PDF Buttons\nOverview\nHow to hide the PDF buttons on a Quote.\nThe PDF buttons on quotes are rendered differently than the standard buttons on most layouts. Since these buttons can't be removed directly from the DetailView in the detailviewdefs, the best approach is using jQuery to hide the buttons.\nNote: This customization is only applicable for the quotes module as it is in backward compatibility mode.\nHidding the PDF Buttons\nThis approach involves modifying the detailviewdefs.php in the custom/modules/Quotes/metadata directory to include a custom JavaScript file. If a custom detailviewdefs.php file doesn't exist, you will need to create it through Studio or by manually\n        coping the detailviewdefs.php from the Quotes stock module metadata directory.\nFirst, we will create a javascript file, say removePdfBtns.js, in the ./custom/modules/Quotes directory. This javascript file will contain the jQuery statements to hide the Quotes \"Download PDF\" and \"Email PDF\" buttons on the DetailView of the Quote.\n    \n./custom/modules/Quotes/removePdfBtns.js\nSUGAR.util.doWhen(\"typeof $ != 'undefined'\", function(){\n    YAHOO.util.Event.onDOMReady(function(){\n        $(\"#pdfview_button\").hide();\n        $(\"#pdfemail_button\").hide();\n    });\n});\nNext, we will modify the custom detailviewdefs.php file to contain the 'includes' array element in the templateMeta array as follows:\n./custom/modules/Quotes/metadata/detailviewdefs.php\n$viewdefs['Quotes'] = array (\n  'DetailView' =>\n  array (\n    'templateMeta' =>\n    array (\n      'form' =>\n      array (\n        'closeFormBeforeCustomButtons' => true,\n        'buttons' =>\n        array (\n          0 => 'EDIT',\n          1 => 'SHARE',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/Examples/Hidding_the_Quotes_Module_PDF_Buttons/index.html"}
{"id": "792544b4014b-1", "text": "array (\n          0 => 'EDIT',\n          1 => 'SHARE',\n          2 => 'DUPLICATE',\n          3 => 'DELETE',\n          4 =>\n          array (\n            'customCode' => '<form action=\"index.php\" method=\"POST\" name=\"Quote2Opp\" id=\"form\">\n                    <input type=\"hidden\" name=\"module\" value=\"Quotes\">\n                    <input type=\"hidden\" name=\"record\" value=\"{$fields.id.value}\">\n                    <input type=\"hidden\" name=\"user_id\" value=\"{$current_user->id}\">\n                    <input type=\"hidden\" name=\"team_id\" value=\"{$fields.team_id.value}\">\n                    <input type=\"hidden\" name=\"user_name\" value=\"{$current_user->user_name}\">\n                    <input type=\"hidden\" name=\"action\" value=\"QuoteToOpportunity\">\n                    <input type=\"hidden\" name=\"opportunity_subject\" value=\"{$fields.name.value}\">\n                    <input type=\"hidden\" name=\"opportunity_name\" value=\"{$fields.name.value}\">\n                    <input type=\"hidden\" name=\"opportunity_id\" value=\"{$fields.billing_account_id.value}\">\n                    <input type=\"hidden\" name=\"amount\" value=\"{$fields.total.value}\">\n                    <input type=\"hidden\" name=\"valid_until\" value=\"{$fields.date_quote_expected_closed.value}\">\n                    <input type=\"hidden\" name=\"currency_id\" value=\"{$fields.currency_id.value}\">\n                    <input id=\"create_opp_from_quote_button\" title=\"{$APP.LBL_QUOTE_TO_OPPORTUNITY_TITLE}\"\n                        class=\"button\" type=\"submit\" name=\"opp_to_quote_button\"\n                        value=\"{$APP.LBL_QUOTE_TO_OPPORTUNITY_LABEL}\" {$DISABLE_CONVERT}></form>',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/Examples/Hidding_the_Quotes_Module_PDF_Buttons/index.html"}
{"id": "792544b4014b-2", "text": "),\n        ),\n        'footerTpl' => 'modules/Quotes/tpls/DetailViewFooter.tpl',\n      ),\n      'maxColumns' => '2',\n      'widths' =>\n      array (\n        0 =>\n        array (\n          'label' => '10',\n          'field' => '30',\n        ),\n        1 =>\n        array (\n          'label' => '10',\n          'field' => '30',\n        ),\n      ),\n      'includes' =>\n      array (\n        0 =>\n        array (\n          'file' => 'custom/modules/Quotes/removePdfBtns.js',\n        ),\n      ),\n      'useTabs' => false,\n      'tabDefs' =>\n      array (\n        'LBL_QUOTE_INFORMATION' =>\n        array (\n          'newTab' => false,\n          'panelDefault' => 'expanded',\n        ),\n        'LBL_PANEL_ASSIGNMENT' =>\n        array (\n          'newTab' => false,\n          'panelDefault' => 'expanded',\n        ),\n      ),\n    ),\n    ...\nFinally, navigate to: Admin > Repair > Quick Repair and Rebuild\nThe buttons will then be removed from the DetailView layouts.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Legacy_MVC/Metadata/Examples/Hidding_the_Quotes_Module_PDF_Buttons/index.html"}
{"id": "d50cf2fe841d-0", "text": "Events\nOverview\nThe Backbone events module is a lightweight pub-sub pattern that gets mixed into each Backbone class (Model, View, Collection, Router, etc.). This means that you can listen to or dispatch custom named events from any Backbone object.\nBackbone events should not be confused with a\u00c2\u00a0jQuery events, which are used for working with DOM events in an API. Backbone supports an events hash on views that can be used to attach event handlers to DOM using jQuery. These are not Backbone events. This can be confusing because, among other similarities, both interfaces include an on() function\u00c2\u00a0and allow you to attach an event handler. The targets for jQuery events are DOM elements. The target for Backbone events are Backbone objects.\nSidecar classes extend these base Backbone classes. So each Sidecar object (Layouts, Views, Fields, Beans, Contexts, etc.) supports Backbone\u00c2\u00a0events.\nExisting Backbone Event Catalog\nThe current catalog of Backbone events\u00c2\u00a0is supported and triggered by the Sugar application. For example, we can listen to built-in Backbone router events, such as the route event, that is triggered by Sidecar. Try running the following JavaScript code from your browser's console:\nSUGAR.App.router.on('route', function(arguments) {\n    console.log(arguments);\n});\nAs you click through the Sugar application, each time the router is called, you will see routing events appear in your browser console.\nSidecar Events\nGlobal Application Events\nApplication events are all triggered on the\u00c2\u00a0app.events (SUGAR.App.events) object. Below is a list of application events with a description of when you can expect them to fire. However, please note that these events can be triggered in more than one place\u00c2\u00a0and some events, such as app:sync:error, can trigger events such as\u00c2\u00a0app:logout.\nName\nDescription\napp:init", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Events/index.html"}
{"id": "d50cf2fe841d-1", "text": "Name\nDescription\napp:init\nTriggered after the Sidecar application initializesNote: Initialization registers events, builds out Sidecar API objects, loads public metadata and config, and initializes modules.\napp:start\nTriggered after the Sidecar application starts\napp:sync\nTriggered when metadata is being synced with the user interface,\u00c2\u00a0for example, after login has occurred\napp:sync:complete\nTriggered after metadata has completely synced\napp:sync:error\nTriggered when metadata sync fails\napp:sync:public:error\nTriggered when public metadata sync fails during initialization\napp:view:change\nTriggered when a new view is loaded\napp:locale:change\nTriggered when the locale changes\nlang:direction:change\nTriggered when the locale changes and the direction of the language is different\napp:login\nTriggered when the \"Login\" route is called\napp:login:success\nTriggered after a successful login\napp:logout\nTriggered when the application is logging out\napp:logout:success\nTriggered after a successful logout\nBean Events\nThe following table lists bean object events.\nName\nDescription\nacl:change\nTriggered when the ACLs change for that module\nacl:change:<fieldName>\nTriggered when the ACLs change for a particular field in that module\nvalidation:success\nTriggered when bean validation is valid\nvalidation:complete\nTriggered when bean validation completes\nerror:validation\nTriggered when bean validation has an error\nerror:validation:<fieldName>\nTriggered when a particular field has a bean validation error\nattributes:revert\nTriggered when the bean reverts to the previous attributes\nContext Events", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Events/index.html"}
{"id": "d50cf2fe841d-2", "text": "attributes:revert\nTriggered when the bean reverts to the previous attributes\nContext Events\nThe context object is used to facilitate communication between different Sidecar components on the page using events. For example, the button:save_button:click event triggers whenever a user clicks the Save button. The record view uses this event to run Save routines without being tightly coupled to a particular Save button. A list of these contextual events is not plausible because the user interface is continuously changing between versions, and there are many more possibilities based on the views and layouts in each version.\nUtilizing Events\nApplication events can be bound to in any custom JavaScript controller or any JavaScript file loaded into Sugar and included on the page (such as via JSGroupings framework). An example below shows how one could add custom JavaScript code to trigger after the application log out.\n./custom/include/javascript/myAppLogoutSuccessEvent.js\n(function(app){\n    app.events.on('app:logout:success', function(data) {\n        //Add Logic Here\n        console.log(data);\n    });\n})(SUGAR.App);\nWith the custom event JavaScript file written and in place, include it into the system using the JSGroupings extension.\n./custom/Extension/application/Ext/JSGroupings/myAppLogoutSuccessEvent.php\nforeach ($js_groupings as $key => $groupings) {\n    foreach  ($groupings as $file => $target) {\n    \t//if the target grouping is found\n        if ($target == 'include/javascript/sugar_grp7.min.js') {\n            //append the custom JavaScript file\n            $js_groupings[$key]['custom/include/javascript/myAppLogoutSuccessEvent.js'] = 'include/javascript/sugar_grp7.min.js';\n        }\n        break;\n    }\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Events/index.html"}
{"id": "d50cf2fe841d-3", "text": "}\n        break;\n    }\n}\nOnce in place, navigate to Admin > Repair > Rebuild JS Grouping Files. After the JSGroupings are rebuilt, clear your browser cache and the custom JavaScript will now trigger after a successful logout.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Events/index.html"}
{"id": "9bd7b857ec71-0", "text": "Alerts\nOverview\nThe alert view widget, located in ./clients/base/views/alert/, displays helpful information such as loading messages, notices, and confirmation messages to the user.\nMethods\napp.alert.show(id, options)\nThe app.alert.show(id, options) method displays an alert message to the user with the options provided.\nParameters\nName\nDescription\nid\nThe id of the alert message. Used for dismissing specific messages.\noptions.level\nThe alert level\noptions.title\nThe alert's title, which corresponds to the alert's level\noptions.messages\nThe message that the user sees Note: Process alerts do not display messages.\noptions.autoClose\nWhether or not to auto-close the alert popup\noptions.onClose\nCallback handler for closing confirmation alerts\noptions.onCancel\nCallback handler for canceling confirmation alerts\noptions.onLinkClick\nCallback handler for click actions on a link inside of the alert\nDefault Alert Values\nAlert Level\nAlert Appearance\nAlert Title\ninfo\nblue\n\"Notice\"\nsuccess\ngreen\n\"Success\"\nwarning\nyellow\n\"Warning!\"\nerror\nred\n\"Error\"\nprocess\nloading message\n\"Loading...\"\nconfirmation\nconfirmation dialog\n\"Warning\"\nAlert Examples\nStandard Alert\napp.alert.show('message-id', {\n    level: 'success',\n    messages: 'Task completed!',\n    autoClose: true\n});\nConfirmation Alert\napp.alert.show('message-id', {\n    level: 'confirmation',\n    messages: 'Confirm?',\n    autoClose: false,\n    onConfirm: function(){\n         alert(\"Confirmed!\");\n    },\n    onCancel: function(){\n        alert(\"Cancelled!\");\n    }\n});\nProcess Alert\napp.alert.show('message-id', {\n    level: 'process',\n    title: 'In Process...' //change title to modify display from 'Loading...'\n});\napp.alert.dismiss(id)", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Alerts/index.html"}
{"id": "9bd7b857ec71-1", "text": "});\napp.alert.dismiss(id)\nThe app.alert.dismiss(id) method dismisses an alert message from view based on the message id.\nParameters\nName\nDescription\nid\nThe id of the alert message to dismiss.\nExample\napp.alert.dismiss('message-id');\napp.alert.dismissAll\nThe app.alert.dismissAll dismisses all alert messages from view.\nExample\napp.alert.dismissAll();\nTesting in Console\nTo test alerts, you can trigger them in your browser's developer tools by using the global App variable as shown below:\nApp.alert.show('message-id', {\n    level: 'success',\n    messages: 'Successful!',\n    autoClose: false\n});\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Alerts/index.html"}
{"id": "07a7367e4dd7-0", "text": "Administration Links\nOverview\nAdministration links are the shortcut URLs found\u00c2\u00a0on\u00c2\u00a0the Administration\u00c2\u00a0page\u00c2\u00a0in the Sugar application. Developers can create additional administration links\u00c2\u00a0using the extension framework.\nThe global links extension directory is located at ./custom/Extension/modules/Administration/Ext/Administration/.\u00c2\u00a0After a Quick Repair and Rebuild, the PHP files in this directory\u00c2\u00a0are\u00c2\u00a0compiled into ./custom/modules/Administration/Ext/Administration/administration.ext.php. Additional information on this can be found in the extensions Administration section of the Extension Framework documentation. The current links defined in the administration section can be found in ./modules/Administration/metadata/adminpaneldefs.php.\nExample\nThe following example will create a new panel on the Admin page:\n./custom/Extension/modules/Administration/Ext/Administration/<file>.php\n<?php\n    $admin_option_defs = array();\n    $admin_option_defs['Administration']['<section key>'] = array(\n        //Icon name. Available icons are located in ./themes/default/images\n        'Administration',\n        \n        //Link name label \n        'LBL_LINK_NAME',\n        \n        //Link description label\n        'LBL_LINK_DESCRIPTION',\n        \n        //Link URL - For Sidecar modules\n        'javascript:void(parent.SUGAR.App.router.navigate(\"<module>/<path>\", {trigger: true}));',\n        \n        //Alternatively, if you are linking to BWC modules\n        //'./index.php?module=<module>&action=<action>',\n    );\n    $admin_group_header[] = array(\n        //Section header label\n        'LBL_SECTION_HEADER',\n        \n        //$other_text parameter for get_form_header()\n        '',\n        \n        //$show_help parameter for get_form_header()\n        false,\n        \n        //Section links\n        $admin_option_defs,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Administration_Links/index.html"}
{"id": "07a7367e4dd7-1", "text": "//Section links\n        $admin_option_defs, \n        \n        //Section description label\n        'LBL_SECTION_DESCRIPTION'\n    );\nTo define labels for administration links in the new panel:\n./custom/Extension/modules/Administration/Ext/Language/en_us.<name>.php\n<?php\n    $mod_strings['LBL_LINK_NAME'] = 'Link Name';\n    $mod_strings['LBL_LINK_DESCRIPTION'] = 'Link Description';\n    $mod_strings['LBL_SECTION_HEADER'] = 'Section Header';\n    $mod_strings['LBL_SECTION_DESCRIPTION'] = 'Section Description';\nFinally, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and the panel will appear on the Admin page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Administration_Links/index.html"}
{"id": "d9df790905a1-0", "text": "Dashlets\nOverview\nDashlets are special view-component plugins that render data from a context and make use of the Dashlet plugin. They are typically made up of a controller JavaScript file (.js) and at least one Handlebars template (.hbs).\nHierarchy Diagram\nSugar loads the dashlet view components in the following manner:\nNote: The Sugar application's client type is \"base\". For more information on the various client types, please refer to\u00c2\u00a0the User Interface page.\nDashlet Views\nThe are three views when working with dashlets: Preview, Dashlet View, and Configuration View. The following sections discuss the differences between views.\nPreview\nThe preview view is used when selecting dashlets to add to your homepage. Preview variables in the metadata will be assigned to the custom model variables.\n'preview' => array(\n    'key1' => 'value1',\n),\nThe values in the preview metadata can be retrieved using:\nthis.model.get(\"key1\");\nDashlet View\nThe dashlet view will render the content for the dashlet. It will also contain the settings for editing, removing, and refreshing the dashlet.\nConfiguration View\nThe configuration view is displayed when a user clicks the 'edit' option on the dashlet frame's drop-down menu. Config variables in the metadata will be assigned to the custom model variables\n'config' => array(\n    //key value pairs of attributes\n    'key1' => 'value1',\n),\nThe values in the config metadata can be retrieved using:\nthis.model.get(\"key1\");\nDashlet Example\nThe RSS\u00c2\u00a0feed\u00c2\u00a0dashlet, located in ./clients/base/views/rssfeed/, handles the display of RSS\u00c2\u00a0feeds to the user. The sections below outline the various files that render this dashlet.\nMetadata\nThe Dashlet view contains the 'dashlets' metadata:\nParameters\nType\nRequired", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Dashlets/index.html"}
{"id": "d9df790905a1-1", "text": "The Dashlet view contains the 'dashlets' metadata:\nParameters\nType\nRequired\nDescription\nlabel\nString\nyes\nThe name of the dashlet\ndescription\nString\nno\nA description of the dashlet\nconfig\nObject\nyes\nPre-populated variables in the configuration viewNote:\u00c2\u00a0Config variables in the metadata are\u00c2\u00a0assigned to the custom model variables.\npreview\nObject\nyes\u00c2\u00a0\nPre-populated variables in the preview\nfilter\nObject\nno\nFilter for display\nThe\u00c2\u00a0RSS feed\u00c2\u00a0dashlets metadata is located in:\n./clients/base/views/rssfeed/rssfeed.php\n<?php\n/*\n * Your installation or use of this SugarCRM file is subject to the applicable\n * terms available at\n * http://support.sugarcrm.com/Resources/Master_Subscription_Agreements/.\n * If you do not agree to all of the applicable terms or do not have the\n * authority to bind the entity as an authorized representative, then do not\n * install or use this SugarCRM file.\n *\n * Copyright (C) SugarCRM Inc. All rights reserved.\n */\n$viewdefs['base']['view']['rssfeed'] = array(\n    'dashlets' => array(\n        array(\n            'label' => 'LBL_RSS_FEED_DASHLET',\n            'description' => 'LBL_RSS_FEED_DASHLET_DESCRIPTION',\n            'config' => array(\n                'limit' => 5,\n                'auto_refresh' => 0,\n            ),\n            'preview' => array(\n                'limit' => 5,\n                'auto_refresh' => 0,\n                'feed_url' => 'http://blog.sugarcrm.com/feed/',\n            ),\n        ),\n    ),\n    'panels' => array(\n        array(\n            'name' => 'panel_body',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Dashlets/index.html"}
{"id": "d9df790905a1-2", "text": "array(\n            'name' => 'panel_body',\n            'columns' => 2,\n            'labelsOnTop' => true,\n            'placeholders' => true,\n            'fields' => array(\n                array(\n                    'name' => 'feed_url',\n                    'label' => 'LBL_RSS_FEED_URL',\n                    'type' => 'text',\n                    'span' => 12,\n                    'required' => true,\n                ),\n                array(\n                    'name' => 'limit',\n                    'label' => 'LBL_RSS_FEED_ENTRIES_COUNT',\n                    'type' => 'enum',\n                    'options' => 'tasks_limit_options',\n                ),\n                array(\n                    'name' => 'auto_refresh',\n                    'label' => 'LBL_DASHLET_REFRESH_LABEL',\n                    'type' => 'enum',\n                    'options' => 'sugar7_dashlet_reports_auto_refresh_options',\n                ),\n            ),\n        ),\n    ),\n);\nController\nThe rssfeed.js controller file, shown below, contains the JavaScript to render the news articles on the dashlet. The Dashlet view must include 'Dashlet' plugin and can override initDashlet to add additional custom process while it is initializing.\n./clients/base/views/rssfeed/rssfeed.js\n/*\n * Your installation or use of this SugarCRM file is subject to the applicable\n * terms available at\n * http://support.sugarcrm.com/Resources/Master_Subscription_Agreements/.\n * If you do not agree to all of the applicable terms or do not have the\n * authority to bind the entity as an authorized representative, then do not\n * install or use this SugarCRM file.\n *\n * Copyright (C) SugarCRM Inc. All rights reserved.\n */\n/**", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Dashlets/index.html"}
{"id": "d9df790905a1-3", "text": "*\n * Copyright (C) SugarCRM Inc. All rights reserved.\n */\n/**\n * RSS Feed dashlet consumes an RSS Feed URL and displays it's content as a list\n * of entries.\n * \n * The following items are configurable.\n *\n * - {number} limit Limit imposed to the number of records pulled.\n * - {number} refresh How often (minutes) should refresh the data collection.\n *\n * @class View.Views.Base.RssfeedView\n * @alias SUGAR.App.view.views.BaseRssfeedView\n * @extends View.View\n */\n({\n    plugins: ['Dashlet'],\n    /**\n     * Default options used when none are supplied through metadata.\n     *\n     * Supported options:\n     * - timer: How often (minutes) should refresh the data collection.\n     * - limit: Limit imposed to the number of records pulled.\n     *\n     * @property {Object}\n     * @protected\n     */\n    _defaultOptions: {\n        limit: 5,\n        auto_refresh: 0\n    },\n    /**\n     * @inheritdoc\n     */\n    initialize: function(options) {\n        options.meta = options.meta || {};\n        this._super('initialize', [options]);\n        this.loadData(options.meta);\n    },\n    /**\n     * Init dashlet settings\n     */\n    initDashlet: function() {\n        // We only need to handle this if we are NOT in the configure screen\n        if (!this.meta.config) {\n            var options = {};\n            var self = this;\n            var refreshRate;\n            // Get and set values for limits and refresh\n            options.limit = this.settings.get('limit') || this._defaultOptions.limit;\n            this.settings.set('limit', options.limit);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Dashlets/index.html"}
{"id": "d9df790905a1-4", "text": "this.settings.set('limit', options.limit);\n            options.auto_refresh = this.settings.get('auto_refresh') || this._defaultOptions.auto_refresh;\n            this.settings.set('auto_refresh', options.auto_refresh);\n            // There is no default for this so there's no pointing in setting from it\n            options.feed_url = this.settings.get('feed_url');\n            // Set the refresh rate for setInterval so it can be checked ahead\n            // of time. 60000 is 1000 miliseconds times 60 seconds in a minute.\n            refreshRate = options.auto_refresh * 60000;\n            // Only set up the interval handler if there is a refreshRate higher\n            // than 0\n            if (refreshRate > 0) {\n                if (this.timerId) {\n                    clearInterval(this.timerId);\n                }\n                this.timerId = setInterval(_.bind(function() {\n                    if (self.context) {\n                        self.context.resetLoadFlag();\n                        self.loadData(options);\n                    }\n                }, this), refreshRate);\n            }\n        }\n        // Validation handling for individual fields on the config\n        this.layout.before('dashletconfig:save', function() {\n            // Fields on the metadata\n            var fields = _.flatten(_.pluck(this.meta.panels, 'fields'));\n            // Grab all non-valid fields from the model\n            var notValid = _.filter(fields, function(field) {\n                return field.required && !this.dashModel.get(field.name);\n            }, this);\n            // If there no invalid fields we are good to go\n            if (notValid.length === 0) {\n                return true;\n            }\n            // Otherwise handle notification of invalidation\n            _.each(notValid, function(field) {\n                 var fieldOnView = _.find(this.fields, function(comp, cid) {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Dashlets/index.html"}
{"id": "d9df790905a1-5", "text": "var fieldOnView = _.find(this.fields, function(comp, cid) { \n                    return comp.name === field.name;\n                 });\n                 fieldOnView.model.trigger('error:validation:' + field.name, {required: true});\n            }, this);\n            // False return tells the drawer that it shouldn't close\n            return false;\n        }, this);\n    },\n    /**\n     * Handles the response of the feed consumption request and sets data from \n     * the result\n     * \n     * @param {Object} data Response from the rssfeed API call\n     */\n    handleFeed: function (data) {\n        if (this.disposed) {\n            return;\n        }\n        // Load up the template\n        _.extend(this, data);\n        this.render();\n    },\n    /**\n     * Loads an RSS feed from the RSS Feed endpoint.\n     * \n     * @param {Object} options The metadata that drives this request\n     */\n    loadData: function(options) {\n        if (options && options.feed_url) {\n            var callbacks = {success: _.bind(this.handleFeed, this), error: _.bind(this.handleFeed, this)},\n                limit = options.limit || this._defaultOptions.limit,\n                params = {feed_url: options.feed_url, limit: limit},\n                apiUrl = app.api.buildURL('rssfeed', 'read', '', params);\n            app.api.call('read', apiUrl, {}, callbacks);\n        }\n    },\n    /**\n     * @inheritdoc\n     *\n     * New model related properties are injected into each model:\n     *\n     * - {Boolean} overdue True if record is prior to now.\n     */\n    _renderHtml: function() {\n        if (this.meta.config) {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Dashlets/index.html"}
{"id": "d9df790905a1-6", "text": "_renderHtml: function() {\n        if (this.meta.config) {\n            this._super('_renderHtml');\n            return;\n        }\n        this._super('_renderHtml');\n    }\n})\nWorkflow\nWhen triggered, the following procedure will render the view area:\nRetrieving Data\nUse the following commands to retrieve the corresponding data:\nData Location\nElement\nCommand\nMain pane\nRecord View\nthis.model\nRecord View\nthis.context.parent.get(\"model\")\nList View\nthis.context.parent.get(\"collection\")\nMetadata\n\u00c2\u00a0\nthis.dashletConfig['metadata_key']\nModule vardefs\n\u00c2\u00a0\napp.metadata.getModule(\"ModuleName\")\nRemote data\nBean\nnew app.data.createBean(\"Module\")new app.data.createBeanCollection(\"Module\")\nRestAPI\u00c2\u00a0\napp.api.call(method, url, data, callbacks, options)\nAjax Call\u00c2\u00a0\n$.ajax()\nUser inputs\n\u00c2\u00a0\nthis.settings.get(\"custom_key\")\nHandlebar Template\nThe rssfeed.hbs template file defines the content of the view. This view is used for rendering the markup rendering in the dashlet content.\n./clients/base/views/rssfeed/rssfeed.hbs\n{{!--\n/*\n * Your installation or use of this SugarCRM file is subject to the applicable\n * terms available at\n * http://support.sugarcrm.com/Resources/Master_Subscription_Agreements/.\n * If you do not agree to all of the applicable terms or do not have the\n * authority to bind the entity as an authorized representative, then do not\n * install or use this SugarCRM file.\n *\n * Copyright (C) SugarCRM Inc. All rights reserved.\n */\n--}}\n{{#if feed}}\n    <div class=\"rss-feed\">\n        <h4>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Dashlets/index.html"}
{"id": "d9df790905a1-7", "text": "<div class=\"rss-feed\">\n        <h4>\n            {{#if feed.link}}<a href=\"{{feed.link}}\">{{/if}}\n            {{feed.title}}\n            {{#if feed.link}}</a>{{/if}}\n        </h4>\n        <ul>\n        {{#each feed.entries}}\n            <li class=\"news-article\">\n                <a href=\"{{link}}\">Dashlets</a>\n                {{#if author}} - {{str \"LBL_RSS_FEED_AUTHOR\"}} {{author}}{{/if}}\n            </li>\n        {{/each}}\n        </ul>\n    </div>\n{{else}}\n    <div class=\"block-footer\">\n        {{#if errorThrown}}\n        {{str \"LBL_NO_DATA_AVAILABLE\"}}\n        {{else}}\n        {{loading 'LBL_ALERT_TITLE_LOADING'}}\n        {{/if}}\n    </div>\n{{/if}} \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Dashlets/index.html"}
{"id": "2ee769f6e3c0-0", "text": "Sidecar\nOverview\nSidecar is a platform that moves processing to the client side to render pages as single-page web apps. Sidecar contains a complete Model-View-Controller (MVC) framework based on the Backbone.js library.\nBy creating a single-page web app, server load drastically decreases while\u00c2\u00a0the client's performance increases because the application is sending pure JSON data in place of HTML. The JSON data, returned by the v10 API, defines the application's modules, records, and ACLs, allowing UI processing to happen on the client side and significantly reducing the amount of data to transfer.\u00c2\u00a0\n\u00c2\u00a0\nComposition\nSidecar contains\u00c2\u00a0the following parts, which are briefly explained in the sections below:\nBackbone.js\nComponents (Layouts,\u00c2\u00a0Views, and Fields)\nContext\nBackbone.js\nBackbone.js is a lightweight JavaScript framework based on MVP (model\u00e2\u0080\u0093view\u00e2\u0080\u0093presenter) application design. It allows developers to easily interact with a RESTful JSON API to fetch models and collections for use within their user interface.\nFor more information about Backbone.js, please refer to their documentation at\u00c2\u00a0Backbone.js.\nComponents\nEverything that is renderable on the page is a component. A layout is a component that serves as a canvas for one or more views and other layouts. All pages will have at least one master layout, and that master layout can contain multiple nested layouts.\nLayouts\nLayouts are components that render the overall page. They define the rows, columns, and fluid layouts of content that gets delivered to the end user.\nExample layouts include:\nRows\nColumns\nBootstrap fluid layouts\nDrawers and dropdowns\nFor more information about the various layouts, please refer to the Layouts page of this documentation.\nViews", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Sidecar/index.html"}
{"id": "2ee769f6e3c0-1", "text": "Views\nViews are components that render data from a context and may or may not include field components. Example views include not only record and list views but also widgets such as:\nGraphs or other data visualizations\nExternal data views such as Twitter, LinkedIn, or other web service integrations\nThe global header\nFor more information about views, please refer to\u00c2\u00a0the Views page\u00c2\u00a0of this documentation.\nFields\nFields render widgets for individual values that have been pulled from the models and also handle formatting (or stripping the formatting of) field values. Like layouts and views, fields extend Backbone views.\u00c2\u00a0\nFor more information about the various layouts, please refer to\u00c2\u00a0the Fields page of this documentation.\nContext\nA Context is a container for the relevant data for a page, and it has three major attributes:\nModule : The name of the module this context is based on\nModel : The primary or selected model for this context\nCollection : The set of models currently loaded in this context\nContexts are used to retrieve related data and to paginate through lists of data.\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Sidecar/index.html"}
{"id": "2bfef099996c-0", "text": "Routes\nOverview\nRoutes determine where users are directed\u00c2\u00a0based on patterns in the URL.\nRoutes\nRoutes, defined in ./include/javascript/sugar7.js, are URL\u00c2\u00a0patterns signified by a\u00c2\u00a0hashtag (\"#\") in the\u00c2\u00a0URL.\u00c2\u00a0An example module\u00c2\u00a0URL pattern for the Sugar application is\u00c2\u00a0http://{site url}/#<module>.\u00c2\u00a0This route would\u00c2\u00a0direct a user to the list view for a given module. The following sections will outline routes and how they are defined.\nRoute Definitions\nThe router accepts route definitions in the following format:\nroutes = [\n    {\n        name: \"My First Route\",\n        route: \"pattern/to/match\",\n        callback: function()\n        {\n            //handling logic here.\n        }\n    },\n    {\n        name: \"My Second Route\",\n        route: \"pattern/:variable\",\n        callback: \"<callback name>\"\n    }\n]\nA route takes in three properties: the name of the route, the route pattern to match, and the callback to be called when the route is matched. If a default callback is desired, you can specify the callback name as a string.\nRoute Patterns\nRoute patterns determine where to direct the user. An example of routing is done when navigating to an account record. When doing this you may notice that your URL is:\nhttp://{site url}/#Accounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\nA stock\u00c2\u00a0route's definition is defined in ./include/javascript/sugar7.js as:\n{\n    name: \"record\",\n    route: \":module/:id\"\n},\nVariables in the route pattern are\u00c2\u00a0prefixed with a colon such as\u00c2\u00a0:variable. The route pattern above contains two variables:\nmodule\nid\nCustom Routes", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Routes/index.html"}
{"id": "2bfef099996c-1", "text": "module\nid\nCustom Routes\nAs of 7.8.x, you can add the routes during the initialization of the Router, so custom routes can be registered in the Sidecar router during both router:init and\u00c2\u00a0router:start\u00c2\u00a0events. It\u00c2\u00a0is recommended to register them in the Initialization event\u00c2\u00a0before any routing has occurred. There are two methods in the Sidecar Router, which allow for adding custom routes:\nroute()\nArguments\nName\nRequired\nType\nDescription\nroute\ntrue\nstring\nThe Route pattern to be matched by the URL Fragment\nname\ntrue\nstring\u00c2\u00a0\nThe unique name of the Route\ncallback\ntrue\nfunction\u00c2\u00a0\nThe callback function for the Route\nExample\nThe following example registers a custom Route during the router:init event, using the route() method.\n./custom/javascript/customRoutes.js\n(function(app){\n    app.events.on(\"router:init\", function(){\n      //Register the route #test/123\n      app.router.route(\"test/:id\", \"test123\", function() {\n          console.log(arguments);\n          app.controller.loadView({\n              layout: \"custom_layout\",\n              create: true\n          });\n      });\n    })\n})(SUGAR.App);\naddRoutes()", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Routes/index.html"}
{"id": "2bfef099996c-2", "text": "});\n      });\n    })\n})(SUGAR.App);\naddRoutes()\nWhen you need to add multiple routes, you can define the routes in an array and pass the entire array to the addRoutes() method on the Sidecar Router to ensure they are registered. Please note, the addRoutes() method utilizes the above route() method to register the routes with the Backbone Router. The Backbone router redirects\u00c2\u00a0after the first matching route. Due to this, the order in which the routes are listed in the array is important\u00c2\u00a0as it will determine which route will\u00c2\u00a0be used by the application. It is recommended that the most specific routes be listed first in the array so that they are recognized first, instead of those routes which may contain a variable.\nArguments\nName\nRequired\nType\nDescription\nroutes\ntrue\narray\nAn array of route definition as defined above.\nExample\nThe following example registers custom Route during the router:init event, using the addRoutes() method.\nThe\u00c2\u00a0route's JavaScript controller can exist anywhere you'd like. For our purposes, we created it in\u00c2\u00a0./custom/javascript/customRoutes.js. This file will contain your custom route definitions.\n./custom/javascript/customRoutes.js\n(function(app){\n    app.events.on(\"router:init\", function(){\n        var routes = [\n    \t    {\n                route: 'test/doSomething',\n                name: 'testDoSomething',\n                callback: function(){\n             \t    alert(\"Doing something...\");\n                }\n            },\n            {\n                route: 'test/:id',\n                name: 'test123',\n                callback: function(){\n             \t    console.log(arguments);\n                    app.controller.loadView({\n                        layout: \"custom_layout\",\n                        create: true\n                    });\n                }\n            }\n        ];\n        app.router.addRoutes(routes);\n    })", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Routes/index.html"}
{"id": "2bfef099996c-3", "text": "}\n            }\n        ];\n        app.router.addRoutes(routes);\n    })\n})(SUGAR.App);\nNext, create the JSGrouping extension. This file will allow Sugar to recognize that you've added custom routes.\u00c2\u00a0\n./custom/Extension/application/Ext/JSGroupings/myCustomRoutes.php\n<?php\nforeach ($js_groupings as $key => $groupings) {\n\u00c2\u00a0\u00c2\u00a0\u00c2\u00a0 $target = current(array_values($groupings));\n\u00c2\u00a0\u00c2\u00a0\u00c2\u00a0 //if the target grouping is found\n\u00c2\u00a0\u00c2\u00a0\u00c2\u00a0 if ($target == 'include/javascript/sugar_grp7.min.js') {\n\u00c2\u00a0\u00c2\u00a0\u00c2\u00a0\u00c2\u00a0\u00c2\u00a0\u00c2\u00a0\u00c2\u00a0 //append the custom JavaScript file\n\u00c2\u00a0\u00c2\u00a0\u00c2\u00a0\u00c2\u00a0\u00c2\u00a0\u00c2\u00a0\u00c2\u00a0 $js_groupings[$key]['custom/javascript/customRoutes.js'] = 'include/javascript/sugar_grp7.min.js';\n\u00c2\u00a0\u00c2\u00a0\u00c2\u00a0 }\n}\nOnce your files are in place, navigate to Admin > Repairs > Quick Repair & Rebuild. For additional information, please refer to the\u00c2\u00a0JSGroupings\u00c2\u00a0framework.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Routes/index.html"}
{"id": "bedb57e1e5c8-0", "text": "Handlebars\nOverview\nThe Handlebars library, located in ./sidecar/lib/handlebars/, is a JavaScript library that lets Sugar create\u00c2\u00a0semantic templates. Handlebars help render content for layouts, views, and fields for Sidecar. Using Handlebars, you can make modifications to the display of content such as adding HTML or CSS.\u00c2\u00a0\u00c2\u00a0\nFor more information on the Handlebars library, please refer to their website at\u00c2\u00a0http://handlebarsjs.com.\u00c2\u00a0\nTemplates\nThe Handlebars templates are stored in the filesystem as .hbs files. These files are stored along with the view, layout, and field metadata and are loaded according to the inheritance\u00c2\u00a0you have selected in your controller. To view the list of available templates, or to see if a custom-created template is available, you can open your browser's console window and inspect the Handlebars.templates namespace.\nDebugging Templates\nWhen working with Handlebar templates, it can be difficult to identify where an issue is occurring or what a variable contains. To assist with troubleshooting this, you can use the log helper. The log helper will output the contents of this and the variable passed to it in your browser's console.\nThis is an example of using the logger in a\u00c2\u00a0handlebars template:\n{{log this}}\nHelpers\nHandlebar Helpers are a way of adding custom functionality to the templates. Helpers are located in the following places:\n./sidecar/src/view/hbs-helpers.js\u00c2\u00a0: Sidecar uses these helpers by default\n./include/javascript/sugar7/hbs-helpers.js\u00c2\u00a0:\u00c2\u00a0Additional helpers used by the base client\nCreating Helpers\nWhen working with Handlebar templates, you may need to create your helper. To do this, follow these steps:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Handlebars/index.html"}
{"id": "bedb57e1e5c8-1", "text": "Create a\u00c2\u00a0Handlebars helper file in the\u00c2\u00a0./custom/ directory. For this example, we will create two functions to convert a string to uppercase or lowercase:\n./custom/JavaScript/my-handlebar-helpers.js\u00c2\u00a0\n/**\n * Handlebars helpers.\n *\n * These functions are to be used in handlebars templates.\n * @class Handlebars.helpers\n * @singleton\n */\n(function(app) {\n    app.events.on(\"app:init\", function() {\n        /**\n         * convert a string to upper case\n         */\n        Handlebars.registerHelper(\"customUpperCase\", function (text)\n        {\n            return text.toUpperCase();\n        });\n        /**\n         * convert a string to lower case\n         */\n        Handlebars.registerHelper(\"customLowerCase\", function (text)\n        {\n            return text.toLowerCase();\n        });\n    });\n})(SUGAR.App);\nNext, create a\u00c2\u00a0JSGrouping extension in ./custom/Extension/application/Ext/JSGroupings/.\u00c2\u00a0Name the file uniquely for your customization. For this example,\u00c2\u00a0we will create:\n\u00c2\u00a0./custom/Extension/application/Ext/JSGroupings/my-handlebar-helpers.php\n<?php\n//Loop through the groupings to find include/javascript/sugar_grp7.min.js\nforeach($js_groupings as $key => $groupings) {\n    foreach($groupings as $file => $target) {\n        if ($target == 'include/javascript/sugar_grp7.min.js') {\n            //append the custom helper file\n            $js_groupings[$key]['custom/JavaScript/my-handlebar-helpers.js'] = 'include/javascript/sugar_grp7.min.js';\n        }\n        break;\n    }\n}\nFinally, navigate to Admin > Repair and perform the following two repair sequences to include the changes:\nQuick Repair and Rebuild", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Handlebars/index.html"}
{"id": "bedb57e1e5c8-2", "text": "Quick Repair and Rebuild\nRebuild JS Groupings.\nYou can now\u00c2\u00a0use your custom helpers in the HBS\u00c2\u00a0files by using:\n{{customUpperCase \"MyString\"}} \n{{customLowerCase \"MyString\"}}\nNote: You can also access the helpers function from your browsers developer console using\u00c2\u00a0Handlebars.helpers\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Handlebars/index.html"}
{"id": "990e16c02ed2-0", "text": "Views\nOverview\nViews are component plugins that render data from a context. View components may contain field components and are typically made up of a controller JavaScript file (.js) and at least one Handlebars template (.hbs).\nLoad Order Hierarchy Diagram\nThe view components are loaded in the following manner:\nNote: The Sugar application's client type is \"base\". For more information on the various client types, please refer to\u00c2\u00a0the User Interface page.\nComponents\nViews are made up of a controller and a Handlebar template.\nController\nThe view's controller is what controls the view in how data is loaded, formatted, and manipulated. The controller is the JavaScript file named after the view. A controller file can be found in any of the directories shown in the\u00c2\u00a0hierarchy diagram\u00c2\u00a0above. In the example of the record view, the main controller file is located in ./clients/base/views/record/record.js\u00c2\u00a0and any\u00c2\u00a0modules extending this controller will have a file located in ./modules/<module>/clients/base/views/record/record.js. \u00c2\u00a0\nHandlebar Template\nThe views template is built on Handlebars and is what adds the display markup for\u00c2\u00a0the data. The template is typically named after the view or an action in the view. In the example of the record view, the main template us located in ./clients/base/views/record/record.hbs. This template will take the data fetched from the REST API\u00c2\u00a0to render the display for\u00c2\u00a0the user. More information on templates can be found in the Handlebars\u00c2\u00a0section.\nExtending Views", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Views/index.html"}
{"id": "990e16c02ed2-1", "text": "Extending Views\nWhen working with module views, it is important to understand the difference between overriding and extending a view. Overriding is essentially creating or copying\u00c2\u00a0a view to be used by your application that is not extending its parent. By default, some module views already extend the core ./clients/base/views/record/record.js controller. An example of this is the accounts RecordView\n./modules/Accounts/clients/base/views/record/record.js\n({\n    extendsFrom: 'RecordView',\n    /**\n     * @inheritdoc\n     */\n    initialize: function(options) {\n        this.plugins = _.union(this.plugins || [], ['HistoricalSummary']);\n        this._super('initialize', [options]);\n    }\n})\nAs you can see, this view has the property:\u00c2\u00a0extendsFrom: 'RecordView'. This property tells Sidecar that the view is going to extend its parent RecordView. In addition to this, you can see that the initialize method is also calling\u00c2\u00a0this._super('initialize', [options]);. Calling this._super tells Sidecar\u00c2\u00a0to execute the parent function. The major benefit of doing this is that any updates to ./clients/base/views/record/record.js will be reflected for the module without\u00c2\u00a0any modifications being made to ./modules/Accounts/clients/base/views/record/record.js. You should note that when using extendsFrom, the parent views are called\u00c2\u00a0similarly to the load hierarchy:\u00c2\u00a0\n\u00c2\u00a0\nCreate View and Record View Inheritance\nThe diagram below demonstrates the inheritance of the create and record views for the Quotes module. This inheritance structure is the same for stock and custom modules alike.\u00c2\u00a0\nBasic View Example", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Views/index.html"}
{"id": "990e16c02ed2-2", "text": "Basic View Example\nA simple view for beginners is the access-denied view. The view is located in ./clients/base/views/access-denied/ and is what handles the display for restricted access. The sections below will outline the various files that render this view.\nController\nThe access-denied.js, shown below, controls the manipulation actions\u00c2\u00a0of the view.\n./clients/base/views/access-denied/access-denied.js\n({\n    className: 'access-denied tcenter',\n    cubeOptions: {spin: false},\n    events: {\n        'click .sugar-cube': 'spinCube'\n    },\n    spinCube: function() {\n        this.cubeOptions.spin = !this.cubeOptions.spin;\n        this.render();\n    }\n})\nAttributes\nAttribute\nDescription\nclassName\nThe CSS class to apply to the view.\ncubeOptions\nA set of options that are passed to the spinCube function when called.\nevents\nA list of the view events. This view executes the spinCube function when the sugar cube is clicked.\nspinCube\nFunction to control the start and stop of the cube spinning.\nHandlebar Template\nThe access-denied.hbs file defines the format of the views content. As this view is used for restricting access, it displays a message to the user describing the restriction.\n./clients/base/views/access-denied/access-denied.hbs\n<div class=\"error-message\">\n    <h1>{{str 'ERR_NO_VIEW_ACCESS_TITLE'}}</h1>\n    <p>{{str 'ERR_NO_VIEW_ACCESS_REASON'}}</p>\n    <p>{{str 'ERR_NO_VIEW_ACCESS_ACTION'}}</p>\n</div>\n{{{subFieldTemplate 'sugar-cube' 'detail' cubeOptions}}}\nHelpers\nName\nDescription\nstr\nHandlebars helper to render the label string\nsubFieldTemplate", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Views/index.html"}
{"id": "990e16c02ed2-3", "text": "Name\nDescription\nstr\nHandlebars helper to render the label string\nsubFieldTemplate\nHandlebars helper to render the cube content\nCookbook Examples\nWhen working with views, you may find the follow cookbook examples helpful:\nAdding Buttons to the Record View\nAdding Field Validation to the Record View\nPassing_Data_to_Templates\nTopicsMetadataThis page is an overview of the metadata framework for Sidecar modules.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Views/index.html"}
{"id": "e55f007621df-0", "text": "Metadata\nOverview\nThis page is an overview of the metadata framework for Sidecar modules.\nView Metadata Framework\nA module's view-specific metadata can be found in the modules view file:\n./modules/<module>/clients/<client>/views/<view>/<view>.php\nAny edits made in Admin > Studio will be reflected in the file:\n./custom/modules/<module>/clients/<client>/views/<view>/<view>.php\nNote: The Sugar application's client type is \"base\". For more information on the various client types, please refer to the User Interface page.\nNote: In the case of metadata, custom view metadata files are respected over the stock view metadata files.\nView Metadata\nThe Sidecar views metadata is very similar to that of the MVC metadata, however, there are some basic differences. All metadata for Sidecar follows the format:\n$viewdefs['<module>']['base']['view']['<view>'] = array();\nAn example of this is the account's record layout shown below:\n./modules/Accounts/clients/base/views/record/record.php\n<?php\n$viewdefs['Accounts']['base']['view']['record'] = array(\n    'panels' => array(\n        array(\n            'name' => 'panel_header',\n            'header' => true,\n            'fields' => array(\n                array(\n                    'name'          => 'picture',\n                    'type'          => 'avatar',\n                    'width'         => 42,\n                    'height'        => 42,\n                    'dismiss_label' => true,\n                    'readonly'      => true,\n                ),\n                'name',\n                array(\n                    'name' => 'favorite',\n                    'label' => 'LBL_FAVORITE',\n                    'type' => 'favorite',\n                    'dismiss_label' => true,\n                ),\n                array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Views/Metadata/index.html"}
{"id": "e55f007621df-1", "text": "'dismiss_label' => true,\n                ),\n                array(\n                    'name' => 'follow',\n                    'label'=> 'LBL_FOLLOW',\n                    'type' => 'follow',\n                    'readonly' => true,\n                    'dismiss_label' => true,\n                ),\n            )\n        ),\n        array(\n            'name' => 'panel_body',\n            'columns' => 2,\n            'labelsOnTop' => true,\n            'placeholders' => true,\n            'fields' => array(\n                'website',\n                'industry',\n                'parent_name',\n                'account_type',\n                'assigned_user_name',\n                'phone_office',\n            ),\n        ),\n        array(\n            'name' => 'panel_hidden',\n            'hide' => true,\n            'columns' => 2,\n            'labelsOnTop' => true,\n            'placeholders' => true,\n            'fields' => array(\n                array(\n                    'name' => 'fieldset_address',\n                    'type' => 'fieldset',\n                    'css_class' => 'address',\n                    'label' => 'Billing Address',\n                    'fields' => array(\n                        array(\n                            'name' => 'billing_address_street',\n                            'css_class' => 'address_street',\n                            'placeholder' => 'LBL_BILLING_ADDRESS_STREET',\n                        ),\n                        array(\n                            'name' => 'billing_address_city',\n                            'css_class' => 'address_city',\n                            'placeholder' => 'LBL_BILLING_ADDRESS_CITY',\n                        ),\n                        array(\n                            'name' => 'billing_address_state',\n                            'css_class' => 'address_state',\n                            'placeholder' => 'LBL_BILLING_ADDRESS_STATE',\n                        ),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Views/Metadata/index.html"}
{"id": "e55f007621df-2", "text": "'placeholder' => 'LBL_BILLING_ADDRESS_STATE',\n                        ),\n                        array(\n                            'name' => 'billing_address_postalcode',\n                            'css_class' => 'address_zip',\n                            'placeholder' => 'LBL_BILLING_ADDRESS_POSTALCODE',\n                        ),\n                        array(\n                            'name' => 'billing_address_country',\n                            'css_class' => 'address_country',\n                            'placeholder' => 'LBL_BILLING_ADDRESS_COUNTRY',\n                        ),\n                    ),\n                ),\n                array(\n                    'name' => 'fieldset_shipping_address',\n                    'type' => 'fieldset',\n                    'css_class' => 'address',\n                    'label' => 'Shipping Address',\n                    'fields' => array(\n                        array(\n                            'name' => 'shipping_address_street',\n                            'css_class' => 'address_street',\n                            'placeholder' => 'LBL_SHIPPING_ADDRESS_STREET',\n                        ),\n                        array(\n                            'name' => 'shipping_address_city',\n                            'css_class' => 'address_city',\n                            'placeholder' => 'LBL_SHIPPING_ADDRESS_CITY',\n                        ),\n                        array(\n                            'name' => 'shipping_address_state',\n                            'css_class' => 'address_state',\n                            'placeholder' => 'LBL_SHIPPING_ADDRESS_STATE',\n                        ),\n                        array(\n                            'name' => 'shipping_address_postalcode',\n                            'css_class' => 'address_zip',\n                            'placeholder' => 'LBL_SHIPPING_ADDRESS_POSTALCODE',\n                        ),\n                        array(\n                            'name' => 'shipping_address_country',\n                            'css_class' => 'address_country',\n                            'placeholder' => 'LBL_SHIPPING_ADDRESS_COUNTRY',\n                        ),\n                        array(\n                            'name' => 'copy',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Views/Metadata/index.html"}
{"id": "e55f007621df-3", "text": "),\n                        array(\n                            'name' => 'copy',\n                            'label' => 'NTC_COPY_BILLING_ADDRESS',\n                            'type' => 'copy',\n                            'mapping' => array(\n                                'billing_address_street' => 'shipping_address_street',\n                                'billing_address_city' => 'shipping_address_city',\n                                'billing_address_state' => 'shipping_address_state',\n                                'billing_address_postalcode' => 'shipping_address_postalcode',\n                                'billing_address_country' => 'shipping_address_country',\n                            ),\n                        ),\n                    ),\n                ),\n                array(\n                    'name' => 'phone_alternate',\n                    'label' => 'LBL_OTHER_PHONE',\n                ),\n                'email',\n                'phone_fax',\n                'campaign_name',\n                array(\n                    'name' => 'description',\n                    'span' => 12,\n                ),\n                'sic_code',\n                'ticker_symbol',\n                'annual_revenue',\n                'employees',\n                'ownership',\n                'rating',\n                array(\n                    'name' => 'date_entered_by',\n                    'readonly' => true,\n                    'type' => 'fieldset',\n                    'label' => 'LBL_DATE_ENTERED',\n                    'fields' => array(\n                        array(\n                            'name' => 'date_entered',\n                        ),\n                        array(\n                            'type' => 'label',\n                            'default_value' => 'LBL_BY',\n                        ),\n                        array(\n                            'name' => 'created_by_name',\n                        ),\n                    ),\n                ),\n                'team_name',\n                array(\n                    'name' => 'date_modified_by',\n                    'readonly' => true,\n                    'type' => 'fieldset',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Views/Metadata/index.html"}
{"id": "e55f007621df-4", "text": "'readonly' => true,\n                    'type' => 'fieldset',\n                    'label' => 'LBL_DATE_MODIFIED',\n                    'fields' => array(\n                        array(\n                            'name' => 'date_modified',\n                        ),\n                        array(\n                            'type' => 'label',\n                            'default_value' => 'LBL_BY',\n                        ),\n                        array(\n                            'name' => 'modified_by_name',\n                        ),\n                    ),\n                ),\n            ),\n        ),\n    ),\n);\nThe metadata for a given view can be accessed\u00c2\u00a0using app.metadata.getView\u00c2\u00a0within your controller. An example fetching the view metadata for the Accounts RecordView is shown below:\napp.metadata.getView('Accounts', 'record');\nYou should note that this can also be accessed in your browser's console window by using the global App Identifier:\nApp.metadata.getView('Accounts', 'record');\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Views/Metadata/index.html"}
{"id": "b5fe9c4d7611-0", "text": "MainLayout\nOverview\nSugar's Main navigation is split into two components: Top-Header and Sidebar. The Top-Header is primarily used for search, notifications, and user actions and the Sidebar is the primary tool used\u00c2\u00a0to\u00c2\u00a0navigate the front end of the Sugar application.\nLayout Components\nThe Main layout is\u00c2\u00a0composed of Top-Header (header-nav) and Sidebar/Rail (sidebar-nav) layouts, and each of those layouts host views.\u00c2\u00a0\nTop Header (header-nav)\nThe Top Header (header-nav) layout, located in ./clients/base/layouts/header-nav/header-nav.php, is composed of the\u00c2\u00a0quicksearch layout as well as the header-nav-logos,\u00c2\u00a0\u00c2\u00a0notifications, profileactions\u00c2\u00a0views. To customize these components, you can create your own layout by extending it at\u00c2\u00a0./custom/Extension/application/Ext/custom/clients/base/layouts/header-nav/header-nav.php to reference your own custom components.\n\u00c2\u00a0\nSidebar/Rail (sidebar-nav)\nThe Sidebar/Rail layout hosts overall Menu options by grouping them into layouts separated by a line/divisor within the sidebar-nav definition.\nRail is collapsed by default and contains two main clickable actions: Primary and Secondary.\u00c2\u00a0\nLink Actions\nThe following properties define the\u00c2\u00a0navigation, display, and visibility of all links in the system:\nName\nDescription\nacl_action\nThe ACL action is used to verify the user has access to a specific action\u00c2\u00a0required for the\u00c2\u00a0link\nacl_module\nThe ACL module\u00c2\u00a0is used to verify if the user has access to a specific module required for the link\nicon\nThe bootstrap icon to display next to the link (the full list of icons are listed\u00c2\u00a0in Admin > Styleguide > Core Elements > Base CSS > Icons)\nlabel\nThe label key that contains your link's display text\nopenwindow", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/MainLayout/index.html"}
{"id": "b5fe9c4d7611-1", "text": "label\nThe label key that contains your link's display text\nopenwindow\nSpecifies whether or not the link should\u00c2\u00a0open in a new window\nroute\nThe route to direct the user. For sidecar modules, this is #<module>,\u00c2\u00a0but\u00c2\u00a0modules in backward compatibility mode are routed as #bwc/index.php?module=<module>. Note:\u00c2\u00a0External links\u00c2\u00a0require the full URL as well as openwindow set to true.\nflyoutComponents\nAn array of sub-navigation linksNote:\u00c2\u00a0Sub-navigation links contain these same basic\u00c2\u00a0link properties.\nPrimary Action\nPrimary\u00c2\u00a0actions are triggered by the click of a button on the\u00c2\u00a0sidebar-nav's\u00c2\u00a0views. By default if a\u00c2\u00a0route\u00c2\u00a0property is provided in the view object in the layout metadata, the Primary Action will be a link to the route provided. For example:\n$viewdefs[...] = [\n    'layout' => [\n        'type' => 'sidebar-nav-item-group',\n        'name' => 'sidebar-nav-item-group-bottom',\n        'css_class' => 'flex-grow-0 flex-shrink-0',\n        'components' => [\n            [\n                'view' => [\n                    'name' => 'greeting-nav-item',\n                    'type' => '<some-custom-view>',\n                    'route' => '#Accounts',\n                    ...\n                ],\n            ],\n        ],\n    ],\n];\nOtherwise, if you're using a custom view and the controller has a\u00c2\u00a0primaryActionOnClick\u00c2\u00a0method defined, that will be used in addition to the\u00c2\u00a0route\u00c2\u00a0property.\u00c2\u00a0\nSecondary Action", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/MainLayout/index.html"}
{"id": "b5fe9c4d7611-2", "text": "Secondary Action\nWith the introduction of the sidebar-nav-item component, we're now introducing secondary actions. These appear by way of a kebab menu when hovering on the\u00c2\u00a0sidebar-nav-item\u00c2\u00a0container to which they are added.\u00c2\u00a0Secondary Actions do have\u00c2\u00a0some default behavior. If the template has the following markup present, the kebab will render on hover:\n<button class=\"sidebar-nav-item-kebab bg-transparent absolute p-0 h-full\">\n   <i class=\"{{buildIcon 'sicon-kebab'}} text-white\"></i>\n</button>\nIf metadata is provided with certain keys, clicking on the kebab icon will render a flyout menu, for example, a metadata definition such as:\n<?php\n$viewdefs['base']['layout']['sidebar-nav']['components'][] = [\n    'layout' => [\n        'type' => 'sidebar-nav-item-group',\n        'name' => 'sidebar-nav-item-group-bottom',\n        'css_class' => 'flex-grow-0 flex-shrink-0',\n        'components' => [\n            [\n                'view' => [\n                    'name' => 'greeting-nav-item',\n                    'type' => 'greeting-nav-item',\n                    'route' => '#Accounts',\n                    'icon' => 'sicon-bell-lg',\n                    'label' => 'Hello!',\n                    'flyoutComponents' => [\n                        [\n                            'view' => 'sidebar-nav-flyout-header',\n                            'title' => 'Greetings',\n                        ],\n                        [\n                            'view' => [\n                                'type' => 'sidebar-nav-flyout-actions',\n                                'actions' => [\n                                    [\n                                        'route' => '#Accounts',\n                                        'label' => 'LBL_ACCOUNTS',\n                                        'icon' => 'sicon-account-lg',\n                                    ],\n                                ],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/MainLayout/index.html"}
{"id": "b5fe9c4d7611-3", "text": "'icon' => 'sicon-account-lg',\n                                    ],\n                                ],\n                            ],\n                        ],\n                    ],\n                ],\n            ],\n        ],\n    ],\n];\nThe flyoutComponents array will render all the views that are passed to it. In this case, we load a\u00c2\u00a0sidebar-nav-item-header\u00c2\u00a0component and a\u00c2\u00a0sidebar-nav-item-flyout-actions\u00c2\u00a0component. Similar to a Primary Action, you can override the default\u00c2\u00a0secondaryActionOnClick\u00c2\u00a0method in your custom view controller to change the behavior of clicking on the kebab menu.\u00c2\u00a0\n$viewdefs[...] = [\n    'layout' => [\n        'type' => 'sidebar-nav-item-group',\n        'name' => 'sidebar-nav-item-group-bottom',\n        'css_class' => 'flex-grow-0 flex-shrink-0',\n        'components' => [\n            [\n                'view' => [\n                    'name' => 'greeting-nav-item',\n                    'type' => 'greeting-nav-item',\n                    'route' => '#Accounts',\n                    ...\n                ],\n            ],\n        ],\n    ],\n];\n\u00c2\u00a0\nThe following components define how the Sidebar/Rail layout is displayed.\nHome\nThe first group before the line/divisor contains the \"hamburger\" icon menu whose sole purpose is to expand/collapse the side nav.\nThe second group contains:\nHome menu dedicated to Dashboards\nQuick Create menu dedicated to creating new records\nHome Menu", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/MainLayout/index.html"}
{"id": "b5fe9c4d7611-4", "text": "Home menu dedicated to Dashboards\nQuick Create menu dedicated to creating new records\nHome Menu\nThe Home menu view is composed of the sidebar-nav-flyout-module-menu\u00c2\u00a0(responsible to display the Secondary Action menus with dashboards and recent items),\u00c2\u00a0sidebar-nav-item-module\u00c2\u00a0(responsible to display the menu's title) views. To customize these components, you can create your own layout by extending them at\u00c2\u00a0./custom/Extension/application/Ext/custom/clients/base/views\u00c2\u00a0and locating its folder with the same name\u00c2\u00a0for your own custom components.\nQuick Create\n\u00c2\u00a0\nQuick Create view has been redesigned and presents the modules on click.\nNote this view does not require secondary action as others do with submenu\nQuick Create View\nThe Quick Create view is composed of the sidebar-nav-item-quickcreate\u00c2\u00a0(responsible to display the Quick Create menu and its icon),\u00c2\u00a0sidebar-nav-flyout-header\u00c2\u00a0(responsible to display the menu's title) and sidebar-quickcreate\u00c2\u00a0(responsible to display Secondary Action/submenu) views. To customize these components, you can create your own layout by extending them at\u00c2\u00a0./custom/Extension/application/Ext/custom/clients/base/views\u00c2\u00a0and locating its folder with the same name\u00c2\u00a0for your own custom components.\nModules", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/MainLayout/index.html"}
{"id": "b5fe9c4d7611-5", "text": "Modules\nThe Modules layout, located in ./clients/base/layouts/sidebar-nav-item-group-modules/sidebar-nav-item-group-modules.js, contains the logic to load modules metadata, build the module list and display them accordingly depending on the Sidebar/Rail state (expanded or collapsed) as well as respect the Pinned Items and order it should be displayed.\u00c2\u00a0To customize this component, you can create your own by extending it at\u00c2\u00a0./custom/Extension/application/Ext/custom/clients/base/layouts/sidebar-nav-item-group-modules/sidebar-nav-item-group-modules.js,\u00c2\u00a0to reference your own custom logic and make sure you extend from the view SidebarNavItemModuleView or layout\u00c2\u00a0SidebarNavItemGroupModulesLayout\n\u00c2\u00a0\n\u00c2\u00a0\nif (isset($viewdefs['<module>']['base']['menu']['header'])) {\n    foreach ($viewdefs['<module>']['base']['menu']['header'] as $key => $moduleAction) {\n        //remove the link by label key\n        if (in_array($moduleAction['label'], array('<link label key>'))) {\n            unset($viewdefs['<module>']['base']['menu']['header'][$key]);\n        }\n    }\n}\nOnce you have created the\u00c2\u00a0extension files, navigate to Admin > Repair > Quick Repair and Rebuild.\u00c2\u00a0This will\u00c2\u00a0remove\u00c2\u00a0the\u00c2\u00a0menu\u00c2\u00a0action\u00c2\u00a0item from the existing list of links.\n\u00c2\u00a0\nProfile Action Links\nProfile actions are the links listed under the user's profile menu on the right side of the Top Header. Profile action extension files are\u00c2\u00a0located in\u00c2\u00a0./custom/Extension/application/Ext/clients/base/views/profileactions/ and are compiled into \u00c2\u00a0./custom/application/Ext/clients/base/views/profileactions/profileactions.ext.php.\nAdding Profile Action Links", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/MainLayout/index.html"}
{"id": "b5fe9c4d7611-6", "text": "Adding Profile Action Links\nThe example below demonstrates how to add a profile action link to the Styleguide. To define your own profile action link, create your own label extension for the link's display label.\u00c2\u00a0\n./custom/Extension/application/Ext/Language/en_us.addProfileActionLink.php\n<?php\n//create the links label\n$app_strings['LNK_STYLEGUIDE_C'] = 'Styleguide';\nNext, create the\u00c2\u00a0profile action link extension:\n./custom/Extension/application/Ext/clients/base/views/profileactions/addProfileActionLink.php\n<?php\n$viewdefs['base']['view']['profileactions'][] = array(\n    'route' => '#Styleguide',\n    'label' => 'LNK_STYLEGUIDE_C',\n    'icon' => 'icon-link',\n);\nOnce you have created the\u00c2\u00a0extension files, navigate to Admin > Repair > Quick Repair and Rebuild.\u00c2\u00a0This will append your profile action\u00c2\u00a0item to the existing list of links.\nNote: You may need to refresh the page to see the new profile menu items.\nRemoving Profile Action Links\nTo remove a profile action link, loop through the list of profile actions and remove the item by one of its properties. For your reference, the stock profile actions can be found in ./clients/base/views/profileactions/profileactions.php.\n./custom/Extension/application/Ext/clients/base/views/profileactions/removeProfileActionLink.php\n<?php\nif (isset($viewdefs['base']['view']['profileactions'])) {\n    foreach ($viewdefs['base']['view']['profileactions'] as $key => $profileAction) {\n        //remove the link by label key\n        if (in_array($profileAction['label'], array('LNK_ABOUT'))) {\n            unset($viewdefs['base']['view']['profileactions'][$key]);\n        }\n    }\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/MainLayout/index.html"}
{"id": "b5fe9c4d7611-7", "text": "}\n    }\n}\nOnce you have created the\u00c2\u00a0extension files, navigate to Admin > Repair > Quick Repair and Rebuild.\u00c2\u00a0This will remove\u00c2\u00a0the\u00c2\u00a0profile action\u00c2\u00a0item from the existing list of links.\nNote:\u00c2\u00a0You may need to refresh the page to see the profile menu items removed.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/MainLayout/index.html"}
{"id": "324948df69ba-0", "text": "Drawers\nOverview\nThe drawer layout widget, located in ./clients/base/layouts/drawer/, is used to display a window of additional content to the user. This window can then be closed to display the content the user was previously viewing.\nMethods\napp.drawer.open(layoutDef, onClose)\nThe app.drawer.open(layoutDef, onClose) method\u00c2\u00a0displays a new content window over the current view.\nParameters\nName\nRequired\nDescription\nlayoutDef.layout\nyes\nThe id of the layout to load.\nlayoutDef.context\nno\nAdditional data you would like to pass to the drawer. Data passed in can be retrieved from the view using:\nthis.context.get('<data key>');\nNote: Be very careful about what you pass in as data to the drawer. As the data is passed in by reference, when the drawer is closed, the context is destroyed.\nonClose\nno\nOptional callback handler for when the drawer is closed.\nExample\napp.drawer.open({\n    layout: 'my-layout',\n    context: {\n        myData: data\n    },\n},\nfunction() {\n    //on close, throw an alert\n    alert('Drawer closed.');\n});\napp.drawer.close(callbackOptions)\nThe app.drawer.close(callbackOptions) method dismisses the topmost drawer.\nParameters\nName\nRequired\nDescription\ncallbackOptions\nno\nAny parameters passed into the close method will be passed to the callback.\nStandard Example\napp.drawer.close();\nCallback Example\n//open drawer\napp.drawer.open({\n    layout: 'my-layout',\n},\nfunction(message1, message2) {\n    alert(message1);\n    alert(message2);\n});\n//close drawer\napp.drawer.close('message 1', 'message 2');\napp.drawer.load(options)\nLoads a new layout into an existing drawer.\nParameters\nName\nDescription\noptions.layout", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Drawers/index.html"}
{"id": "324948df69ba-1", "text": "Loads a new layout into an existing drawer.\nParameters\nName\nDescription\noptions.layout\nThe id of the layout to load.\nExample\napp.drawer.load({\n    layout: 'my-second-layout',\n});\napp.drawer.reset(triggerBefore)\nThe app.drawer.reset(triggerBefore) method destroys all drawers at once. By default, whenever the application is routed to another page, reset() is called.\nParameters\nName\nRequired\nDescription\ntriggerBefore\nno\nDetermines whether to triggerBefore. Defaults to false.\nExample\napp.drawer.reset();\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Drawers/index.html"}
{"id": "69766d6cc067-0", "text": "Fields\n\u00c2\u00a0\nOverview\nFields are component plugins that render and format field values. They\u00c2\u00a0are made up of a controller JavaScript file (.js) and at least one Handlebars template (.hbt). For more information regarding the data handling of a field, please refer the data framework fields documentation. For information on creating custom field types, please refer the Creating Custom Field Types cookbook example.\nHierarchy Diagram\nThe field components are loaded in the following manner:\nNote: The Sugar application's client type is \"base\". For more information on the various client types, please refer to\u00c2\u00a0the User Interface page.\nField Example\nThe bool field, located in ./clients/base/fields/bool/, handles the display of\u00c2\u00a0checkbox boolean values. The sections below outline the various files that render this field type.\nController\nThe bool.js, file is shown below, overrides the base _render function to disable the field. The format and unformat functions handle the manipulation of the field's value.\n./clients/base/fields/bool/bool.js\n({\n    _render: function() {\n        app.view.Field.prototype._render.call(this);\n        if(this.tplName === 'disabled') {\n            this.$(this.fieldTag).attr(\"disabled\", \"disabled\");\n        }\n    },\n    unformat:function(value){\n        value = this.$el.find(\".checkbox\").prop(\"checked\") ? \"1\" : \"0\";\n        return value;\n    },\n    format:function(value){\n        value = (value==\"1\") ? true : false;\n        return value;\n    }\n})\nAttributes\nAttribute\nDescription\n_render\nFunction to render the field.\nunformat\nFunction to dynamically check the checkbox based on the value.\nformat\nFunction to format the value for storing in the database.\nHandlebar Templates", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Fields/index.html"}
{"id": "69766d6cc067-1", "text": "format\nFunction to format the value for storing in the database.\nHandlebar Templates\nThe edit.hbs file defines the display of the control when the edit view is used. This layout is for displaying the editable form element that renders a clickable checkbox control for the user.\n./clients/base/fields/bool/edit.hbs\n{{#if def.text}}\n    <label>\n        <input type=\"checkbox\" class=\"checkbox\"{{#if value}} checked{{/if}}> {{str def.text this.module}}\n    </label>\n{{else}}\n    <input type=\"checkbox\" class=\"checkbox\"{{#if value}} checked{{/if}}>\n{{/if}}\nHelpers\nHelpers\nDescription\nstr\nHandlebars helper to render the label string.\nThe detail.hbs file defines the display of the control when the detail view is used. This layout is for viewing purposes only so the control is disabled by default.\n./clients/base/fields/bool/detail.hbs\n<input type=\"checkbox\" class=\"checkbox\"{{#if value}} checked{{/if}} disabled>\nThe list.hbs file defines the display of the control when the list view is used. This view is also for viewing purposes only so the control is disabled by default.\n./clients/base/fields/bool/list.hbs\n<input type=\"checkbox\" class=\"checkbox\"{{#if value}} checked{{/if}} disabled>\nCookbook Examples\nWhen working with fields, you may find the follow cookbook examples helpful:\nCreating Custom Field Types\nConverting Address' Country Field to a Dropdown\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/User_Interface/Fields/index.html"}
{"id": "6cea69957584-0", "text": "Architecture\nOverview\nThis section of Sugar's Developer Guide begins with a high-level overview of the Sugar platform's architecture and contains documentation on granular concepts in Sugar such as logic hooks, caching, logging, extensions, job queue, and more.\nPlease continue to the bottom of this page or use the navigation on the left to explore\u00c2\u00a0the related content.\nPlatform\nSugar\u00c2\u00ae is built on open standards and technology such as HTML5, PHP, and JavaScript, and runs on a variety of free and open-source technology like Linux, MySQL, and Elasticsearch. The Sugar platform also supports common proprietary databases such as Oracle, IBM DB2, and Microsoft SQL Server.\nAll of Sugar's customers and partners have access to source code that they can choose to deploy on-premise or utilize Sugar's cloud service for a SaaS deployment.\nOut of the box, Sugar uses a consistent platform across all clients and devices (e.g. mobile, web, plug-ins, etc.).\nFront-End Framework\nOur clients are based on a front-end framework called Sidecar. Sidecar is built on open source technology: Backbone.js, jQuery, Handlebars.js, and Bootstrap. The Sidecar framework provides a responsive UI (to support a variety of form factors) and uses modern, single-page client architecture. Sugar clients connect to Sugar server application via our client REST API. The REST API is implemented in PHP and drives server-side business logic and interacts with a database. If it can be accomplished via one of our clients, then its equivalent functionality can be accomplished using our REST API.\nThe Sugar platform uses modules. Modules are a vertically integrated application component that is traditionally organized around a single feature or record type (or underlying database table). For example, contact records are managed via a Contacts module that contains all the business logic, front-end interface definitions, REST APIs, data schema,\u00c2\u00a0and\u00c2\u00a0relationships with other modules.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/index.html"}
{"id": "6cea69957584-1", "text": "Custom modules can be created and deployed as needed in order to add new features to a Sugar application instance.\u00c2\u00a0\nMetadata\nSugar's modules are defined primarily using Metadata. There are two types of metadata definitions within Sugar: Vardefs, which define the data model for Sugar modules; and Viewdefs, which define the user interface components that are used with a module.\nSugar Metadata is implemented as PHP files that can be modified directly by a Sugar Developer making filesystem changes, or indirectly through the use of Sugar Studio and Module Builder by a Sugar Administrator.\nMetadata allows you to configure solutions instead of having to write countless lines of custom code in order to implement common customizations such as adding custom fields, calculated values, and changing user interface layouts.\nExtensions\nBeyond metadata, Sugar is highly customizable and includes an extensive Extensions Framework that provides Sugar Developers the capability to contribute to pre-defined extension points within the application in a way that is upgrade-safe and will not conflict with other customizations that exist in the system.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/index.html"}
{"id": "6cea69957584-2", "text": "TopicsAutoloaderThe autoloader is an API that allows the unified handling of customizations and customizable metadata while reducing the number of filesystem accesses and improving performance.CachingMuch of Sugar's user interface is built dynamically using a combination of templates, metadata and language files. A file caching mechanism improves the performance of the system by reducing the number of static metadata and language files that need to be resolved at runtime. This cache directory stores the compiled files for JavaScript files, Handlebars templates, and language files.UploadsThe upload directory is used to store files uploaded for imports, attachments, documents, and module loadable packages.EmailOutlines the relationships between emails, email addresses, and bean records.Email AddressesRecommended approaches when working with email addresses in Sugar.LoggingThere are two logging systems implemented in the Sugar application: SugarLogger and PSR-3. PSR-3 is Sugar's preferred logger solution and should be used going forward.Logic HooksThe Logic Hook framework allows you to append actions to system events such as when creating, editing, and deleting records.LanguagesSugar as an application platform is internationalized and localizable. Data is stored and presented in the UTF-8 codepage, allowing for all character sets to be used. Sugar provides a language-pack framework that allows developers to build support for any language in the display of user interface labels. Each language pack has its own set of display strings which is the basis of language localization. You can add or modify languages using the information in this guide.ExtensionsThe extension framework, defined in ./ModuleInstall/extensions.php, provides the capability to modify Sugar metadata such as vardefs and layouts in a safe way that supports installing, uninstalling, enabling, and disabling without interfering with other customizations.FiltersFilters are a way to predefine searches on views that render a list of records such as list views, pop-up searches, and lookups. This page explains how to implement the various types of filters for record list views.Duplicate CheckThe duplicate-check framework provides the capability", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/index.html"}
{"id": "6cea69957584-3", "text": "implement the various types of filters for record list views.Duplicate CheckThe duplicate-check framework provides the capability to alter how the system searches for duplicate records in the database when creating records. For information on duplicate checking during imports, please refer to the index documentation.Elastic SearchThe focus of this document is to guide developers on how Sugar integrates with Elastic Search.Global SearchHow to customize the global search results.Sugar LogicSugar Logic, a feature in all Sugar products, enables custom business logic that is easy to create, manage, and reuse on both the server and client.AdministrationThe Administration class is used to manage settings stored in the database config table.ConfiguratorThe Configurator class, located in ./modules/Configurator/Configurator.php, handles the config settings found in ./config.php and ./config_override.php.Module LoaderModule Loader is used when installing customizations, plugins,language packs, and hotfixes, and other customizations into a Sugar instance in the form of a Module Loadable Package. This documentation covers the basics and best practices for creating module loadable packages for a Sugar installation.Module BuilderThe Module Builder tool allows programmers to create custom modules without writing code and to create relationships between new and existing CRM modules. To illustrate how to use Module Builder, this article will show how to create and deploy a custom module.QuotesAs of Sugar 7.9.0.0, the quotes module has been moved out of Backward Compatibility mode into Sidecar. Customizations to the Quotes interface will need to be rewritten for the new Sidecar framework as an automated migration of these customizations is not possible. This document will outline common customizations and implementation methods.SugarBPMSugarBPM\u00e2\u0084\u00a2 automation suite is the next-generation workflow management tool for Sugar. Introduced in 7.6, SugarBPM is loosely based on BPMN process notation standards and provides a simple drag-and-drop user interface along with an intelligent flow designer to allow for the creation of easy yet powerful process", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/index.html"}
{"id": "6cea69957584-4", "text": "user interface along with an intelligent flow designer to allow for the creation of easy yet powerful process definitions.Entry PointsEntry points, defined in ./include/MVC/Controller/entry_point_registry.php, were used to ensure that proper security and authentication steps are applied consistently across the entire application. While they are still used in some areas of Sugar, any developers using custom entry points should adjust their customizations to use the latest REST API endpoints instead.Job QueueThe Job Queue executes automated tasks in Sugar through a scheduler, which integrates with external UNIX systems and Windows systems to run jobs that are scheduled through those systems. Jobs are the individual runs of the specified function from a scheduler.Access Control ListsAccess Control Lists (ACLs) are used to control access to the modules, data, and actions available to users in Sugar. By default, Sugar comes with a default ACL Strategy that is configurable by an Admin through the Roles module via Admin > Role Management. Sugar also comes with other ACL strategies that are located in the ./data/acl/ folder, and are used in other parts of the system such as the Administration module, Emails module, Locked Fields functionality, and many others. They can also be leveraged by customizations and custom ACL strategies can be implemented to control your own customizations.TeamsTeams provide the ability to limit access at the record level, allowing sharing flexibility across functional groups. Developers can manipulate teams programmatically provided they understand Sugar's visibility framework.TagsThe tagging feature allows a user to apply as many \"tags\" as they choose on any record they want to categorize. This allows the user to effectively group records together from any source within the application and relate them together. Please note that the tag field and Tags module do not support customization at this time.TinyMCEThis section contains information about working with the TinyMCE editor in Sugar.SugarPDFThis section contains information on generating PDFs and configuring PDF settings and fonts in Sugar.DateTimeThe SugarDateTime class, located in,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/index.html"}
{"id": "6cea69957584-5", "text": "generating PDFs and configuring PDF settings and fonts in Sugar.DateTimeThe SugarDateTime class, located in, ./include/SugarDateTime.php, extends PHP's built in DateTime class and can be used to perform common operations on date and time values.ShortcutsShortcuts is a framework to add shortcut keys to the application. When shortcut keys are registered, they are registered to a particular shortcut session. Shortcut sessions group shortcut keys, and they can be activated, deactivated, saved, and restored. Global shortcut keys can be registered, but they are not tied to a particular shortcut session. They are rather applied everywhere in the application and can only be applied once.ThemesHow to customize the Sugar theme.Web AccessibilityLearn about the Sugar Accessibility Plugin for Sidecar.Validation ConstraintsThis article will cover how to add validation constraints to your custom code.CLISugar on-premise deployments include a command line interface tool built using the Symfony Console Framework. Sugar's CLI is intended to be an administrator or developer level power tool to execute PHP code in the context of Sugar's code base. These commands are version specific and can be executed on a preinstalled Sugar instance or on an installed Sugar instance. Sugar's CLI is not intended to be used as a tool to interact remotely with an instance nor is it designed to interact with multiple instances.Performance TuningThe Performance Tuning section contains information that will help maximize system performance for your Sugar instance.Backward CompatibilityAs of Sugar\u00c2\u00ae 7, modules are built using the Sidecar framework. Any modules that still use the MVC architecture and have not yet migrated to the Sidecar framework are set in what Sugar refers to as \"backward compatibility\" (BWC) mode.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/index.html"}
{"id": "6cea69957584-6", "text": "Last modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/index.html"}
{"id": "cd28755f551c-0", "text": "Extensions\nOverview\nThe extension framework,\u00c2\u00a0defined in\u00c2\u00a0./ModuleInstall/extensions.php, provides the capability to modify Sugar metadata such as vardefs and layouts in a safe way that supports installing, uninstalling, enabling, and disabling without interfering with other customizations.\nApplication extensions are stored under ./custom/Extension/application/Ext/ and module extensions are under ./custom/Extension/modules/<module>/Ext/. The files in each of these directories are aggregated into a single file with a predefined name for the system to use. An example of this is the vardefs extension. The vardef extension directory for Accounts is located in ./custom/Extension/modules/Accounts/Ext/Vardefs/. When a module is installed, uninstalled, enabled, or disabled, the files contained in this directory are merged into ./custom/modules/Accounts/Ext/Vardefs/vardefs.ext.php. A Quick Repair & Rebuild will also cause the files to merge.\nThe core extension mappings are listed in the Topics section at the bottom of this page.\nExtensions Properties\nEach extension contains the following properties:\nProperty\nDescription\nExtension Scope\nAll\u00c2\u00a0: Extension can be applied to the ./custom/application/ or ./custom/<module>/ directory\nApplication\u00c2\u00a0: Extension can only be applied to the ./custom/application/ directory\nModule\u00c2\u00a0: Extension can only be applied to the ./custom/<module>/ directory\nDefinition\u00c2\u00a0Variable\nThe variable that Sugar\u00c2\u00a0for utilizing the extension definition. If defined, this variable must be set with the appropriate definition properties.\nExtension Directory\nThe directory that the extension compiles files from\nIf the customization is for the application, the extension file should be placed in ./custom/Extension/application/Ext/<extension_directory>/\nIf the customization is for a module, the extension file should be placed in ./custom/Extension/modules/<module>/Ext/<extension_directory>/\nCompiled Extension File\nThe name of the compiled extension file", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/index.html"}
{"id": "cd28755f551c-1", "text": "Compiled Extension File\nThe name of the compiled extension file\nIf the extension is for the application, the compiled file will be located in ./custom/application/Ext/<extension>/<extension>.ext.php\nIf the extension is for a module, the compiled file will be located in ./custom/modules/<module>/Ext/<extension>/<extension>.ext.php\nManifest Installdef\nThe index of the $installdef in the manifest file for module loadable packages.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/index.html"}
{"id": "cd28755f551c-2", "text": "TopicsActionFileMapThe ActionFileMap extension maps actions to files, which helps you map a file to a view outside of ./custom/modules/<module>/views/view.<name>.php. This page is only applicable to modules running in backward compatibility mode.ActionReMapThe ActionReMap extension maps new actions to existing actions. This extension is only applicable to modules running in backward compatibility mode.ActionViewMapThe ActionViewMap extension maps additional actions for a module.AdministrationThe Administration extension adds new panels to Sugar's Administration page.Application SchedulersApplication Scheduler extensions add custom functions that can be used by scheduler jobs.ConsoleThe Console extension adds custom CLI commands to Sugar. More information on creating custom commands can be found in the CLI documentation.DependenciesDependencies create dependent actions for fields and forms that can leverage more complicated logic.EntryPointRegistryThe EntryPointRegistry extension maps additional entry points to the system. Please note that entry points will soon be deprecated. Developers should move custom logic to endpoints. For more information, please refer to the Entry Points page.ExtensionsThis extension allows for developers to create custom extensions within the framework. Custom extensions are used alongside the extensions found in ./ModuleInstaller/extensions.php.FileAccessControlMapThe FileAccessControlMap extension restricts specific view actions from users of the system.IncludeThe Modules extension maps additional modules in the system, typically when Module Builder deploys a module.JSGroupingsThe JSGroupings extension allows for additional JavaScript grouping files to be created or added to existing groupings within the system.LanguageThe Language extension adds or overrides language strings.LayoutdefsThe Layoutdefs extension adds or overrides subpanel definitions.LogicHooksThe LogicHooks extension adds actions to specific events such as, for example, before saving a bean. For more information on logic hooks in Sugar, please refer to the Logic Hooks documentation.ModulesThe Modules extension maps additional modules in the system, typically when Module Builder deploys a module.PlatformsThe Platforms extension adds allowed REST API platforms when restricting custom platforms through the use of the disable_unknown_platforms", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/index.html"}
{"id": "cd28755f551c-3", "text": "Platforms extension adds allowed REST API platforms when restricting custom platforms through the use of the disable_unknown_platforms configuration setting.ScheduledTasksThe ScheduledTasks extension adds custom functions that can be used by scheduler jobs. For more information about schedulers in Sugar, please refer to the Schedulers documentation.SidecarThe Sidecar extension installs metadata files to their appropriate directories.TinyMCEThe TinyMCE extension affects the TinyMCE WYSIWYG editor's configuration for backward compatible modules such as PDF Manager and Campaign Email Templates.UserPageThe UserPage extension adds sections to the User Management view.UtilsThe Utils extension adds functions to the global utility function list.VardefsThe Vardefs extension adds or overrides system vardefs, which provide the Sugar application with information about SugarBeans.WirelessLayoutdefsThe WirelessLayoutdefs extension adds additional subpanels to wireless views. This extension is only applicable to modules running in backward compatibility mode.WirelessModuleRegistryThe WirelessModuleRegistry extension adds modules to the available modules for mobile.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/index.html"}
{"id": "cd28755f551c-4", "text": "Last modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/index.html"}
{"id": "0de4b2b31aa9-0", "text": "This page refers to content that is only available in modules running in backward compatibility mode.\nActionFileMap\nOverview\nThe ActionFileMap extension maps actions to files, which helps\u00c2\u00a0you map a file to a view outside of ./custom/modules/<module>/views/view.<name>.php. This page is only applicable to modules running in backward compatibility mode.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nModule\nSugar Variable\n$action_file_map\nExtension Directory\n./custom/Extension/modules/<module>/Ext/ActionFileMap/\nCompiled Extension File\n./custom/<module>/Ext/ActionFileMap/action_file_map.ext.php\nManifest Installdef\n$installdefs['action_file_map']\nImplementation\nThe following sections illustrate the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/modules/<module>/Ext/ActionFileMap/ to map a new action in the system. The following example will create a new action called \"example\" in a module:\n./custom/Extension/modules/<module>/Ext/ActionFileMap/<file>.php\n<?php\n$action_file_map['new_action'] = 'custom/modules/<module>/new_action.php';\nNext, create your action file:\n./custom/modules/<module>/new_action.php\n<?php\n//Encoded as JSON for AJAX layouts\necho '{\"content\":\"Example View\"}';\n?>\nNext, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and compile your customization into\u00c2\u00a0./custom/modules/<module>/Ext/ActionFileMap/action_file_map.ext.php\nModule Loadable Package\nWhen building a module-loadable package, you can use the $installdefs['action_file_map'] index to install the extension file.\u00c2", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/ActionFileMap/index.html"}
{"id": "0de4b2b31aa9-1", "text": "Installdef Properties\nName\nType\nDescription\nfrom\nString\nThe basepath of the file to be installed.\u00c2\u00a0\nto_module\nString\nThe key of the module the file is to be installed to.\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file in order to add the Action File Map file to a specific module. You should note that when using this approach, you still need to use the $installdefs['copy'] index for the Action file, but Sugar will automatically execute Rebuild Extensions to reflect the new Action in the system.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'ActionRemap_Example',\n    'action_file_map' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/modules/<module>/Ext/ActionFileMap/<file>.php',\n            'to_module' => '<module>',\n        )\n    ),\n    'copy' => array(\n        array(\n            'from' => '<basepath>/Files/custom/example.php',\n            'to' => 'custom/example.php'\n        )\n    )\n);\nAlternatively, you may use the $installdefs['copy'] index for the Action File Map Extension file. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information\u00c2\u00a0on the $installdefs['copy'] index and module-loadable packages, please refer to the Introduction to the Manifest page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/ActionFileMap/index.html"}
{"id": "cae115c73927-0", "text": "This page refers to content that is only available in modules running in backward compatibility mode.\nWirelessLayoutdefs\nOverview\nThe WirelessLayoutdefs extension adds additional subpanels to wireless views. This extension is only applicable to modules running in backward compatibility mode.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nModule\nSugar Variable\n$layout_defs\nExtension Directory\n./custom/Extension/modules/<module>/Ext/WirelessLayoutdefs/\nCompiled Extension File\n./custom/<module>/Ext/WirelessLayoutdefs/wireless.subpaneldefs.ext.php\nManifest Installdef\n$installdefs['wireless_subpanels']\nImplementation\nThe following sections illustrate the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/modules/<module>/Ext/WirelessLayoutdefs/ to add a subpanel to a module in the system. The following example will add a new subpanel to a specified module:\n./custom/Extension/modules/<module>/Ext/WirelessLayoutdefs/<file>.php\n<?php\n$layout_defs['<module>']['subpanel_setup']['<subpanel module>'] = array(\n    'order' => 10,\n    'module' => '<subpanel module>',\n    'get_subpanel_data' => '<subpanel name>',\n    'title_key' => 'LBL_SUBPANEL_TITLE',\n);\nNavigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and compile your customization into ./custom/modules/<module>/Ext/WirelessLayoutdefs/wireless.subpaneldefs.ext.php.\nModule Loadable Package\nWhen building a module loadable package, you can use the $installdefs['wireless_subpanels'] index to install the extension file.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/WirelessLayoutdefs/index.html"}
{"id": "cae115c73927-1", "text": "Installdef Properties\nName\nType\nDescription\nfrom\nString\nThe base path of the file to be installed\nto_module\nString\nThe key for the module where the file will be installed\nThe example below will demonstrate the proper install definition that should be used in the ./manifest.php file in order to add the subpanel file to a specific module. You should note that when using this approach Sugar will automatically execute Rebuild Extensions to reflect the subpanel in the system.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'wirelessLayoutdefs_Example',\n    'wireless_subpanels' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/modules/<module>/Ext/WirelessLayoutdefs/<file>.php',\n            'to_module' => '<module>',\n        )\n    )\n);\nAlternatively, you may use the $installdefs['copy'] index to copy the file. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information on the $installdefs['copy'] index and module-loadable packages, please refer to the Introduction to the Manifest page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/WirelessLayoutdefs/index.html"}
{"id": "b7a86d4ba843-0", "text": "Modules\nOverview\nThe Modules extension maps additional modules in the system, typically when Module Builder deploys a module.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nApplication\nSugar Variable\n$beanList, $beanFiles, $moduleList\nExtension Directory\n./custom/Extension/application/Ext/Include/\nCompiled Extension File\n./custom/application/Ext/Include/modules.ext.php\nManifest Installdef\n$installdefs['beans']\nImplementation\nThe following sections illustrate the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/application/Ext/Include/ to register a new module in the system. This extension is normally used when deploying custom modules. The example below shows what this file will look like after a module is deployed:\n./custom/Extension/application/Ext/Include/<file>.php\n<?php\n$beanList['cust_module'] = 'cust_module';\n$beanFiles['cust_module'] = 'modules/cust_module/cust_module.php';\n$moduleList[] = 'cust_module';\nNext, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and compile your customization into ./custom/application/Ext/Include/modules.ext.php.\nModule Loadable Package\nWhen building a module loadable package, you can use the $installdefs['beans'] index to install the extension file.\nInstalldef Properties\nName\nType\nDescription\nmodule\nString\nThe key of the module to be installed\nclass\nString\nThe class name of the module to be installed\npath\nString\nThe path to the module's class\ntab\nBoolean\nWhether or not the module will have a navigation tab (defaults to false)", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Modules/index.html"}
{"id": "b7a86d4ba843-1", "text": "tab\nBoolean\nWhether or not the module will have a navigation tab (defaults to false)\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file, in order to add a custom module to the system. When using this approach, you still need to use the $installdefs['copy'] index for Module directory, however, Sugar will automatically execute the database table creation process, relationship table creation process, as well as Rebuild Extensions to reflect the new Module in the system.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'Beans_Example',\n    'beans' => array(\n        array(\n            'module' => 'cust_Module',\n            'class' => 'cust_Module',\n            'path' => 'modules/cust_Module/cust_Module.php',\n            'tab' => true\n        )\n    ),\n    'copy' => array(\n        array(\n            'from' => '<basepath>/Files/modules/cust_Module',\n            'to' => 'modules/cust_Module'\n        )\n    )\n);\nAlternatively, you may use the\u00c2\u00a0$installdefs['copy']\u00c2\u00a0index for copying the Modules definition file into the ./custom/Extension/application/Ext/Include/\u00c2\u00a0directory. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information\u00c2\u00a0on the\u00c2\u00a0$installdefs['copy']\u00c2\u00a0index and module loadable packages, please refer to the\u00c2\u00a0Introduction to the Manifest\u00c2\u00a0page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Modules/index.html"}
{"id": "12e32d91212b-0", "text": "Language\nOverview\nThe Language extension adds or overrides language strings.\nThis extension is applicable to both the application and module framework. For more information, please refer to the Language Framework page.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nAll - Application & Module\nSugar Variables\nIf adding language files to application:$app_strings / $app_list_strings\u00c2\u00a0\nIf adding language files to <module>:$mod_strings\nExtension Directory\nApplication: ./custom/Extension/application/Ext/Language/\nModule: ./custom/Extension/modules/<module>/Ext/Language/\nCompiled Extension File\nApplication: ./custom/application/Ext/Language/<language_key>.lang.ext.php\nModule:\u00c2\u00a0./custom/modules/<module>/Ext/Language/<language_key>.lang.ext.php\nManifest Installdef\n$installdefs['language']\n\u00c2\u00a0\nImplementation\nThe following sections illustrate\u00c2\u00a0the various ways to implement a customization to a Sugar instance.\nFile System\nCreating New Application Label\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/application/Ext/Language/ to add Labels for languages to the system.\u00c2\u00a0The following example will add a new Label 'LBL_EXAMPLE_LABEL' to the system:\u00c2\u00a0\n./custom/Extension/application/Ext/Language/<language>.<file>.php\n<?php\n$app_strings['LBL_EXAMPLE_LABEL'] = 'Example Application Label';\nNavigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and compile your customization into./custom/application/Ext/Language/<language>.lang.ext.php\nCreating New Module Label", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Language/index.html"}
{"id": "12e32d91212b-1", "text": "Creating New Module Label\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/modules/<module>/Ext/Language/ to add Labels for languages to a particular module.\u00c2\u00a0The following example will add a new Label 'LBL_EXAMPLE_MODULE_LABEL' to a module:\n./custom/Extension/modules/<module>/Ext/Language/<language>.<file>.php\n<?php\n$mod_strings['LBL_EXAMPLE_MODULE_LABEL'] = 'Example Module Label';\nNavigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and compile your customization into ./custom/modules/<module>/Ext/Language/<language>.lang.ext.php\nModule Loadable Package\nWhen building a module loadable package, you can use the $installdefs['language'] index to install the extension file.\u00c2\u00a0\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe basepath of the file to be installed.\u00c2\u00a0\nto_module\nString\nThe key of the module the file is to be installed to.\nlanguage\nString\nThe key of the language the file is to be installed to.\nThe example below will demonstrate the proper install definition that should be used in the ./manifest.php file, in order to add the Language Extension file to the system. You should note that when using this approach\u00c2\u00a0Sugar will automatically execute Rebuild Extensions\u00c2\u00a0to reflect the new Labels in the system.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'language_Example',\n    'language' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/application/Ext/Language/<language>.lang.ext.php',\n            'to_module' => 'application',\n            'language' => '<language>'\n        )\n    )\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Language/index.html"}
{"id": "12e32d91212b-2", "text": "'language' => '<language>'\n        )\n    )\n);\nAlternatively, you may use the $installdefs['copy'] index to copy the file. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information on the $installdefs['copy'] index and module-loadable packages, please refer to the Introduction to the Manifest page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Language/index.html"}
{"id": "cb5f3331200c-0", "text": "Console\nOverview\nThe Console\u00c2\u00a0extension adds custom CLI commands to Sugar. More information on creating custom commands can be found in the CLI documentation.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nApplication\nExtension Directory\n./custom/Extension/application/Ext/Console/\nCompiled Extension File\n./custom/application/Ext/Console/console.ext.php\nManifest Installdef\n$installdefs['console']\nImplementation\nThe following sections illustrate the various ways to implement a customization to a Sugar instance.\nFile System\nTo create a Sugar console\u00c2\u00a0extension, please refer to our CLI documentation.\nModule Loadable Package\nWhen building a module loadable package, you can use the $installdefs['console'] index to install the extension file.\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe basepath of the file to be installed.\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file in order to add the console command.\u00c2\u00a0\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array (\n  'id' => 'console_Example',\n  'console' => array(\n      array(\n          'from' => '<basepath>/Files/custom/Extension/application/Ext/Console/RegisterHelloWorldCommand.php'\n      )\n  ),\n  'copy' => array (\n    0 => array (\n      'from' => '<basepath>/Files/custom/src/Console/Command/HelloWorldCommand.php',\n      'to' => 'custom/src/Console/Command/HelloWorldCommand.php',\n    ),\n  ),\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Console/index.html"}
{"id": "cb5f3331200c-1", "text": "),\n  ),\n);\nAlternatively, you may use the $installdefs['copy'] index to copy the file. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information on the $installdefs['copy'] index and module-loadable packages, please refer to the Introduction to the Manifest page.\nDownload the module loadable example package here.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Console/index.html"}
{"id": "bf780a13c326-0", "text": "Administration\nOverview\nThe Administration extension adds new panels to Sugar's Administration page.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nModule: Administration\nSugar Variable\n$admin_group_header\nExtension Directory\n./custom/Extension/modules/Administration/Ext/Administration/\nCompiled Extension File\n./custom/modules/Administration/Ext/Administration/administration.ext.php\nManifest Installdef\n$installdefs['administration']\nImplementation\nThe following sections illustrate\u00c2\u00a0the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/modules/Administration/Ext/Administration/<file>.php to add new Administration Links in the system. The following example will add a new panel to the Administration page\u00c2\u00a0called \"Example Admin Panel\", which will contain one link called \"Example Link\":\nThe following example will create a new admin panel:\n./custom/Extension/modules/Administration/Ext/Administration/<file>.php\n<?php\n    $admin_option_defs = array();\n    $admin_option_defs['Administration']['<section key>'] = array(\n        //Icon name. Available icons are located in ./themes/default/images\n        'Administration',\n        //Link name label \n        'LBL_LINK_NAME',\n        //Link description label\n        'LBL_LINK_DESCRIPTION',\n        //Link URL - For Sidecar modules\n        'javascript:parent.SUGAR.App.router.navigate(\"<module>/<path>\", {trigger: true});',\n        //Alternatively, if you are linking to BWC modules\n        //'./index.php?module=<module>&action=<action>',\n    );\n    $admin_group_header[] = array(\n        //Section header label\n        'LBL_SECTION_HEADER',\n        //$other_text parameter for get_form_header()\n        '',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Administration/index.html"}
{"id": "bf780a13c326-1", "text": "//$other_text parameter for get_form_header()\n        '',\n        //$show_help parameter for get_form_header()\n        false,\n        //Section links\n        $admin_option_defs, \n        //Section description label\n        'LBL_SECTION_DESCRIPTION'\n    );\nNext, we will populate the panel label values:\n./custom/Extension/modules/Administration/Ext/Language/en_us.<name>.php\n<?php\n    $mod_strings['LBL_LINK_NAME'] = 'Example Link';\n    $mod_strings['LBL_LINK_DESCRIPTION'] = 'Link Description';\n    $mod_strings['LBL_SECTION_HEADER'] = 'Example Admin Panel';\n    $mod_strings['LBL_SECTION_DESCRIPTION'] = 'Section Description';\nNext, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions, compiling your customization into ./custom/modules/Administration/Ext/Administration/administration.ext.php, and the new panel will appear in the Administration section.\nModule Loadable Package\nWhen building a module loadable package, use the $installdefs['administration'] index to install the extension file.\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe base path of the file to be installed\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file in order to add the Administration file to the system. If you are utilizing a Language file, as recommended above, you must use the $installdefs['language'] index to install the Language definition. Using the $installdefs['administration'] index will automatically execute Rebuild Extensions to reflect the new Administration Links in the system.\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'administration_example',\n    'administration' => array(\n        array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Administration/index.html"}
{"id": "bf780a13c326-2", "text": "'administration' => array(\n        array(\n           'from' => '<basepath>/custom/Extension/modules/Administration/Ext/Administration/<file>.php'\n        )\n    ),\n    'language' => array(\n        array(\n            'from' => '<basepath>/custom/Extensions/modules/Administration/Ext/Language/en_us.<file>.php',\n            'to_module' => 'Administration',\n            'language' =>'en_us'\n        )\n    )\n); \nAlternatively, you may also choose to use the $installdefs['copy'] index for the Administration Link Extension file. When using this approach, you may need to manually run a repair action such as a Quick Repair and Rebuild.\nFor more information on the $installdefs['copy'] index and module-loadable packages, please refer to the Introduction to the Manifest page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Administration/index.html"}
{"id": "bab57b7c761b-0", "text": "This page refers to content that is only available in modules running in backward compatibility mode.\nLayoutdefs\nOverview\nThe Layoutdefs extension adds or overrides subpanel definitions.\nNote: This extension is only applicable to modules running in backward compatibility mode.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nModule\nSugar Variable\n$layout_defs\nExtension Directory\n./custom/Extension/modules/<module>/Ext/Layoutdefs/\nCompiled Extension File\n./custom/<module>/Ext/Layoutdefs/layoutdefs.ext.php\nManifest Installdef\n$installdefs['layoutdefs']\nImplementation\nThe following sections illustrate the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/modules/<module>/Ext/Layoutdefs/ to add Layout Definition files to the system. The following example will add a subpanel definition for a module relationship:\n./custom/Extension/modules/<module>/Ext/Layoutdefs/<file>.php\n<?php\n$layout_defs[\"<module>\"][\"subpanel_setup\"]['<subpanel key>'] = array (\n    'order' => 100,\n    'module' => '<related module>',\n    'subpanel_name' => 'default',\n    'sort_order' => 'asc',\n    'sort_by' => 'id',\n    'title_key' => 'LBL_SUBPANEL_TITLE',\n    'get_subpanel_data' => '<subpanel key>',\n    'top_buttons' => array (\n        array (\n          'widget_class' => 'SubPanelTopButtonQuickCreate',\n        ),\n        array (\n          'widget_class' => 'SubPanelTopSelectButton',\n          'mode' => 'MultiSelect',\n        ),\n    ),\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Layoutdefs/index.html"}
{"id": "bab57b7c761b-1", "text": "'mode' => 'MultiSelect',\n        ),\n    ),\n);\nPlease note that, if you are attempting to override parts of an existing subpanel definition, you should specify the exact index rather than redefining the entire array. An example of overriding the subpanel top_buttons index is shown below:\n<?php\n$layout_defs[\"<module>\"][\"subpanel_setup\"][\"<subpanel key>\"][\"top_buttons\"] = array(\n    array(\n        'widget_class' => 'SubPanelTopButtonQuickCreate',\n    ),\n);\nNext, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and compile your customizations to ./custom/modules/<module>/Ext/Layoutdefs/layoutdefs.ext.php .\nModule Loadable Package\nWhen building a module loadable package, you can use the $installdefs['layoutdefs'] index to install the extension file.\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe base path of the file to be installed\nto_module\nString\nThe key for the module where the file will be installed\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file in order to add the Layout Definition Extension file to the system. When using this approach, Sugar will automatically execute Rebuild Extensions to reflect the customizations added with the Layout definition.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'layoutdefs_Example',\n    'layoutdefs' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/modules/<module>/Ext/Layoutdefs/<file>.php',\n            'to_module' => '<module>',\n        )\n    )\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Layoutdefs/index.html"}
{"id": "bab57b7c761b-2", "text": "'to_module' => '<module>',\n        )\n    )\n);\nAlternatively, you may use the $installdefs['copy'] index to copy the file. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information on the $installdefs['copy'] index and module-loadable packages, please refer to the Introduction to the Manifest page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Layoutdefs/index.html"}
{"id": "8a280f97feb2-0", "text": "Utils\nOverview\nThe Utils extension adds functions to the global utility function list.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nApplication\nExtension Directory\n./custom/Extension/application/Ext/Utils/\nCompiled Extension File\n./custom/application/Ext/Utils/custom_utils.ext.php\nManifest Installdef\n$installdefs['utils']\nImplementation\nThe following sections illustrate the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/application/Ext/Utils/ to map a new action in the system. The following example will create a new function called 'exampleUtilFunction' that can be used throughout the system:\n./custom/Extension/application/Ext/Utils/<file>.php\n<?php\nfunction exampleUtilFunction()    '\n{\n    //logic\n}\nNext, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and your customizations will be compiled into ./custom/application/Ext/Utils/custom_utils.ext.php .\nAlternatively, functions can also be added by creating ./custom/include/custom_utils.php. This method of creating utils is still compatible but is not recommended from a best practices standpoint.\nModule Loadable Package\nWhen building a module loadable package, you can use the $installdefs['utils'] index to install the extension file.\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe base path of the file to be installed\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file in order to add the utils to the system. You should note that when using this approach, Sugar will automatically execute Rebuild Extensions to reflect the new utils in the system.\n./manifest.php\n<?php\n$manifest = array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Utils/index.html"}
{"id": "8a280f97feb2-1", "text": "./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'utils_Example',\n    'utils' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/application/Ext/Utils/<file>.php',\n        )\n    )\n);\nAlternatively, you may use the $installdefs['copy'] index to copy the file. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information on the $installdefs['copy'] index and module-loadable packages, please refer to the Introduction to the Manifest page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Utils/index.html"}
{"id": "048816b5d49d-0", "text": "This page refers to content that is only available in modules running in backward compatibility mode.\nTinyMCE\nOverview\nThe TinyMCE extension affects the TinyMCE WYSIWYG editor's configuration for backward compatible modules such as PDF Manager and Campaign Email Templates.\nTo review the default configuration for TinyMCE, please refer to the code in ./include/SugarTinyMCE.php. Sidecar's TinyMCE configuration can be edited using the Sidecar Framework and editing the htmleditable_tinymce field.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nApplication\nSugar Variable\n$defaultConfig, $buttonConfigs, $pluginsConfig\nExtension Directory\n./custom/Extension/application/Ext/TinyMCE/\nCompiled Extension File\n./custom/application/Ext/TinyMCE/tinymce.ext.php\nManifest Installdef\n$installdefs['tinymce']\nImplementation\nThe following sections illustrate the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/application/Ext/TinyMCE/ to customize the TinyMCE configuration. The following example will increase the height of the TinyMCE window, remove buttons, and remove plugins from the WYSIWYG Editor:\n./custom/Extension/application/Ext/TinyMCE/<file>.php\n<?php\n$defaultConfig['height'] = '1000';\n$buttonConfigs['default'] = array(\n    'buttonConfig' => \"bold,italic,underline,strikethrough,separator,bullist,numlist\",\n    'buttonConfig2' => \"justifyleft,justifycenter,justifyright,justifyfull\",\n    'buttonConfig3' => \"fontselect,fontsizeselect\",\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/TinyMCE/index.html"}
{"id": "048816b5d49d-1", "text": "'buttonConfig3' => \"fontselect,fontsizeselect\",\n);\n$pluginsConfig['default'] = 'advhr,preview,paste,directionality';\nNavigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and compile your customization into ./custom/application/Ext/TinyMCE/tinymce.ext.php\nModule Loadable Package\nWhen building a module loadable package, you can use the $installdefs['tinymce'] index to install the extension file.\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe base path of the file to be installed\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file, in order to add the UserPage file to the system. You should note that when using this approach Sugar will automatically execute Rebuild Extensions to reflect the changes to TinyMCE in the system.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'tinyMCE_Example',\n    'tinymce' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/application/Ext/TinyMCE/<file>.php',\n            'to_module' => 'application'\n        )\n    )\n);\nAlternatively, you may use the $installdefs['copy'] index to copy the file. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information on the $installdefs['copy'] index and module loadable packages, please refer to the Introduction to the Manifest page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/TinyMCE/index.html"}
{"id": "3735c816782b-0", "text": "EntryPointRegistry\nOverview\nThe EntryPointRegistry extension maps additional entry points\u00c2\u00a0to the system. Please note that\u00c2\u00a0entry points\u00c2\u00a0will soon be deprecated. Developers should move custom logic to endpoints.\u00c2\u00a0For more information, please refer to the Entry Points page.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nApplication\nSugar Variable\n$entry_point_registry\nExtension Directory\n./custom/Extension/application/Ext/EntryPointRegistry/\nCompiled Extension File\n./custom/application/Ext/EntryPointRegistry/entry_point_registry.ext.php\nManifest Installdef\n$installdefs['entrypoints']\nImplementation\nThe following sections illustrate the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/application/Ext/EntryPointRegistry/ to map a new entry point in the system. The following example will create a new entry point called exampleEntryPoint that will display the text, \"Hello World\":\n./custom/Extension/application/Ext/EntryPointRegistry/<file>.php\n<?php\n$entry_point_registry['exampleEntryPoint'] = array(\n    'file' => 'custom/exampleEntryPoint.php',\n    'auth' => true\n);\nNext, create the file that will contain the entry point logic. This file can be located anywhere you choose, but we recommend putting it in the custom directory. More information on custom entry points can be found on the Creating Custom Entry Points page.\n./custom/exampleEntryPoint.php\n<?php\nif(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\necho \"Hello World!\";", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/EntryPointRegistry/index.html"}
{"id": "3735c816782b-1", "text": "echo \"Hello World!\";\nNext, navigate to Admin > Repair > Quick Repair and Rebuild.The system will then rebuild the extensions and compile your customization into\u00c2\u00a0./custom/application/Ext/EntryPointRegistry/entry_point_registry.ext.php\u00c2\u00a0\nModule Loadable Package\nWhen building a module loadable package, you can use the $installdefs['entrypoints'] index to install the extension file.\u00c2\u00a0\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe base path of the file to be installed.\u00c2\u00a0\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file, in order to add the Entry Point Extension file to the system. You should note that when using this approach, you still need to use the $installdefs['copy'] index for the entry point's logic file, however Sugar will automatically execute Rebuild Extensions\u00c2\u00a0to reflect the new Entry Point in the system.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'entryPoint_Example',\n    'entrypoints' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/application/Ext/EntryPointRegistry/<file>.php'\n        )\n    ),\n    'copy' => array(\n        array(\n            'from' => '<basepath>/Files/custom/exampleEntryPoint.php',\n            'to' => 'custom/exampleEntryPoint.php'\n        )\n    )\n);\nAlternatively, you may use the $installdefs['copy'] index for the Entry Point Extension file. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild.\u00c2\u00a0For more information on the $installdefs['copy'] index and module loadable packages, please refer to the Introduction to the Manifest page.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/EntryPointRegistry/index.html"}
{"id": "3735c816782b-2", "text": "Last modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/EntryPointRegistry/index.html"}
{"id": "89ada560c2b6-0", "text": "LogicHooks\nOverview\nThe LogicHooks extension adds actions to specific events such as, for example, before saving a bean. For more information on logic hooks in Sugar, please refer to the Logic Hooks\u00c2\u00a0documentation.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nAll - Application & Module\nSugar Variable\n$hook_array\nExtension Directory\nApplication - ./custom/Extension/application/Ext/LogicHooks/\nModule -\u00c2\u00a0./custom/Extension/modules/<module>/Ext/LogicHooks/\nCompiled Extension File\nApplication - ./custom/application/Ext/LogicHooks/logichooks.ext.php\nModule -\u00c2\u00a0./custom/modules/<module>/Ext/LogicHooks/logichooks.ext.php\nManifest Installdef\n$installdefs['hookdefs']\nImplementation\nThe following sections illustrate the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/application/Ext/LogicHooks/ to add a new logic hook to the application. The following example will create a new before_save logic hook that executes for all modules:\n./custom/Extension/application/Ext/LogicHooks/<file>.php\n<?php\n    $hook_array['before_save'][] = Array(\n        1, \n        'Custom Logic', \n        'custom/application_hook.php', \n        'ApplicationHookConsumer', \n        'before_method'\n    );\nNext, create the hook class:\n./custom/application_hook.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class ApplicationHookConsumer\n    {\n        function before_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/LogicHooks/index.html"}
{"id": "89ada560c2b6-1", "text": "{\n            //logic\n        }\n    }\n?>\nFinally, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and the customizations will be compiled into ./custom/application/Ext/LogicHooks/logichooks.ext.php. Your logic hook will run before saving records in any module.\nModule Loadable Package\nWhen building a module loadable package, you can use the $installdefs['hookdefs'] index to install the extension file.\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe basepath of the file to be installed.\nto_module\nString\nThe key of the module the file is to be installed to.\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file in order to add the Action View Map file to a specific module. You should note that when using this approach, you still need to use the $installdefs['copy'] index for the hook class file, however Sugar will automatically execute Rebuild Extensions to reflect the new logic hook in the system.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'actionView_example',\n    'hookdefs' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/application/Ext/LogicHooks/<file>.php',\n            'to_module' => 'application',\n        )\n    ),\n    'copy' => array(\n        array(\n            'from' => '<basepath>/Files/custom/application_hook.php',\n            'to' => 'custom/application_hook.php',\n        ),\n    )\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/LogicHooks/index.html"}
{"id": "89ada560c2b6-2", "text": "'to' => 'custom/application_hook.php',\n        ),\n    )\n);\nAlternatively, you may use the $installdefs['copy'] index to copy the file. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information on the $installdefs['copy'] index and module-loadable packages, please refer to the Introduction to the Manifest page.\nAlternative Installdef\nAlthough not recommended, you could utilize the $installdefs['logic_hooks'] index to deploy a logic hook to the system. Please note that there are a couple caveats to this installation method:\nThe $installdefs['logic_hooks'] index method only works for module-based logic hooks.\nThe $installdefs['logic_hooks'] index method installs to ./custom/modules/<module>/logic_hooks.php, which is not part of the Extension framework.\nProperties\nName\nType\nDescription\nmodule\nString\nThe key of the module for the logic hook to be installed to.\nhook\nString\nThe type of logic hook to be installed.\norder\nInteger\nThe number in which the logic hook should run.\ndescription\nString\nA description of the logic hook to be installed.\nfile\nString\nThe file path which contains the logic hook class.\nclass\nString\nThe class which houses the logic hook functionality.\nfunction\nString\nThe function the logic hook will execute.\nThe example below will demonstrate the $installdefs['logic_hooks'] index in the ./manifest.php file, in order to add an after save logic hook to a specific module. You should note that when using this approach, you still need to use the $installdefs['copy'] index for the hook class file.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'actionView_example',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/LogicHooks/index.html"}
{"id": "89ada560c2b6-3", "text": ");\n$installdefs = array(\n    'id' => 'actionView_example',\n    'logic_hooks' => array(\n        array(\n            'module' => '<module>',\n            'hook' => 'after_save',\n            'order' => 1,\n            'description' => 'Example After Save LogicHook',\n            'file' => 'custom/modules/<module>/module_hook.php',\n            'class' => '<module>HookConsumer'\n            'function' => 'after'\n        )\n    ),\n    'copy' => array(\n        array(\n            'from' => '<basepath>/Files/custom/modules/<module>/module_hook.php',\n            'to' => 'custom/modules/<module>/module_hook.php',\n        ),\n    )\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/LogicHooks/index.html"}
{"id": "710498b8817c-0", "text": "Sidecar\nOverview\nThe Sidecar extension installs metadata files to their appropriate directories.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nModule\nSugar Variable\n$viewdefs\nExtension Directory\n./custom/Extension/modules/<module>/Ext/clients/<client>/<type>/<subtype>/\nCompiled Extension File\n./custom/<module>/Ext/clients/<client>/<type>/<subtype>/<subtype>.ext.php\nManifest Installdef\n$installdefs['sidecar']\nImplementation\nThe following sections illustrate the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/modules/<module>/Ext/clients/<client>/<type>/<subtype>/ to append the metadata extensions. The example below demonstrates how to add a new subpanel to a specific module:\n./custom/Extension/modules/<module>/Ext/clients/base/layouts/subpanels/<file>.php\n<?php\n$viewdefs['<module>']['base']['layout']['subpanels']['components'][] = array(\n    'layout' => 'subpanel',\n    'label' => 'LBL_RELATIONSHIP_TITLE',\n    'context' => array(\n        'link' => '<link_name>',\n    )\n);\nNext, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and compile your customization into ./custom/modules/<module>/Ext/clients/base/layouts/subpanels/subpanels.ext.php\nModule Loadable Package\nWhen building a module loadable package, you can use the $installdefs['sidecar'] index to install the metadata file.\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe base path of the file to be installed", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Sidecar/index.html"}
{"id": "710498b8817c-1", "text": "Name\nType\nDescription\nfrom\nString\nThe base path of the file to be installed\nNote:\u00c2\u00a0When adding the file to a module loadable package, its 'from' path must be formatted as clients/<client>/<type>/<subtype>/<file>.php for Sugar to recognize the installation location.\nto_module\nString\nThe key for the module where the file will be installed\nIf not populated, 'application' is used\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file in order to add the metadata file to a specific module. When using this approach, Sugar will automatically execute Rebuild Extensions and Metadata Rebuild to reflect your changes in the system.\n./manifest.php\n<?php\n$manifest = array( \n    ... \n); \n$installdefs = array (\n    'id' => 'sidecar_example',\n    'sidecar' => array(\n        array(\n            'from' => '<basepath>/Files/custom/<module>/clients/base/layouts/subpanels/<file>.php',\n            'to_module' => '<module>',\n        ),\n    ),\n);\nAlternatively, you may use the $installdefs['copy'] index to copy the file. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information on the $installdefs['copy'] index and module-loadable packages, please refer to the Introduction to the Manifest page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Sidecar/index.html"}
{"id": "442b1663ea1d-0", "text": "JSGroupings\nOverview\nThe JSGroupings extension\u00c2\u00a0allows for additional JavaScript grouping files to be created or added to existing groupings within the system.\nJSGroupings are file packages containing one or more minified JavaScript libraries. The groupings enhance system performance by reducing the number of JavaScript files that need to be downloaded for a given page. Some examples of JSGroupings in Sugar are sugar_sidecar.min.js, which contains the Sidecar JavaScript files, and sugar_grp1.js, which contains the base JavaScript files.\nYou can find all of the groups listed in ./jssource/JSGroupings.php. Each group is loaded only when needed by a direct call (e.g., from a TPL file). For example, sugar_grp1.js is loaded for almost all Sugar functions, while sugar_grp_yui_widgets.js will usually be loaded for just record views.\nTo load a JSGroupings file for a custom module, simply add a new JSGrouping and then include the JavaScript file for your custom handlebars template. You can also append to an existing grouping, such as ./include/javascript/sugar_grp7.min.js, to include the code globally.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nApplication\nSugar Variable\n$js_groupings\nExtension Directory\n./custom/Extension/application/Ext/JSGroupings/\nCompiled Extension File\n./custom/application/Ext/JSGroupings/jsgroups.ext.php\nManifest Installdef\n$installdefs['jsgroups']\u00c2\u00a0\nImplementation\nThe following sections illustrate the various ways to implement a customization to a Sugar instance.\nFile System\nCreating New JSGroupings", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/JSGroupings/index.html"}
{"id": "442b1663ea1d-1", "text": "File System\nCreating New JSGroupings\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/application/Ext/JSGroupings/ to add or append Javascript to JSGroupings in the system. The following example will add a new JSGrouping file to the system:\n./custom/Extension/application/Ext/JSGroupings/<file>.php\n<?php\n//creates the file cache/include/javascript/newGrouping.js\n$js_groupings[] = $newGrouping = array(\n    'custom/file1.js' => 'include/javascript/newGrouping.js',\n    'custom/file2.js' => 'include/javascript/newGrouping.js',\n);\nNext, create the Javascript files that will be grouped as specified in the JSGrouping definition above:\n./custom/file1.js\nfunction one(){\n    //logic\n}\n./custom/file2.js\nfunction two(){\n    //logic\n}\nNext, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and compile your customization into ./custom/application/Ext/JSGroupings/jsgroups.ext.php.\nFinally, navigate to Admin > Repair > Rebuild JS Grouping Files. This will create the grouping file in the cache directory as specified:\n./cache/include/javascript/newGrouping.js\nfunction one(){}/* End of File custom/file1.js */function two(){}/* End of File custom/file2.js */\nAppending to Existing JSGroupings\nIn some situations, you may find that you need to append your own JavaScript to a core Sugar JSGrouping. Similarly to creating a new JSGrouping, to append to a core JSGrouping you can create a new PHP file in ./custom/Extension/application/Ext/JSGroupings/. The example below demonstrates how to add the file ./custom/file1.js to ./cache/include/javascript/sugar_grp7.min.js.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/JSGroupings/index.html"}
{"id": "442b1663ea1d-2", "text": "./custom/Extension/application/Ext/JSGroupings/<file>.php\n<?php\n//Loop through the groupings to find grouping file you want to append to\nforeach ($js_groupings as $key => $groupings)\n{\n    foreach  ($groupings as $file => $target)\n    {\n    \t//if the target grouping is found\n        if ($target == 'include/javascript/sugar_grp7.min.js')\n        {\n            //append the custom JavaScript file\n            $js_groupings[$key]['custom/file1.js'] = 'include/javascript/sugar_grp7.min.js';\n        }\n        break;\n    }\n}\nNext, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and compile your customization into ./custom/application/Ext/JSGroupings/jsgroups.ext.php.\nModule Loadable Package\nWhen building a module loadable package, you can use the $installdefs['jsgroups'] index to install the extension file.\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe basepath of the file to be installed\nto_module\nString\nThe key for the module where the file will be installed\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file to add the JSGrouping Extension file to the system. When using this approach, you still need to use the $installdefs['copy'] index for the custom JavaScript files you are adding to JSGroupings. Sugar will automatically execute Rebuild Extensions to reflect the new JSGrouping, however, you will still need to navigate to Admin > Repair > Rebuild JS Grouping Files, to create the grouping file in the cache directory.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/JSGroupings/index.html"}
{"id": "442b1663ea1d-3", "text": "$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'jsGroupings_Example',\n    'jsgroups' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/application/Ext/JSGroupings/<file>.php',\n            'to_module' => 'application',\n        )\n    ),\n    'copy' => array(\n        array(\n            'from' => '<basepath>/Files/custom/file1.js',\n            'to' => 'custom/file1.js'\n        ),\n        array( \n            'from' => '<basepath>/Files/custom/file2.js',\n            'to' => 'custom/file2.js' \n        )\n    )\n);\nAlternatively, you may use the\u00c2\u00a0$installdefs['copy']\u00c2\u00a0index for the JSGrouping Extension file. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information\u00c2\u00a0on the\u00c2\u00a0$installdefs['copy']\u00c2\u00a0index and module-loadable packages, please refer to the\u00c2\u00a0Introduction to the Manifest\u00c2\u00a0page.\nConsiderations\nThe grouping path you specify will be created in the cache directory.\nIf you wish to add a grouping that contains a file that is part of another group already, add a '.' after <file>.js to make the element key unique.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/JSGroupings/index.html"}
{"id": "baf64b63b48f-0", "text": "Include\nOverview\nThe Modules extension maps additional modules in the system, typically when Module Builder deploys a module.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nApplication\nSugar Variable\n$beanList, $beanFiles, $moduleList\nExtension Directory\n./custom/Extension/application/Ext/Include/\nCompiled Extension File\n./custom/application/Ext/Include/modules.ext.php\nManifest Installdef\n$installdefs['beans']\nImplementation\nThe following sections illustrate the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/application/Ext/Include/ to register a new module in the system. This extension is normally used when deploying custom modules. The example below shows what this file will look like after a module is deployed:\n./custom/Extension/application/Ext/Include/<file>.php\n<?php\n$beanList['cust_module'] = 'cust_module';\n$beanFiles['cust_module'] = 'modules/cust_module/cust_module.php';\n$moduleList[] = 'cust_module';\nNext, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and compile your customization into ./custom/application/Ext/Include/modules.ext.php.\nModule Loadable Package\nWhen building a module loadable package, you can use the $installdefs['beans'] index to install the extension file.\nInstalldef Properties\nName\nType\nDescription\nmodule\nString\nThe key of the module to be installed\nclass\nString\nThe class name of the module to be installed\npath\nString\nThe path to the module's class\ntab\nBoolean\nWhether or not the module will have a navigation tab (defaults to false)", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Include/index.html"}
{"id": "baf64b63b48f-1", "text": "tab\nBoolean\nWhether or not the module will have a navigation tab (defaults to false)\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file, in order to add a custom module to the system. When using this approach, you still need to use the $installdefs['copy'] index for Module directory, however, Sugar will automatically execute the database table creation process, relationship table creation process, as well as Rebuild Extensions to reflect the new Module in the system.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'Beans_Example',\n    'beans' => array(\n        array(\n            'module' => 'cust_Module',\n            'class' => 'cust_Module',\n            'path' => 'modules/cust_Module/cust_Module.php',\n            'tab' => true\n        )\n    ),\n    'copy' => array(\n        array(\n            'from' => '<basepath>/Files/modules/cust_Module',\n            'to' => 'modules/cust_Module'\n        )\n    )\n);\nAlternatively, you may use the\u00c2\u00a0$installdefs['copy']\u00c2\u00a0index for copying the Modules definition file into the ./custom/Extension/application/Ext/Include/\u00c2\u00a0directory. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information\u00c2\u00a0on the\u00c2\u00a0$installdefs['copy']\u00c2\u00a0index and module loadable packages, please refer to the\u00c2\u00a0Introduction to the Manifest\u00c2\u00a0page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Include/index.html"}
{"id": "226537683493-0", "text": "This page refers to content that is only available in modules running in backward compatibility mode.\nWirelessModuleRegistry\nOverview\nThe WirelessModuleRegistry extension adds modules to the available modules for mobile.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nApplication\nSugar Variable\n$wireless_module_registry\nExtension Directory\n./custom/Extension/application/Ext/WirelessModuleRegistry/\nCompiled Extension File\n./custom/application/Ext/WirelessModuleRegistry/wireless_module_registry.ext.php\nManifest Installdef\n$installdefs['wireless_modules']\nImplementation\nThe following sections illustrate the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/application/Ext/WirelessModuleRegistry/ to add modules to the list of available modules for mobile. The following example will add a new module, 'cust_module', to the list of available modules for mobile:\n./custom/Extension/application/Ext/WirelessModuleRegistry/<file>.php\n<?php \n$wireless_module_registry['cust_module'] = array( \n    //enables/disables record creation \n    'disable_create' => false, \n);\nNext, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and compile your customization into ./custom/application/Ext/WirelessModuleRegistry/wireless_module_registry.ext.php.\nModule Loadable Package\nWhen building a module loadable package, you can use the $installdefs['wireless_modules'] index to install the extension file.\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe base path of the file to be installed.\nto_module\nString\nThe key of the module the file is to be installed to.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/WirelessModuleRegistry/index.html"}
{"id": "226537683493-1", "text": "to_module\nString\nThe key of the module the file is to be installed to.\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file in order to add the Wireless Module Registry file to the system. You should note that when using this approach, Sugar will automatically execute Rebuild Extensions to reflect the new module in the mobile application.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'wirelessModules_Example',\n    'wireless_modules' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/application/Ext/WirelessModuleRegistry/<file>.php',\n            'to_module' => 'application',\n        )\n    )\n);\nAlternatively, you may use the $installdefs['copy'] index to copy the file. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information on the $installdefs['copy'] index and module-loadable packages, please refer to the Introduction to the Manifest page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/WirelessModuleRegistry/index.html"}
{"id": "626f6f5eec3c-0", "text": "Extensions\nOverview\nThis extension\u00c2\u00a0allows for developers to create custom extensions within the framework. Custom extensions are used alongside the extensions found in ./ModuleInstaller/extensions.php.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nApplication\nSugar Variable\n$extensions\nExtension Directory\n./custom/Extension/application/Ext/Extensions/\nCompiled Extension File\n./custom/application/Ext/Extensions/extensions.ext.php\nManifest Installdef\n$installdefs['extensions']\nParameters\nsection : Section name in the manifest file\nextdir : The directory containing the extension files\nfile : The name of the file where extension files are compiled into\nmodule : Determines how the framework will interpret the extension (optional)\n<Empty> : Will enable the extension for all modules\nExt\u00c2\u00a0: ./custom/Extension/modules/<module>/Ext/<Custom Extension>/\nExt File : ./custom/modules/<module>/Ext/<Extension Name>.ext.php\n<Specific Module> : Will enable the extension for the specified module\nExt Directory : ./custom/Extension/modules/<Specific Module>/Ext/<Custom Extension>/\nExt File : ./custom/modules/<Specific Module>/Ext/<Extension Name>.ext.php\nApplication : enables the extension for application only\nExt Directory : ./custom/Extension/application/Ext/<Custom Extension>/\nExt File : ./custom/application/Ext/<Custom Extension>/<Extension Name>.ext.php\nImplementation\nThe following sections illustrate the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/application/Ext/Extensions/ to map a new extension in the system. The following example will create a new extension called \"example\", which is only enabled for \"application\":\n./custom/Extension/application/Ext/Extensions/<file>.php\n<?php", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Extension/index.html"}
{"id": "626f6f5eec3c-1", "text": "./custom/Extension/application/Ext/Extensions/<file>.php\n<?php\n$extensions['example'] = array(\n    'section' => 'example',\n    'extdir' => 'Example',\n    'file' => 'example.ext.php',\n    'module' => 'application' //optional paramater\n);\nNext, navigate to Admin > Repair > Quick Repair and Rebuild. The system will rebuild the extensions and compile your customization into ./custom/application/Ext/Extensions/extensions.ext.php. Then you will be able to add your own extension files in \u00c2\u00a0./custom/Extension/application/Ext/Example/.\nModule Loadable Package\nWhen building a module loadable package, you can use the $installdefs['extensions'] index to install the extension file.\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe base path of the file to be installed\nThe example below will demonstrate the proper install definition that should be used in the ./manifest.php file in order to add the Extension file to the system. You should note that when using this approach, Sugar will automatically execute Rebuild Extensions to reflect the new Extension in the system.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'customExtension_Example',\n    'extensions' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/application/Ext/Extensions/<file>.php'\n        )\n    )\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Extension/index.html"}
{"id": "626f6f5eec3c-2", "text": ")\n    )\n);\nAlternatively, you may use the\u00c2\u00a0$installdefs['copy']\u00c2\u00a0index for the Extension file. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information\u00c2\u00a0on the\u00c2\u00a0$installdefs['copy']\u00c2\u00a0index and module-loadable packages, please refer to the\u00c2\u00a0Introduction to the Manifest\u00c2\u00a0page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Extension/index.html"}
{"id": "6525ee727055-0", "text": "UserPage\nOverview\nThe UserPage extension adds sections to the User Management view.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nModule: Users\nExtension Directory\n./custom/Extension/modules/Users/Ext/UserPage/\nCompiled Extension File\n./custom/Users/Ext/UserPage/userpage.ext.php\nManifest Installdef\n$installdefs['user_page']\nImplementation\nThe following sections illustrate the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/modules/Users/Ext/UserPage/ to add custom elements to the User page. The following example will add a custom table to the Users module's detail view:\n./custom/Extension/modules/Users/Ext/UserPage/<file>.php\n<?php\n$HTML=<<<HTML\n    <table cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" border=\"0\" class=\"list view\">\n        <tbody>\n            <tr height=\"20\">\n                <th scope=\"col\" width=\"15%\">\n                    <slot>Header</slot>\n                </th>\n            </tr>\n            <tr height=\"20\" class=\"oddListRowS1\">\n                <td scope=\"row\" valign=\"top\">\n                    Content\n                </td>\n            </tr>\n        </tbody>\n    </table>\nHTML;\n    echo $HTML;\nNavigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and compile your customization into ./custom/modules/Users/Ext/UserPage/userpage.ext.php\nModule Loadable Package\nWhen building a module loadable package, you can use the $installdefs['user_page'] index to install the extension file.\nInstalldef Properties\nName\nType\nDescription", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/UserPage/index.html"}
{"id": "6525ee727055-1", "text": "Installdef Properties\nName\nType\nDescription\nfrom\nString\nThe base path of the file to be installed\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file in order to add the UserPage file to the system. When using this approach, Sugar will automatically execute Rebuild Extensions to reflect the changes to the User view in the system.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'userPage_Example',\n    'user_page' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/modules/Users/Ext/UserPage/<file>.php',\n        )\n    )\n);\nAlternatively, you may use the $installdefs['copy'] index to copy the file. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information on the $installdefs['copy'] index and module-loadable packages, please refer to the Introduction to the Manifest page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/UserPage/index.html"}
{"id": "9c4b668082b0-0", "text": "Vardefs\nOverview\nThe Vardefs extension adds or overrides system vardefs, which provide the Sugar application with information about SugarBeans.\nFor more information on vardefs in Sugar, please refer to the Vardefs documentation .\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nModule\nSugar Variable\n$dictionary\nExtension Directory\n./custom/Extension/modules/<module>/Ext/Vardefs/\nCompiled Extension File\n./custom/<module>/Ext/Vardefs/vardefs.ext.php\nManifest Installdef\n$installdefs['vardefs']\nImplementation\nThe following sections illustrate the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/modules/<module>/Ext/Vardefs/ to edit or add vardefs to a module in the system.\nThe most common use of the Vardef extension is to alter the attributes of an existing vardef. To do this,avoid redefining the entire vardef and instead update the specific index you want to change. The following example updates the Required property on the Name field in a module:\n./custom/Extension/modules/<module>/Ext/Vardefs/<file>.php\n$dictionary['<module>']['fields']['name']['required'] = false;\nNext, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and your customizations will be compiled into ./custom/modules/<module>/Ext/Vardefs/vardefs.ext.php .\nNotice\u00c2\u00a0 Never specify vardefs for a module under another module's extension path. For example, do not specify $dictionary['Accounts']['fields']['name']['required'] = false under ./custom/Extension/modules/Contacts/Ext/Vardefs/. Doing so will result in unexpected behavior within the system.\nModule Loadable Package", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Vardefs/index.html"}
{"id": "9c4b668082b0-1", "text": "Module Loadable Package\nWhen building a module loadable package, you can use the $installdefs['vardefs'] index to install the extension file.\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe base path of the file to be installed\nto_module\nString\nThe key for the module where the file will be installed\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file in order to add the Vardefs file to a specific module. You should note that when using this approach Sugar will automatically execute Rebuild Extensions to reflect the vardef changes in the system.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'vardefs_Example',\n    'vardefs' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/modules/<module>/Ext/Vardefs/<file>.php',\n            'to_module' => '<module>',\n        )\n    )\n);\nAlternatively, you may use the $installdefs['copy'] index to copy the file. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information on the $installdefs['copy'] index and module-loadable packages, please refer to the Introduction to the Manifest page.\nCreating Custom Fields\nIf your goal is to manually create a custom field on an instance, you should be using the Module Installer to create the field. This can be used both for an installer package and programmatically. An example of creating a field from a module loadable package can be found under Package Examples in the article, Creating an Installable Package that Creates New Fields. An example of programmatically creating a field can be found in the Manually Creating Custom Fields section of the Module Vardefs documentation.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Vardefs/index.html"}
{"id": "9c4b668082b0-2", "text": "Last modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Vardefs/index.html"}
{"id": "1950f71917b3-0", "text": "ScheduledTasks\nOverview\nThe ScheduledTasks extension adds custom functions that can be used by scheduler jobs. For more information about schedulers in Sugar, please refer to the Schedulers documentation.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nModule: Schedulers\nSugar Variable\n$job_strings\nExtension Directory\n./custom/Extension/modules/Schedulers/Ext/ScheduledTasks/\nCompiled Extension File\n./custom/Schedulers/Ext/ScheduledTasks/scheduledtasks.ext.php\nManifest Installdef\n$installdefs['scheduledefs']\nImplementation\nThe following sections illustrate\u00c2\u00a0the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/modules/Schedulers/Ext/ScheduledTasks/ to add a new Scheduler Task to the system. The following example will create a new Scheduler Task 'example_job':\n./custom/Extension/modules/Schedulers/Ext/ScheduledTasks/<file>.php\n<?php\n$job_strings[] = 'exampleJob';\nfunction exampleJob()\n{\n    //logic here\n    //return true for completed\n    return true;\n}\nNext, create the Language file for the scheduler so that the job properly displays in Admin > Schedulers:\n./custom/Extension/modules/Schedulers/Ext/Language/<language>.<file>.php\n<?php\n//Label will be LBL_[upper case function name]\n$mod_strings['LBL_EXAMPLEJOB'] = 'Example Job';\nNext, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and the customizations will be compiled into ./custom/modules/Schedulers/Ext/ScheduledTasks/scheduledtasks.ext.php\nModule Loadable Package", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/ScheduledTasks/index.html"}
{"id": "1950f71917b3-1", "text": "Module Loadable Package\nWhen building a module loadable package, you can use the $installdefs['scheduledefs'] index to install the extension file.\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe basepath of the file to be installed\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file in order to add the custom Scheduler definition file to the system. When using this approach, Sugar will automatically execute Rebuild Extensions to reflect the new Scheduler in the system.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'actionView_example',\n    'scheduledefs' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/modules/Scheduler/Ext/ScheduledTasks/<file>.php',\n        )\n    ),\n    'language' => array(\n        array(\n            'from' =>'<basepath>/Files/custom/Extension/modules/Schedulers/Ext/Language/<file>.php',\n            'to_module' => 'Schedulers',\n            'language' => 'en_us'\n        )\n    )\n);\nAlternatively, you may use the $installdefs['copy'] index to copy the file. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information on the $installdefs['copy'] index and module-loadable packages, please refer to the Introduction to the Manifest page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/ScheduledTasks/index.html"}
{"id": "10310a56fe2c-0", "text": "Dependencies\nOverview\nDependencies create dependent actions for fields and forms that can leverage more complicated logic.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nModule\nSugar Variable\n$dependencies\nExtension Directory\n./custom/Extension/modules/<module>/Ext/Dependencies/\nCompiled Extension File\n./custom/modules/<module>/Ext/Dependencies/deps.ext.php\nManifest Installdef\n$installdefs['dependencies']\nImplementation\nThe following sections illustrate the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/modules/<module>/Ext/Dependencies/<file>.php to map a new dependency in the system. The following example will create a new required field dependency on a module that is evaluated upon editing a record:\n./custom/Extension/modules/<module>/Ext/Dependencies/<file>.php\n<?php\n$dependencies['<module>']['<unique name>'] = array(\n    'hooks' => array(\"edit\"),\n    //Trigger formula for the dependency. Defaults to 'true'.\n    'trigger' => 'true',\n    'triggerFields' => array('<trigger field>'),\n    'onload' => true,\n    //Actions is a list of actions to fire when the trigger is true\n    'actions' => array(\n        array(\n            'name' => 'SetRequired', //Action type\n            //The parameters passed in depend on the action type\n            'params' => array(\n                'target' => '<field>',\n                'label'  => '<field label>', //normally <field>_label\n                'value' => 'equal($<trigger field>, \"Closed\")', //Formula\n            ),\n        ),\n    ),\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Dependencies/index.html"}
{"id": "10310a56fe2c-1", "text": "),\n        ),\n    ),\n);\nNext, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions, compiling your customization into./custom/modules/<module>/Ext/Dependencies/deps.ext.php, and the dependency will be in place.\nModule Loadable Package\nWhen building a module loadable package, you can use the $installdefs['dependencies'] index to install the extension file.\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe base path of the file\nto_module\nString\nThe key for the module where the file will be installed\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file in order to add the Dependency file to a specific module. You should note that when using this approach, Sugar will automatically execute Rebuild Extensions to reflect the new Dependency in the system.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'dependency_example',\n    'dependencies' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/modules/<module>/Ext/Dependencies/<file>.php',\n            'to_module' => '<module>',\n        )\n    )\n);\nAlternatively, you may use the $installdefs['copy'] index for the Dependency Extension file. When using this approach, you may need to manually run a repair action such as a Quick Repair and Rebuild.\nFor more information on the $installdefs['copy'] index and module-loadable packages, please refer to the Introduction to the Manifest\u00c2\u00a0page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Dependencies/index.html"}
{"id": "00cb7fd0fcfc-0", "text": "This page refers to content that is only available in modules running in backward compatibility mode.\nActionViewMap\nOverview\nThe ActionViewMap extension maps additional actions for a module.\nNote: Actions that apply to modules running in backward compatibility mode\u00c2\u00a0are mapped in ./custom/modules/<module>/controller.php.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nModule\nSugar Variable\n$action_view_map\nExtension Directory\n./custom/Extension/modules/<module>/Ext/ActionViewMap/\nCompiled Extension File\n./custom/<module>/Ext/ActionViewMap/action_view_map.ext.php\nManifest Installdef\n$installdefs['action_view_map']\nImplementation\nThe following sections illustrate\u00c2\u00a0the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/modules/<module>/Ext/ActionViewMap/ to map a new view in the system. The following example will map a new action called 'example' to the 'example' view:\n./custom/Extension/modules/<module>/Ext/ActionViewMap/<file>.php\n<?php\n$action_view_map['example'] = 'example';\n./custom/modules/<module>/views/view.example.php\n<?php\nif(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nrequire_once('include/MVC/View/views/view.detail.php');\nclass <module>ViewExample extends ViewDetail\n{\n    function <module>ViewExample()\n    {\n        parent::ViewDetail();\n    }\n    function display()\n    {\n        echo 'Example View';\n    }\n}\n?>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/ActionViewMap/index.html"}
{"id": "00cb7fd0fcfc-1", "text": "{\n        echo 'Example View';\n    }\n}\n?>\nNext, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and compile your customization into ./custom/modules/<module>/Ext/ActionViewMap/action_view_map.ext.php.\nModule Loadable Package\nWhen building a module-loadable package, use the $installdefs['action_view_map'] index to install the extension file.\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe basepath of the file\nto_module\nString\nThe key for the module where the file will be installed\nThe example below demonstrates the proper install definition for\u00c2\u00a0the ./manifest.php file in order to add the Action View Map file to a specific module. You should note that when using this approach, you still need to use the $installdefs['copy'] index for the View file, however, Sugar will automatically execute Rebuild Extensions to reflect the new Action View in the system.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'actionView_example',\n    'action_view_map' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/modules/<module>/Ext/ActionViewMap/<file>.php',\n            'to_module' => '<module>',\n        )\n    ),\n    'copy' => array(\n        array(\n            'from' => '<basepath>/Files/custom/modules/<module>/views/view.example.php',\n            'to' => 'custom/modules/<module>/views/view.example.php',\n        ),\n    )\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/ActionViewMap/index.html"}
{"id": "00cb7fd0fcfc-2", "text": "),\n    )\n);\nAlternatively, you may use the $installdefs['copy'] index for the Action View Map Extension file. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild.\nFor more information on\u00c2\u00a0module-loadable packages, please refer to the Introduction to the Manifest\u00c2\u00a0page\u00c2\u00a0.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/ActionViewMap/index.html"}
{"id": "7789ee94fa4a-0", "text": "Application Schedulers\nOverview\nApplication Scheduler extensions add custom functions that can be used by scheduler jobs.\nNote: This Extension is a duplicate of the ScheduledTasks extension, which typically places Scheduled Tasks in the Schedulers directory.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nApplication\nSugar Variable\n$job_strings\nExtension Directory\n./custom/Extension/application/Ext/ScheduledTasks/\nCompiled Extension File\n./custom/application/Ext/ScheduledTasks/scheduledtasks.ext.php\nManifest Installdef\n$installdefs['appscheduledefs']\nImplementation\nThe following sections illustrates the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/application/Ext/ScheduledTasks/ to add a new Scheduler Task to the system. The following example will create a new Scheduler Task 'example_job':\n./custom/Extension/application/Ext/ScheduledTasks/<file>.php\n<?php\n$job_strings[] = 'exampleJob';\nfunction exampleJob()\n{\n    //logic here\n    //return true for completed\n    return true;\n}\nNext create the Language file for the Scheduler, so that the Job properly displays in Admin > Schedulers section:\n./custom/Extension/modules/Schedulers/Ext/Language/<language>.<file>.php\n<?php\n//Label will be LBL_[upper case function name]\n$mod_strings['LBL_EXAMPLEJOB'] = 'Example Job';\nNext, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and the customizations will be compiled into ./custom/application/Ext/ScheduledTasks/scheduledtasks.ext.php\nModule Loadable Package", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Application_Schedulers/index.html"}
{"id": "7789ee94fa4a-1", "text": "Module Loadable Package\nWhen building a module loadable package, you can use the $installdefs['appscheduledefs'] index to install the extension file.\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe base path of the file to be installed.\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file in order to add the custom Scheduler definition file to the system. You should note that, when using this approach, Sugar will automatically execute Rebuild Extensions to reflect the new scheduler in the system.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'appScheduledTasks_example',\n    'appscheduledefs' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/application/Ext/ScheduledTasks/<file>.php',\n        )\n    ),\n    'language' => array(\n        array(\n            'from' =>'<basepath>/Files/custom/Extension/modules/Schedulers/Ext/Language/<file>.php',\n            'to_module' => 'Schedulers',\n            'language' => 'en_us'\n        )\n    )\n);\nAlternatively, you may use the $installdefs['copy'] index for the Scheduled Task Extension file. When using this approach, you may need to manually run a repair action such as a Quick Repair and Rebuild.\nFor more information about the $installdefs['copy'] index and module-loadable packages, please refer to the Introduction to the Manifest page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Application_Schedulers/index.html"}
{"id": "a5a86354da8d-0", "text": "This page refers to content that is only available in modules running in backward compatibility mode.\nActionReMap\nOverview\nThe ActionReMap extension maps new actions to existing actions. This extension is only applicable to modules running in backward compatibility mode.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nModule\nSugar Variable\n$action_remap\nExtension Directory\n./custom/Extension/modules/<module>/Ext/ActionReMap/\nCompiled Extension File\n./custom/<module>/Ext/ActionReMap/action_remap.ext.php\nManifest Installdef\n$installdefs['action_remap']\nImplementation\nThe following sections illustrate\u00c2\u00a0the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the file system, you can create a file in \u00c2\u00a0./custom/Extension/modules/<module>/Ext/ActionReMap/ to map an action to another defined action. The following example will map the action 'example' to 'detailview':\n./custom/Extension/modules/<module>/Ext/ActionReMap/<file>.php\n<?php\n$action_remap['example'] = 'detailview';\nNext, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and compile your customization into\u00c2\u00a0./custom/modules/<module>/Ext/ActionReMap/action_remap.ext.php.\nModule Loadable Package\nWhen building a module loadable package, you can use the $installdefs['action_remap'] index to install the extension file.\u00c2\u00a0\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe basepath of the file to be installed\nto_module\nString\nThe key for the module where the file will be installed", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/ActionReMap/index.html"}
{"id": "a5a86354da8d-1", "text": "to_module\nString\nThe key for the module where the file will be installed\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file in order to add the Action Remap file to a specific module. You should note that when using this approach, Sugar will automatically execute Rebuild Extensions\u00c2\u00a0to reflect your changes in the system.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'ActionRemap_Example',\n    'action_remap' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/modules/<module>/Ext/ActionReMap/<file>.php',\n            'to_module' => '<module>',\n        )\n    )\n);\nAlternatively, you may use the\u00c2\u00a0$installdefs['copy']\u00c2\u00a0index. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information\u00c2\u00a0on the\u00c2\u00a0$installdefs['copy']\u00c2\u00a0index and module-loadable packages, please refer to the\u00c2\u00a0Introduction to the Manifest\u00c2\u00a0page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/ActionReMap/index.html"}
{"id": "1211901a17af-0", "text": "Platforms\nOverview\nThe Platforms extension adds allowed REST API platforms when restricting custom platforms through the use of the disable_unknown_platforms\u00c2\u00a0configuration setting.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nApplication\nExtension Directory\n./custom/Extension/application/Ext/Platforms/\nCompiled Extension File\n./custom/application/Ext/Platforms/platforms.ext.php\nManifest Installdef\n$installdefs['platforms']\nImplementation\nThe following sections illustrate the various ways to implement a new platform type\u00c2\u00a0to a Sugar instance.\nFile System\nWhen working directly with the filesystem, enable the\u00c2\u00a0disable_unknown_platforms\u00c2\u00a0configuration by setting $sugar_config['disable_unknown_platforms'] = true\u00c2\u00a0in your\u00c2\u00a0./config_override.php.\u00c2\u00a0This will prevent the\u00c2\u00a0system\u00c2\u00a0from allowing unknown\u00c2\u00a0platform\u00c2\u00a0types from accessing\u00c2\u00a0the rest endpoints. Next,\u00c2\u00a0create a file in ./custom/Extension/application/Ext/Platforms/ to map a new platform\u00c2\u00a0in the system. The following example adds a new platform called 'integration' that can be used throughout the system:\n./custom/Extension/application/Ext/Platforms/<file>.php\n<?php\n$platforms[] = 'integration';\nFinally, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and your customizations will be compiled into ./custom/application/Ext/Platforms/platforms.ext.php.\nAlternatively, platforms\u00c2\u00a0can also be added by creating ./custom/clients/platforms.php\u00c2\u00a0and\u00c2\u00a0appending new platform types to\u00c2\u00a0the\u00c2\u00a0$platforms variable. This method of creating platforms\u00c2\u00a0is still compatible but is not recommended from a best practices standpoint.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Platforms/index.html"}
{"id": "1211901a17af-1", "text": "Once installed, developers can\u00c2\u00a0take advantage of the new platform type when authenticating\u00c2\u00a0with the REST API\u00c2\u00a0oauth2/token endpoint. An example is shown below:\u00c2\u00a0\n{\n  \"grant_type\": \"password\",\n  \"username\": \"admin\",\n  \"password\": \"password\",\n  \"client_id\": \"sugar\",\n  \"client_secret\": \"\",\n  \"platform\": \"integration\"\n}\nModule Loadable Package\nWhen building a module loadable package, you can use the $installdefs['platforms'] index to install the extension file.\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe base path of the file to be installed\nThe example below demonstrates the proper install definition that should be used in the ./manifest.php file in order to add the utils to the system. You should note that when using this approach, Sugar will automatically execute Rebuild Extensions to reflect the new utils in the system.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'Platforms_Example',\n    'platforms' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/application/Ext/Platforms/<file>.php',\n        )\n    )\n);\nAlternatively, you may use the $installdefs['copy'] index to copy the file. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information on the $installdefs['copy'] index and module-loadable packages, please refer to the Introduction to the Manifest page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/Platforms/index.html"}
{"id": "a7af75e6fb52-0", "text": "This page refers to content that is only available in modules running in backward compatibility mode.\nFileAccessControlMap\nOverview\nThe FileAccessControlMap extension restricts specific view actions from users of the system.\nNote: This is only applicable to modules running in backward compatibility mode.\nProperties\nThe following extension properties are available.\u00c2\u00a0For more information, please refer to the Extension Property documentation.\nProperty\nValue\nExtension Scope\nModule\nSugar Variable\n$file_access_control_map\nExtension Directory\n./custom/Extension/modules/<module>/Ext/FileAccessControlMap/\nCompiled Extension File\n./custom/modules/<module>/Ext/FileAccessControlMap/file_access_control_map.ext.php\nManifest Installdef\n$installdefs['file_access']\nImplementation\nThe following sections illustrate the various ways to implement a customization to a Sugar instance.\nFile System\nWhen working directly with the filesystem, you can create a file in ./custom/Extension/modules/<module>/Ext/FileAccessControlMap/ to restrict a view of a module. The following example will create a new restriction for the detail view:\n./custom/Extension/modules/<module>/Ext/FileAccessControlMap/<file>.php\n<?php\n$file_access_control_map['modules']['<lowercase module>']['actions'] = array(\n    'detailview',\n);\nNavigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and compile your customization into ./custom/modules/<module>/Ext/FileAccessControlMap/file_access_control_map.ext.php\nModule Loadable Package\nWhen building a module loadable package, you can use the $installdefs['file_access'] index to install the extension file.\nInstalldef Properties\nName\nType\nDescription\nfrom\nString\nThe base path of the file to be installed\nto_module\nString\nThe key of the module the file is to be installed to", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/FileAccessControlMap/index.html"}
{"id": "a7af75e6fb52-1", "text": "to_module\nString\nThe key of the module the file is to be installed to\nThe example below\u00c2\u00a0demonstrates the proper install definition that should be used in the ./manifest.php file, in order to add the File Access Control Map file to a specific module. You should note that when using this approach, Sugar will automatically execute Rebuild Extensions to reflect the new Action in the system.\n./manifest.php\n<?php\n$manifest = array(\n    ...\n);\n$installdefs = array(\n    'id' => 'ActionRemap_Example',\n    'file_access' => array(\n        array(\n            'from' => '<basepath>/Files/custom/Extension/modules/<module>/Ext/FileAccessControlMap/<file>.php',\n            'to_module' => '<module>',\n        )\n    )\n);\nAlternatively, you may use the\u00c2\u00a0$installdefs['copy']\u00c2\u00a0index for the File Access Control Map Extension file. When using this approach, you may need to manually run repair actions such as a Quick Repair and Rebuild. For more information\u00c2\u00a0on the\u00c2\u00a0$installdefs['copy']\u00c2\u00a0index and module-loadable packages, please refer to the\u00c2\u00a0Introduction to the Manifest\u00c2\u00a0page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Extensions/FileAccessControlMap/index.html"}
{"id": "2b85f83e0869-0", "text": "Themes\nOverview\nHow to customize the\u00c2\u00a0Sugar theme.\u00c2\u00a0\nTheme Variables\nSugar's theme\u00c2\u00a0variables, defined in\u00c2\u00a0./styleguide/themes/clients/base/default/variables.php,\u00c2\u00a0determine the\u00c2\u00a0color of the primary action\u00c2\u00a0buttons, links,\u00c2\u00a0and\u00c2\u00a0header navigation. An example of the definition is shown below:\n./styleguide/themes/clients/base/default/variables.php\n$lessdefs = array(\n    'colors' => array(\n        /**\n         * Secondary Color:\n         * color of the navbar\n         * -------------------------\n         * was @secondary\n         */\n        'NavigationBar' => '#fff',\n        /**\n         * Primary Button Color:\n         * color of the primary button\n         * -------------------------\n         * was @primaryBtn\n         */\n        'PrimaryButton' => '#0679c8',\n    ),\n);\nVariable Descriptions\nIt is important to understand what the purpuse and utility of each variable is before you apply in your code, below is an in-depth description:\n@NavigationBar\nUsed to customize the mega menu background colour\u00c2\u00a0\nDefaults to Sugar's @white\u00c2\u00a0(#ffffff)\u00c2\u00a0\nNote: This variable is only supported in light mode\n@PrimaryButton\nUsed to customize the background colour for primary buttons\u00c2\u00a0(elements using `btn\u00c2\u00a0btn-primary`)\u00c2\u00a0\nDefaults to Sugar's @blue (#0679c8)\u00c2\u00a0\n@LinkColor \u00c2\u00a0\nUsed to customize the text color of link (anchor) elements\u00c2\u00a0\nDefaults to Sugar's @blue (#0679c8)\u00c2\u00a0\nNote: This variable is only supported in light mode\nCustom Themes", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Themes/index.html"}
{"id": "2b85f83e0869-1", "text": "Note: This variable is only supported in light mode\nCustom Themes\nModifications to\u00c2\u00a0the\u00c2\u00a0theme can be made by creating\u00c2\u00a0./custom/themes/clients/base/default/variables.php. Within this file, you can define the custom hex codes for the colors you would like to use. You should note that this is limited to the\u00c2\u00a0@NavigationBar, and @PrimaryButton less variables. An example is shown below.\n\u00c2\u00a0./custom/themes/clients/base/default/variables.php\nNote:\u00c2\u00a0Developers\u00c2\u00a0cannot override existing bootstrap\u00c2\u00a0less\u00c2\u00a0variables using this file.\nAdding CSS\nSugar allows you to customize CSS using the less language in ./custom/themes/custom.less.\u00c2\u00a0As Sugar makes use of the Bootstrap library, you have access to the features of Bootstrap and can make use of its variables to create your own CSS.\u00c2\u00a0An example is shown below.\u00c2\u00a0\n./custom/themes/custom.less\n//You can import any less file you want and define your own file structure\n//@import 'anyotherfile.less\n@myCustomBgColor: lighten(@NavigationBar,10%); //variable defined on a custom variable.\n.myCustomClass {\n    color: @linkColor; //bootstrap variable\n    background-color: @myCustomBgColor;\n}\nOverriding CSS Definitions\nYou can use the\u00c2\u00a0./custom/themes/custom.less file\u00c2\u00a0to\u00c2\u00a0override\u00c2\u00a0CSS classes. The following example overrides\u00c2\u00a0the record label font size.\n./custom/themes/custom.less\n/* \n* Changes record field label sizes to 13px;\n*/\n.record-cell .record-label{\n    font-size:13px;\n}\nOverriding the MegaMenu", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Themes/index.html"}
{"id": "2b85f83e0869-2", "text": "font-size:13px;\n}\nOverriding the MegaMenu\nAs the MegaMenu has limited color customization within ./custom/themes/clients/base/default/variables.php,\u00c2\u00a0you may want to customize the look and feel further. The following example will automatically set the menu's link color to a contrasting color based on the @NavigationBar\u00c2\u00a0variable\u00c2\u00a0and\u00c2\u00a0determine the hover and active colors for the tabs.\u00c2\u00a0\u00c2\u00a0\n./custom/themes/custom.less\n// Workaround for luminance calculation\n// Use luma() function once Sugar upgraded Lessphp to 1.7+ (see: http://lesscss.org/functions/#color-channel-luminance)\n@luma: 1 - ( (0.299 * red(@NavigationBar)) + (0.587 * green(@NavigationBar)) + (0.114 * blue(@NavigationBar)))/255;\n/** \n * LESS GUARDS\n */\n// General Nav Colors\n.mixin-color() {\n    // Darker Colors\n    & when (@luma > 0.5) {\n        color: darken(contrast(@NavigationBar), 10%) !important;\n    }\n    // Bright Colors\n    & when (@luma <= 0.5) {\n        color: lighten(contrast(@NavigationBar), 10%) !important;\n        // color: darken(@NavigationBar, 30%) !important;\n    }\n}\n// Nav Fa Icon Colors\n.mixin-fa-color(){\n    // Darker Colors\n    & when (@luma > 0.5) {\n        color: darken(contrast(@NavigationBar), 10%) !important;\n    }\n    // Bright Colors\n    & when (@luma <= 0.5) {\n        // color: lighten(@NavigationBar, 30%);\n        color: lighten(contrast(@NavigationBar), 10%) !important;", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Themes/index.html"}
{"id": "2b85f83e0869-3", "text": "color: lighten(contrast(@NavigationBar), 10%) !important;\n        // color: darken(@NavigationBar, 30%) !important;\n    }\n} \n// Hover Button Groups Background colors\n.mixin-background-color-hover(){\n    // Dark Colors\n    & when (@luma > 0.5) {\n        background-color: lighten(@NavigationBar, 15%) !important;\n    }\n    // Bright Colors\n    & when (@luma <= 0.5) {\n        background-color: darken(@NavigationBar, 15%) !important;\n    }\n}\n// Hover Button Groups colors\n.mixin-color-hover(){\n    // Dark Colors\n    & when (@luma > 0.5) {\n        color: darken(contrast(@NavigationBar), 10%) !important;\n    }\n    // Bright Colors\n    & when (@luma <= 0.5) {\n        // color: lighten(@NavigationBar, 20%) !important;\n        color: lighten(contrast(@NavigationBar), 10%) !important;\n    }\n}\n// Active Button Group Background Colors\n.mixin-background-color-active(){\n    // Dark Colors\n    & when (@luma > 0.5) {\n        background-color: lighten(@NavigationBar, 10%) !important;\n    }\n    // Bright Colors\n    & when (@luma <= 0.5) {\n        background-color: darken(@NavigationBar, 10%) !important;\n    }\n}\n// Active Button Group Hover Colors \n.mixin-color-active-hover(){\n    // Dark Colors\n    & when (@luma > 0.5) {\n        color: darken(contrast(@NavigationBar), 5%) !important;\n    }\n    // Bright Colors\n    & when (@luma <= 0.5) {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Themes/index.html"}
{"id": "2b85f83e0869-4", "text": "// Bright Colors\n    & when (@luma <= 0.5) {\n        color: lighten(contrast(@NavigationBar), 5%) !important;\n    }\n}\n// Open Button Group Background Colors\n.mixin-background-color-open(){\n    // Dark Colors\n    & when (@luma > 0.5) {\n        background-color: lighten(@NavigationBar, 20%) !important;\n    }\n    // Bright Colors\n    & when (@luma <= 0.5) {\n        background-color: darken(@NavigationBar, 20%) !important;\n    }\n}\n// Open Button Group Hover Colors \n.mixin-color-open-hover(){\n    // Dark Colors\n    & when (@luma > 0.5) {\n        color: darken(contrast(@NavigationBar), 15%) !important;\n    }\n    // Bright Colors\n    & when (@luma <= 0.5) {\n        color: lighten(contrast(@NavigationBar), 15%) !important;\n    }\n}\n// Background/Foreground Dropdown Menu Hover \n.mixin-background-foreground-dropdown-menu-hover(){\n    // Dark Colors\n    & when (@luma > 0.5) {\n        background-color: lighten(@NavigationBar, 15%) !important;\n        color: darken(contrast(@NavigationBar), 15%) !important;\n        .fa {\n            color: darken(contrast(@NavigationBar), 15%) !important;\n        }\n    }\n    // Bright Colors\n    & when (@luma <= 0.5) {\n        background-color: @NavigationBar !important;\n        color: lighten(contrast(@NavigationBar), 5%) !important;\n        .fa {\n            color: lighten(contrast(@NavigationBar), 5%) !important;\n        }\n    }\n}\n/** \n * LESS Definitions\n */", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Themes/index.html"}
{"id": "2b85f83e0869-5", "text": "}\n    }\n}\n/** \n * LESS Definitions\n */\n// Nav Button Group\n.module-list .megamenu > .dropdown .module-name{\n    .mixin-color;\n}\n// Home Button Caret\n.navbar .megamenu > .dropdown.active .btn-group:not(.open).home .fa-caret-down,\n// More Button Caret\n.module-list .megamenu > .dropdown.more .fa,\n// Module Toggle caret\n.navbar .megamenu > .dropdown .btn-group > .dropdown-toggle .fa {\n    .mixin-fa-color;\n}\n// Nav Button Group Hover \n.megamenu .dropdown .btn-group{\n    &:hover, &:focus{\n        .mixin-background-color-hover;\n        .btn,\n        > .dropdown-toggle .fa{\n            .mixin-color-hover;\n        }\n    }\n}\n// Active Button Group\n.navbar .megamenu > .dropdown.active .btn-group{\n    .mixin-background-color-active;\n    > .dropdown-toggle .fa,\n    > a.btn{\n        .mixin-fa-color;\n    }\n}\n// Active Button Group Hover\n.navbar .megamenu > .dropdown.active .btn-group:hover{\n    .mixin-color-active-hover;\n    > .dropdown-toggle .fa,\n    > a.btn{\n        .mixin-color-active-hover;\n    }\n}\n// Open Nav Button Group\n.navbar .megamenu > .dropdown .btn-group.open{\n    .mixin-background-color-open;\n    > .dropdown-toggle .fa,\n    > a.btn{\n        .mixin-fa-color;\n    }\n}\n// Open Nav Button Group Hover\n.navbar .megamenu > .dropdown .btn-group.open:hover{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Themes/index.html"}
{"id": "2b85f83e0869-6", "text": ".navbar .megamenu > .dropdown .btn-group.open:hover{\n    .mixin-color-open-hover;\n    > .dropdown-toggle .fa,\n    > a.btn{\n        .mixin-color-open-hover;\n    }\n}\n// Nav Button Group Dropdown Menu\n.navbar .megamenu > .dropdown .dropdown-menu li a{\n    &:hover, &:focus{\n        .mixin-background-foreground-dropdown-menu-hover;\n    }\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Themes/index.html"}
{"id": "0160c62e6b45-0", "text": "Quotes\nOverview\nAs of Sugar 7.9.0.0, the quotes module has been moved out of Backward Compatibility mode into Sidecar. Customizations to the Quotes interface will need to be rewritten for the new Sidecar framework as an automated migration of these customizations is not possible. This document will outline common customizations and implementation methods.\nQuote Identifiers\nAdministrators can create custom quote identifiers that are more complex than the default auto-incrementing scheme found in an out of box installation. Utilizing this functionality, we can create numbering schemes that match any business needs.\nCreating Custom Identifiers\nTo create a custom identifier, navigate to Admin > Studio > Quotes > Fields. Next, create a TextField type field named to your liking and check the \"Calculated Value\" checkbox and click \"Edit Formula\". Once you see the formula builder, you can choose an example below or create your own. Once created, You can add the new field to your Quote module's layouts as desired.\nUser Field with Pseudo-Random Values\nThis example creates a quote number in the format of <user last name>-##### that translates to Smith-87837. This identifier starts with the last name of the user creating it, followed by 5 pseudo-random numbers based on the creation time.\nconcat(related($created_by_link, \"last_name\"), \"-\", subStr(toString(timestamp($date_entered)), 5, 5))\nNote: when using Sugar Logic, updates to related fields will update any corresponding Sugar Logic fields. The example being that an update to the Created By last\u00c2\u00a0name field will update all related records with\u00c2\u00a0a\u00c2\u00a0field using this formula.\nRelated Field Value and Auto-Incrementing Number", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-1", "text": "Related Field Value and Auto-Incrementing Number\nThis example creates a quote number in the format of <billing account name>-#### that translates to Start Over Trust-0001. This number starts with the billing account name followed by a 4 digit auto-incrementing number.\nconcat(related($billing_accounts, \"name\"), \"-\", subStr(toString(add($quote_num, 10000)), 1, 4))\nNote: when using Sugar Logic, updates to related fields will update any corresponding Sugar Logic fields. The example being that an update to the Billing Account name will update all related records with\u00c2\u00a0a\u00c2\u00a0field using this formula.\nRecord Layout\nThe following sections outline various changes that can be done to modify the record layout of the Quotes module, by outlining the extra views that can be updated.\nGrand Totals Header\nThe Grand Total Header contains the calculated totals for the quote.\nModifying Fields in the Grand Totals Header\nTo modify the Grand Totals Header fields, you can copy ./modules/Quotes/clients/base/views/quote-data-grand-totals-header/quote-data-grand-totals-header.php to ./custom/modules/Quotes/clients/base/views/quote-data-grand-totals-header/quote-data-grand-totals-header.php or you may create a metadata extension in ./custom/Extension/modules/Quotes/clients/base/views/quote-data-grand-totals-header/. Next, modify the $viewdefs['Quotes']['base']['view']['quote-data-grand-totals-header']['panels'][0]['fields'] index to add or remove your preferred fields.\nExample", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-2", "text": "Example\nThe example below will add the \"Quote Number\" field (quotes.quote_num) field to the layout and removes the \"Total Discount\" (quotes.deal_tot) from the layout.\u00c2\u00a0If adding a custom field from the Quotes\u00c2\u00a0module to the view, you will also need to add that field to the related_fields array as outlined in the Record View documentation below.\n./custom/modules/Quotes/clients/base/views/quote-data-grand-totals-header/quote-data-grand-totals-header.php\n<?php\n$viewdefs['Quotes']['base']['view']['quote-data-grand-totals-header'] = array(\n    ...\n    'panels' => array(\n        array(\n            'name' => 'panel_quote_data_grand_totals_header',\n            'label' => 'LBL_QUOTE_DATA_GRAND_TOTALS_HEADER',\n            'fields' => array(\n                array(\n                    'name' => 'quote_num',\n                    'label' => 'LBL_LIST_QUOTE_NUM',\n                    'css_class' => 'quote-totals-row-item',\n                ),\n                array(\n                    'name' => 'new_sub',\n                    'css_class' => 'quote-totals-row-item',\n                ),\n                array(\n                    'name' => 'tax',\n                    'label' => 'LBL_TAX_TOTAL',\n                    'css_class' => 'quote-totals-row-item',\n                ),\n                array(\n                    'name' => 'shipping',\n                    'css_class' => 'quote-totals-row-item',\n                ),\n                array(\n                    'name' => 'total',\n                    'label' => 'LBL_LIST_GRAND_TOTAL',\n                    'css_class' => 'quote-totals-row-item',\n                ),\n            ),\n        ),\n    ),\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-3", "text": "),\n            ),\n        ),\n    ),\n);\nModifying Buttons in the Grand Totals Header\nThe Quotes List Header contains row actions to create quoted line items, comments, and groupings. The actions are identified by the plus icon in the top left of the header. Editing the 'actions' will allow you to add or remove buttons. The following section will outline how these items can be modified.\nTo modify the Row Actions in the Grand Total Header, you can copy ./modules/Quotes/clients/base/views/quote-data-grand-totals-header/quote-data-grand-totals-header.php to ./custom/modules/Quotes/clients/base/views/quote-data-grand-totals-header/quote-data-grand-totals-header.php or you may create a metadata extension in ./custom/Extension/modules/Quotes/clients/base/views/quote-data-grand-totals-header/. Next, modify the $viewdefs['Quotes']['base']['view']['quote-data-grand-totals-header']['buttons'] index to add or remove your preferred row actions.\nExample\nThe example below will create a new view that extends the QuotesQuoteDataGrandTotalsHeader view and append a button to the Grand Total Header button list.\nFirst, create your custom view type that will extend the QuotesQuoteDataGrandTotalsHeader view.\n./custom/modules/Quotes/clients/base/views/quote-data-grand-totals-header/quote-data-grand-totals-header.js\n({\n    extendsFrom: 'QuotesQuoteDataGrandTotalsHeaderView',\n    initialize: function(options) {\n        this.events = _.extend({}, this.events, options.def.events, {\n            'click [name=\"gth-custom-button\"]': 'buttonClicked'\n        });\n        this._super('initialize', [options]);\n    },\n    /**\n     * Click event\n     */\n    buttonClicked: function() {\n        app.alert.show('success_alert', {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-4", "text": "buttonClicked: function() {\n        app.alert.show('success_alert', {\n            level: 'success',\n            title: 'Grand Total Header Button was clicked!'\n        });\n    },\n})\nThis code will append a click event to our button named gth-custom-button and trigger the buttonClicked method. Once completed, add your new button\u00c2\u00a0array to the grand total header in the $viewdefs['Quotes']['base']['view']['quote-data-grand-totals-header']['buttons'] index.\n./custom/modules/Quotes/clients/base/views/quote-data-grand-totals-header/quote-data-grand-totals-header.php\n<?php\n$viewdefs['Quotes']['base']['view']['quote-data-grand-totals-header'] = array(\n    'buttons' => array(\n        array(\n            'type' => 'quote-data-actiondropdown',\n            'name' => 'panel_dropdown',\n            'no_default_action' => true,\n            'buttons' => array(\n                array(\n                    'type' => 'button',\n                    'icon' => 'fa-plus',\n                    'name' => 'create_qli_button',\n                    'label' => 'LBL_CREATE_QLI_BUTTON_LABEL',\n                    'acl_action' => 'create',\n                    'tooltip' => 'LBL_CREATE_QLI_BUTTON_TOOLTIP',\n                ),\n                array(\n                    'type' => 'button',\n                    'icon' => 'fa-plus',\n                    'name' => 'create_comment_button',\n                    'label' => 'LBL_CREATE_COMMENT_BUTTON_LABEL',\n                    'acl_action' => 'create',\n                    'tooltip' => 'LBL_CREATE_COMMENT_BUTTON_TOOLTIP',\n                ),\n                array(\n                    'type' => 'button',\n                    'icon' => 'fa-plus',\n                    'name' => 'create_group_button',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-5", "text": "'name' => 'create_group_button',\n                    'label' => 'LBL_CREATE_GROUP_BUTTON_LABEL',\n                    'acl_action' => 'create',\n                    'tooltip' => 'LBL_CREATE_GROUP_BUTTON_TOOLTIP',\n                ),\n                array(\n                    'type' => 'button',\n                    'icon' => 'fa-plus',\n                    'name' => 'gth-custom-button',\n                    'label' => 'LBL_GTH_CUSTOM_BUTTON',\n                    'acl_action' => 'create',\n                    'tooltip' => 'LBL_GTH_CUSTOM_BUTTON_TOOLTIP',\n                ),\n            ),\n        ),\n    ),\n    ...\n);\nFinally, create labels under Quotes for the label and tooltip indexes. To accomplish this, create a language extension:\n./custom/Extension/modules/Quotes/Ext/Language/en_us.custom-button.php\n<?php\n$mod_strings['LBL_GTH_CUSTOM_BUTTON'] = 'Custom Button';\n$mod_strings['LBL_GTH_CUSTOM_BUTTON_TOOLTIP'] = 'Custom Button Tooltip';\nOnce the files are in place, navigate to Admin > Repair > Quick Repair and Rebuild. Your changes will now be reflected in the system.\nList Header\nThe Quotes List Header is a complex view that pulls data from two different locations. The JavaScript controller is located in ./modules/Quotes/clients/base/views/quote-data-list-header/quote-data-list-header.js and pulls the metadata from ./modules/Products/clients/base/views/quote-data-group-list/quote-data-group-list.php. You should note that ProductBundleNotes combines its description field with Product fields in this list.\nModifying Fields in the List Header", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-6", "text": "Modifying Fields in the List Header\nTo modify the List Header fields, you can copy ./modules/Products/clients/base/views/quote-data-group-list/quote-data-group-list.php to ./custom/modules/Products/clients/base/views/quote-data-group-list/quote-data-group-list.php or you may create a metadata extension in ./custom/Extension/modules/Products/Ext/clients/base/views/quote-data-group-list/. Next, modify the $viewdefs['Products']['base']['view']['quote-data-group-list']['panels'][0]['fields'] index to add or remove your preferred fields.\nExample\nThe example below will remove the \"Part Number\" (products.mft_part_num) field and replace it with the \"Weight\" (products.weight) field.\n./custom/modules/Products/clients/base/views/quote-data-group-list/quote-data-group-list.php\n<?php\n$viewdefs['Products']['base']['view']['quote-data-group-list'] = array(\n    'panels' => array(\n        array(\n            'name' => 'products_quote_data_group_list',\n            'label' => 'LBL_PRODUCTS_QUOTE_DATA_LIST',\n            'fields' => array(\n                array(\n                    'name' => 'line_num',\n                    'label' => null,\n                    'widthClass' => 'cell-xsmall',\n                    'css_class' => 'line_num tcenter',\n                    'type' => 'line-num',\n                    'readonly' => true,\n                ),\n                array(\n                    'name' => 'quantity',\n                    'label' => 'LBL_QUANTITY',\n                    'widthClass' => 'cell-small',\n                    'css_class' => 'quantity',\n                    'type' => 'float',\n                ),\n                array(\n                    'name' => 'product_template_name',\n                    'label' => 'LBL_ITEM_NAME',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-7", "text": "'label' => 'LBL_ITEM_NAME',\n                    'widthClass' => 'cell-large',\n                    'type' => 'quote-data-relate',\n                    'required' => true,\n                ),\n                array(\n                    'name' => 'weight',\n                    'label' => 'LBL_WEIGHT',\n                    'type' => 'float',\n                ),\n                array(\n                    'name' => 'discount_price',\n                    'label' => 'LBL_DISCOUNT_PRICE',\n                    'type' => 'currency',\n                    'convertToBase' => true,\n                    'showTransactionalAmount' => true,\n                    'related_fields' => array(\n                        'discount_price',\n                        'currency_id',\n                        'base_rate',\n                    ),\n                ),\n                array(\n                    'name' => 'discount',\n                    'type' => 'fieldset',\n                    'css_class' => 'quote-discount-percent',\n                    'label' => 'LBL_DISCOUNT_AMOUNT',\n                    'fields' => array(\n                        array(\n                            'name' => 'discount_amount',\n                            'label' => 'LBL_DISCOUNT_AMOUNT',\n                            'type' => 'discount',\n                            'convertToBase' => true,\n                            'showTransactionalAmount' => true,\n                        ),\n                        array(\n                            'type' => 'discount-select',\n                            'name' => 'discount_select',\n                            'no_default_action' => true,\n                            'buttons' => array(\n                                array(\n                                    'type' => 'rowaction',\n                                    'name' => 'select_discount_amount_button',\n                                    'label' => 'LBL_DISCOUNT_AMOUNT',\n                                    'event' => 'button:discount_select_change:click',\n                                ),\n                                array(\n                                    'type' => 'rowaction',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-8", "text": "),\n                                array(\n                                    'type' => 'rowaction',\n                                    'name' => 'select_discount_percent_button',\n                                    'label' => 'LBL_DISCOUNT_PERCENT',\n                                    'event' => 'button:discount_select_change:click',\n                                ),\n                            ),\n                        ),\n                    ),\n                ),\n                array(\n                    'name' => 'total_amount',\n                    'label' => 'LBL_LINE_ITEM_TOTAL',\n                    'type' => 'currency',\n                    'widthClass' => 'cell-medium',\n                    'showTransactionalAmount' => true,\n                    'related_fields' => array(\n                        'total_amount',\n                        'currency_id',\n                        'base_rate',\n                    ),\n                ),\n            ),\n        ),\n    ),\n);\nNext, create the LBL_WEIGHT label under Quotes as this is not included in the stock installation. To accomplish this, we will need to create a language extension:\n./custom/Extension/modules/Quotes/Ext/Language/en_us.weight.php\n<?php\n$mod_strings['LBL_WEIGHT'] = 'Weight';\nIf adding a custom field from the Quotes\u00c2\u00a0module to the view, you will also need to add that field to the related_fields array as outlined in the Record View documentation below. Once the files are in place, navigate to Admin > Repair > Quick Repair and Rebuild. Your changes will now be reflected in the system.\nModifying Row Actions in the List Header\nThe Quotes List Header contains row actions to create and delete QLI groupings. The actions are identified by, the \"check all\" checkbox and vertical ellipsis or \"hamburger\" icon buttons. Editing the 'actions' will allow you to add more buttons to (or remove from) the \"Group Selected\" and \"Delete Selected\" buttons. The following section will outline how these items can be modified.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-9", "text": "To modify the Row Actions in the List Header, you can copy ./modules/Quotes/clients/base/views/quote-data-list-header/quote-data-list-header.php to ./custom/modules/Quotes/clients/base/views/quote-data-list-header/quote-data-list-header.php or you may create a metadata extension in ./custom/Extension/modules/Quotes/clients/base/views/quote-data-list-header/. Next, modify the $viewdefs['Quotes']['base']['view']['quote-data-list-header']['selection']['actions'] index to add or remove your preferred actions.\nExample\nThe example below will create a new view that extends the QuotesQuoteDataListHeader view and append a row action to the List Header action list.\nFirst, create your custom view type that will extend the QuotesQuoteDataListHeader view.\n./custom/modules/Quotes/clients/base/views/quote-data-list-header/quote-data-list-header.js\n({\n    extendsFrom: 'QuotesQuoteDataListHeaderView',\n    initialize: function(options) {\n        this.events = _.extend({}, this.events, options.def.events, {\n            'click [name=\"lh-custom-button\"]': 'actionClicked'\n        });\n        this._super('initialize', [options]);\n    },\n    /**\n     * Click event\n     */\n    actionClicked: function() {\n        app.alert.show('success_alert', {\n            level: 'success',\n            title: 'List Header Row Action was clicked!'\n        });\n    },\n})\nThis code will append a click event to our field named lh-custom-button and trigger the actionClicked method. Once completed, add your new row action to the list header in the $viewdefs['Quotes']['base']['view']['quote-data-list-header']['selection']['actions'] index.\n./custom/modules/Quotes/clients/base/views/quote-data-list-header/quote-data-list-header.php\n<?php", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-10", "text": "<?php\n$viewdefs['Quotes']['base']['view']['quote-data-list-header'] = array(\n    'selection' => array(\n        'type' => 'multi',\n        'actions' => array(\n            array(\n                'name' => 'group_button',\n                'type' => 'rowaction',\n                'label' => 'LBL_CREATE_GROUP_SELECTED_BUTTON_LABEL',\n                'tooltip' => 'LBL_CREATE_GROUP_SELECTED_BUTTON_TOOLTIP',\n                'acl_action' => 'edit',\n            ),\n            array(\n                'name' => 'massdelete_button',\n                'type' => 'rowaction',\n                'label' => 'LBL_DELETE_SELECTED_LABEL',\n                'tooltip' => 'LBL_DELETE_SELECTED_TOOLTIP',\n                'acl_action' => 'delete',\n            ),\n            array(\n                'name' => 'lh-custom-button',\n                'type' => 'rowaction',\n                'label' => 'LBL_LH_CUSTOM_ACTION',\n                'tooltip' => 'LBL_LH_CUSTOM_ACTION_TOOLTIP',\n                'acl_action' => 'edit',\n            ),\n        ),\n    ),\n);\nFinally, create labels under Quotes for the label and tooltip indexes. To accomplish this, create a language extension:\n./custom/Extension/modules/Quotes/Ext/Language/en_us.lh-custom-action.php\n<?php\n$mod_strings['LBL_LH_CUSTOM_ACTION'] = 'Custom Action';\n$mod_strings['LBL_LH_CUSTOM_ACTION_TOOLTIP'] = 'Custom Action Tooltip';\nOnce the files are in place, navigate to Admin > Repair > Quick Repair and Rebuild. Your changes will now be reflected in the system.\nGroup Header\nThe Group Header contains the name and options for each grouping of quoted line items.\n\u00c2\u00a0\nModifying Fields in the Group Header", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-11", "text": "\u00c2\u00a0\nModifying Fields in the Group Header\nTo modify the Group Header fields, you can copy ./modules/ProductBundles/clients/base/views/quote-data-group-header/quote-data-group-header.php to ./custom/modules/ProductBundles/clients/base/views/quote-data-group-header/quote-data-group-header.php or you may create a metadata extension in ./custom/Extension/modules/Products/clients/base/views/quote-data-group-header/. Next, modify the $viewdefs['ProductBundles']['base']['view']['quote-data-group-header'] index to add or remove your preferred fields.\nExample\nThe example below will append the group total (product_bundles.subtotal) field to the Group Header. It's important to note that when adding additional fields, that changes to the corresponding .hbs file may be necessary to correct any formatting issues.\n./custom/modules/ProductBundles/clients/base/views/quote-data-group-header/quote-data-group-header.php\n<?php\n$viewdefs['ProductBundles']['base']['view']['quote-data-group-header'] = array(\n    ...\n    'panels' => array(\n        array(\n            'name' => 'panel_quote_data_group_header',\n            'label' => 'LBL_QUOTE_DATA_GROUP_HEADER',\n            'fields' => array(\n                array(\n                    'name' => 'name',\n                    'type' => 'quote-group-title',\n                    'css_class' => 'group-name',\n                ),\n                'subtotal',\n            ),\n        ),\n    ),\n);\nIf adding a custom field from the Quotes\u00c2\u00a0module to the view, you will also need to add that field to the related_fields array as outlined in the Record View documentation below. Once the files are in place, navigate to Admin > Repair > Quick Repair and Rebuild. Your changes will now be reflected in the system.\nModifying Row Actions in the Group Header", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-12", "text": "Modifying Row Actions in the Group Header\nThe Quotes Group Header contains row actions to add QLIs and comments as well as editing and deleting QLI groupings. The actions are identified by, the plus and vertical ellipsis or \"hamburger\" icon buttons. The following section will outline how these items can be modified.\nTo modify the buttons in the Group Header, you can copy ./modules/ProductBundles/clients/base/views/quote-data-group-header/quote-data-group-header.php to ./custom/modules/ProductBundles/clients/base/views/quote-data-group-header/quote-data-group-header.php or you may create a metadata extension in ./custom/Extension/modules/ProductBundles/clients/base/views/quote-data-group-header/. Next, modify the $viewdefs['ProductBundles']['base']['view']['quote-data-group-header']['buttons']\u00c2\u00a0index to add or remove your preferred actions.\nExample\nThe example below will create a new view that extends the ProductBundlesQuoteDataGroupHeader view and append a row action to the Group Header vertical elipsis action list.\nFirst, create your custom view type that will extend the ProductBundlesQuoteDataGroupHeader view.\n./custom/modules/ProductBundles/clients/base/views/quote-data-group-header/quote-data-group-header.js\n({\n    extendsFrom: 'ProductBundlesQuoteDataGroupHeaderView',\n    initialize: function(options) {\n        this.events = _.extend({}, this.events, options.def.events, {\n            'click [name=\"gh-custom-action\"]': 'actionClicked'\n        });\n        this._super('initialize', [options]);\n    },\n    /**\n     * Click event\n     */\n    actionClicked: function() {\n        app.alert.show('success_alert', {\n            level: 'success',\n            title: 'Group Header Button was clicked!'\n        });\n    },\n})", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-13", "text": "title: 'Group Header Button was clicked!'\n        });\n    },\n})\nThis code will append a click event to our field named gh-custom-action and trigger the actionClicked method. Once completed, add your new row action to the appropriate button group in\u00c2\u00a0$viewdefs['Quotes']['base']['view']['quote-data-group-header']['buttons']. For this example we will target a row action to the edit drop down that is identified in the arrays as having\u00c2\u00a0a\u00c2\u00a0name of \"edit-dropdown\". Once found, add your new array to the buttons index of that array.\n./custom/modules/ProductBundles/clients/base/views/quote-data-group-header/quote-data-group-header.php\n<?php\n$viewdefs['ProductBundles']['base']['view']['quote-data-group-header'] = array(\n    'buttons' => array(\n        array(\n            'type' => 'quote-data-actiondropdown',\n            'name' => 'create-dropdown',\n            'icon' => 'fa-plus',\n            'no_default_action' => true,\n            'buttons' => array(\n                array(\n                    'type' => 'rowaction',\n                    'css_class' => 'btn-invisible',\n                    'icon' => 'fa-plus',\n                    'name' => 'create_qli_button',\n                    'label' => 'LBL_CREATE_QLI_BUTTON_LABEL',\n                    'tooltip' => 'LBL_CREATE_QLI_BUTTON_TOOLTIP',\n                    'acl_action' => 'create',\n                ),\n                array(\n                    'type' => 'rowaction',\n                    'css_class' => 'btn-invisible',\n                    'icon' => 'fa-plus',\n                    'name' => 'create_comment_button',\n                    'label' => 'LBL_CREATE_COMMENT_BUTTON_LABEL',\n                    'tooltip' => 'LBL_CREATE_COMMENT_BUTTON_TOOLTIP',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-14", "text": "'tooltip' => 'LBL_CREATE_COMMENT_BUTTON_TOOLTIP',\n                    'acl_action' => 'create',\n                ),\n            ),\n        ),\n        array(\n            'type' => 'quote-data-actiondropdown',\n            'name' => 'edit-dropdown',\n            'icon' => 'fa-ellipsis-v',\n            'no_default_action' => true,\n            'buttons' => array(\n                array(\n                    'type' => 'rowaction',\n                    'name' => 'edit_bundle_button',\n                    'label' => 'LBL_EDIT_BUTTON',\n                    'tooltip' => 'LBL_EDIT_BUNDLE_BUTTON_TOOLTIP',\n                    'acl_action' => 'edit',\n                ),\n                array(\n                    'type' => 'rowaction',\n                    'name' => 'delete_bundle_button',\n                    'label' => 'LBL_DELETE_GROUP_BUTTON',\n                    'tooltip' => 'LBL_DELETE_BUNDLE_BUTTON_TOOLTIP',\n                    'acl_action' => 'delete',\n                ),\n                array(\n                    'type' => 'rowaction',\n                    'name' => 'gh-custom-action',\n                    'label' => 'LBL_GH_CUSTOM_ACTION',\n                    'tooltip' => 'LBL_GH_CUSTOM_ACTION_TOOLTIP',\n                    'acl_action' => 'edit',\n                ),\n            ),\n        ),\n    ),\n    ...\n);\nFinally, create labels under Quotes for the label and tooltip indexes. To accomplish this, create a language extension:\n./custom/Extension/modules/Quotes/Ext/Language/en_us.gh-custom-action.php\n<?php\n$mod_strings['LBL_GH_CUSTOM_ACTION'] = 'Custom Action';\n$mod_strings['LBL_GH_CUSTOM_ACTION_TOOLTIP'] = 'Custom Action Tooltip';", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-15", "text": "$mod_strings['LBL_GH_CUSTOM_ACTION_TOOLTIP'] = 'Custom Action Tooltip';\nOnce the files are in place, navigate to Admin > Repair > Quick Repair and Rebuild. Your changes will now be reflected in the system.\nGroup List\nThe Group List contains the comments and selected quoted line items.\nModifying Fields in the Group List\nTo modify the Group List fields, you can copy ./modules/Products/clients/base/views/quote-data-group-list/quote-data-group-list.php to ./custom/modules/Products/clients/base/views/quote-data-group-list/quote-data-group-list.php or you may create a metadata extension in ./custom/Extension/modules/Products/Ext/clients/base/views/quote-data-group-list/. Next, modify the $viewdefs['Products']['base']['view']['quote-data-group-list']['panels'] index to add or remove your preferred fields.\nExample\nThe example below will remove the \"Manufacturer Part Number\" (products.mft_part_num) and append the \"Vendor Part Number\" (products.vendor_part_num) field to the Group List.\n./custom/modules/Products/clients/base/views/quote-data-group-list/quote-data-group-list.php\n<?php\n$viewdefs['Products']['base']['view']['quote-data-group-list'] = array(\n    'panels' => array(\n        array(\n            'name' => 'products_quote_data_group_list',\n            'label' => 'LBL_PRODUCTS_QUOTE_DATA_LIST',\n            'fields' => array(\n                array(\n                    'name' => 'line_num',\n                    'label' => null,\n                    'widthClass' => 'cell-xsmall',\n                    'css_class' => 'line_num tcenter',\n                    'type' => 'line-num',\n                    'readonly' => true,\n                ),\n                array(\n                    'name' => 'quantity',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-16", "text": "),\n                array(\n                    'name' => 'quantity',\n                    'label' => 'LBL_QUANTITY',\n                    'widthClass' => 'cell-small',\n                    'css_class' => 'quantity',\n                    'type' => 'float',\n                ),\n                array(\n                    'name' => 'product_template_name',\n                    'label' => 'LBL_ITEM_NAME',\n                    'widthClass' => 'cell-large',\n                    'type' => 'quote-data-relate',\n                    'required' => true,\n                ),\n                array(\n                    'name' => 'vendor_part_num',\n                    'label' => 'LBL_VENDOR_PART_NUM',\n                    'type' => 'base',\n                ),\n                array(\n                    'name' => 'discount_price',\n                    'label' => 'LBL_DISCOUNT_PRICE',\n                    'type' => 'currency',\n                    'convertToBase' => true,\n                    'showTransactionalAmount' => true,\n                    'related_fields' => array(\n                        'discount_price',\n                        'currency_id',\n                        'base_rate',\n                    ),\n                ),\n                array(\n                    'name' => 'discount',\n                    'type' => 'fieldset',\n                    'css_class' => 'quote-discount-percent',\n                    'label' => 'LBL_DISCOUNT_AMOUNT',\n                    'fields' => array(\n                        array(\n                            'name' => 'discount_amount',\n                            'label' => 'LBL_DISCOUNT_AMOUNT',\n                            'type' => 'discount',\n                            'convertToBase' => true,\n                            'showTransactionalAmount' => true,\n                        ),\n                        array(\n                            'type' => 'discount-select',\n                            'name' => 'discount_select',\n                            'no_default_action' => true,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-17", "text": "'name' => 'discount_select',\n                            'no_default_action' => true,\n                            'buttons' => array(\n                                array(\n                                    'type' => 'rowaction',\n                                    'name' => 'select_discount_amount_button',\n                                    'label' => 'LBL_DISCOUNT_AMOUNT',\n                                    'event' => 'button:discount_select_change:click',\n                                ),\n                                array(\n                                    'type' => 'rowaction',\n                                    'name' => 'select_discount_percent_button',\n                                    'label' => 'LBL_DISCOUNT_PERCENT',\n                                    'event' => 'button:discount_select_change:click',\n                                ),\n                            ),\n                        ),\n                    ),\n                ),\n                array(\n                    'name' => 'total_amount',\n                    'label' => 'LBL_LINE_ITEM_TOTAL',\n                    'type' => 'currency',\n                    'widthClass' => 'cell-medium',\n                    'showTransactionalAmount' => true,\n                    'related_fields' => array(\n                        'total_amount',\n                        'currency_id',\n                        'base_rate',\n                    ),\n                ),\n            ),\n        ),\n    ),\n);\nNext, create the LBL_VENDOR_PART_NUM label under Quotes as this is not included in the stock installation. To accomplish this, we will need to create a language extension:\n./custom/Extension/modules/Quotes/Ext/Language/en_us.vendor.php\n<?php\n$mod_strings['LBL_VENDOR_PART_NUM'] = 'Vendor Part Number';\nIf adding a custom field from the Quotes\u00c2\u00a0module to the view, you will also need to add that field to the related_fields array as outlined in the Record View documentation below. Once the files are in place, navigate to Admin > Repair > Quick Repair and Rebuild. Your changes will now be reflected in the system.\nModifying Row Actions in the Group List", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-18", "text": "Modifying Row Actions in the Group List\nThe Quotes Group List contains row actions to add/remove QLIs and comments. The actions are identified by, the vertical ellipsis icon buttons. The following section will outline how these items can be modified.\nTo modify the buttons in the Group List , you can copy ./modules/ProductBundles/clients/base/views/quote-data-group-list/quote-data-group-list.php to ./custom/modules/ProductBundles/clients/base/views/quote-data-group-list/quote-data-group-list.php or you may create a metadata extension in ./custom/Extension/modules/ProductBundles/clients/base/views/quote-data-group-list/. Next, modify the $viewdefs['ProductBundles']['base']['view']['quote-data-group-list']['selection'] index to add or remove your preferred actions.\nExample\nThe example below will create a new view that extends the ProductBundlesQuoteDataGroupList view and append a row action to the Group List's vertical elipsis action list.\nFirst, create your custom view type that will extend the ProductBundlesQuoteDataGroupList view. This will contain the JavaScript for your action.\n./custom/modules/ProductBundles/clients/base/views/quote-data-group-list/quote-data-group-list.js\n({\n    extendsFrom: 'ProductBundlesQuoteDataGroupListView',\n    initialize: function(options) {\n        this.events = _.extend({}, this.events, options.def.events, {\n            'click [name=\"gl-custom-action\"]': 'actionClicked'\n        });\n        this._super('initialize', [options]);\n    },\n    /**\n     * Click event\n     */\n    actionClicked: function() {\n        app.alert.show('success_alert', {\n            level: 'success',\n            title: 'List Header Row Action was clicked!'\n        });\n    },\n})", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-19", "text": "title: 'List Header Row Action was clicked!'\n        });\n    },\n})\nThis code will append a click event to our field named gl-custom-action and trigger the actionClicked method. Once completed, add your new row action to the group list in the $viewdefs['ProductBundles']['base']['view']['quote-data-group-list']['selection']['actions'] index.\n./custom/modules/ProductBundles/clients/base/views/quote-data-group-list/quote-data-group-list.php\n<?php\n$viewdefs['ProductBundles']['base']['view']['quote-data-group-list'] = array(\n    'selection' => array(\n        'type' => 'multi',\n        'actions' => array(\n            array(\n                'type' => 'rowaction',\n                'name' => 'edit_row_button',\n                'label' => 'LBL_EDIT_BUTTON',\n                'tooltip' => 'LBL_EDIT_BUTTON',\n                'acl_action' => 'edit',\n            ),\n            array(\n                'type' => 'rowaction',\n                'name' => 'delete_row_button',\n                'label' => 'LBL_DELETE_BUTTON',\n                'tooltip' => 'LBL_DELETE_BUTTON',\n                'acl_action' => 'delete',\n            ),\n            array(\n                'type' => 'rowaction',\n                'name' => 'gl-custom-action',\n                'label' => 'LBL_GL_CUSTOM_ACTION',\n                'tooltip' => 'LBL_GL_CUSTOM_ACTION_TOOLTIP',\n                'acl_action' => 'edit',\n            ),\n        ),\n    ),\n);\nFinally, create labels under Quotes for the label and tooltip indexes. To accomplish this, create a language extension:\n./custom/Extension/modules/Quotes/Ext/Language/en_us.gh-custom-action.php\n<?php\n$mod_strings['LBL_GL_CUSTOM_ACTION'] = 'Custom Action';", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-20", "text": "<?php\n$mod_strings['LBL_GL_CUSTOM_ACTION'] = 'Custom Action';\n$mod_strings['LBL_GL_CUSTOM_ACTION_TOOLTIP'] = 'Custom Action Tooltip';\nOnce the files are in place, navigate to Admin > Repair > Quick Repair and Rebuild. Your changes will now be reflected in the system.\nGroup Footer\nThe Group Footer contains the total for each grouping of quoted line items.\nModifying Fields in the Group Footer\nTo modify the GroupFooter fields, you can copy ./modules/ProductBundles/clients/base/views/quote-data-group-footer/quote-data-group-footer.php to ./custom/modules/ProductBundles/clients/base/views/quote-data-group-footer/quote-data-group-footer.php or you may create a metadata extension in ./custom/Extension/modules/ProductBundles/clients/base/views/quote-data-group-footer/. Next, modify the $viewdefs['ProductBundles']['base']['view']['quote-data-group-footer'] index to add or remove your preferred fields.\nExample\nThe example below will append the bundle stage (product_bundles.bundle_stage) field to the Group Footer. It's important to note that when adding additional fields, that changes to the corresponding .hbs file may be necessary to correct any formatting issues.\n./custom/modules/ProductBundles/clients/base/views/quote-data-group-header/quote-data-group-footer.php\n<?php\n$viewdefs['ProductBundles']['base']['view']['quote-data-group-footer'] = array(\n    'panels' => array(\n        array(\n            'name' => 'panel_quote_data_group_footer',\n            'label' => 'LBL_QUOTE_DATA_GROUP_FOOTER',\n            'fields' => array(\n                'bundle_stage',\n                array(\n                    'name' => 'new_sub',\n                    'label' => 'LBL_GROUP_TOTAL',\n                    'type' => 'currency',\n                ),\n            ),\n        ),\n    ),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-21", "text": "),\n            ),\n        ),\n    ),\n);\nIf adding custom fields from the Product Bundles module to the view, you will also need to add that field to the related_fields array as outlined in the Record View documentation below. Once the files are in place, navigate to Admin > Repair > Quick Repair and Rebuild. Your changes will now be reflected in the system.\nGrand Totals Footer\nThe Grand Total Footer contains the calculated totals for the quote. It mimics the information found in the Grand Total Header.\nModifying Fields in the Grand Totals Footer\nTo modify the Grand Totals Footer fields, you can copy ./modules/Quotes/clients/base/views/quote-data-grand-totals-footer/quote-data-grand-totals-footer.php to ./custom/modules/Quotes/clients/base/views/quote-data-grand-totals-footer/quote-data-grand-totals-footer.php or you may create a metadata extension in ./custom/Extension/modules/Quotes/clients/base/views/quote-data-grand-totals-footer/. Next, modify the $viewdefs['Quotes']['base']['view']['quote-data-grand-totals-footer']['panels'][0]['fields'] index to add or remove your preferred fields.\nExample\nThe example below will remove the \"Shipping\" field (quotes.shipping) field from the layout.\n./custom/modules/Quotes/clients/base/views/quote-data-grand-totals-footer/quote-data-grand-totals-footer.php\n<?php\n$viewdefs['Quotes']['base']['view']['quote-data-grand-totals-footer'] = array(\n    'panels' => array(\n        array(\n            'name' => 'panel_quote_data_grand_totals_footer',\n            'label' => 'LBL_QUOTE_DATA_GRAND_TOTALS_FOOTER',\n            'fields' => array(\n                'quote_num',\n                array(\n                    'name' => 'new_sub',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-22", "text": "'quote_num',\n                array(\n                    'name' => 'new_sub',\n                    'type' => 'currency',\n                ),\n                array(\n                    'name' => 'tax',\n                    'type' => 'currency',\n                    'related_fields' => array(\n                        'taxrate_value',\n                    ),\n                ),\n                array(\n                    'name' => 'total',\n                    'label' => 'LBL_LIST_GRAND_TOTAL',\n                    'type' => 'currency',\n                    'css_class' => 'grand-total',\n                ),\n            ),\n        ),\n    ),\n);\nIf adding custom fields from the Quotes\u00c2\u00a0module to the view, you will also need to add that field to the related_fields array as outlined in the Record View documentation below. Once the files are in place, navigate to Admin > Repair > Quick Repair and Rebuild. Your changes will now be reflected in the system.\nRecord View\nThe record view for Quotes is updated and used like the standard Record View for all modules. The one major difference to note is that the JavaScript models used by the previous views above, are derived from the Model defined in the record view metadata.\nAdding Custom Related Fields to Model\nIn the Record View metadata, the first\u00c2\u00a0panel panel_header containing the picture and name fields for the Quote record, contains a related_fields property in the name definition that defines the related Product Bundles and Products data that is pulled into the JavaScript model. When custom fields are added to the above mentioned views you will need to add them to the related_fields property in their respective related module so that they are properly loaded during the page load.\nThe following example adds the custom_product_bundle_field_c field from the Product Bundles module, and the custom_product_field_c from the Products module into the retrieved Model.\n./custom/modules/Quotes/clients/base/views/record/record.php", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-23", "text": "./custom/modules/Quotes/clients/base/views/record/record.php\n<?php\n$viewdefs['Quotes']['base']['view']['record'] = array(\n    ...\n    'panels' => array(\n        array(\n            'name' => 'panel_header',\n            'label' => 'LBL_PANEL_HEADER',\n            'header' => true,\n            'fields' => array(\n                array(\n                    'name' => 'picture',\n                    'type' => 'avatar',\n                    'size' => 'large',\n                    'dismiss_label' => true,\n                    'readonly' => true,\n                ),\n                array(\n                   'name' => 'name',\n                   'events' => array(\n                       'keyup' => 'update:quote',\n                   ),\n                   'related_fields' => array(\n                       array(\n                           'name' => 'bundles',\n                           'fields' => array(\n                              'id',\n                              'bundle_stage',\n                              'currency_id',\n                              'base_rate',\n                              'currencies',\n                              'name',\n                              'deal_tot',\n                              'deal_tot_usdollar',\n                              'deal_tot_discount_percentage',\n                              'new_sub',\n                              'new_sub_usdollar',\n                              'position',\n                              'related_records',\n                              'shipping',\n                              'shipping_usdollar',\n                              'subtotal',\n                              'subtotal_usdollar',\n                              'tax',\n                              'tax_usdollar',\n                              'taxrate_id',\n                              'team_count',\n                              'team_count_link',\n                              'team_name',\n                              'taxable_subtotal',\n                              'total',\n                              'total_usdollar',\n                              'default_group',\n                              'custom_product_bundle_field_c',\n                              array(\n                                  'name' => 'product_bundle_items',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-24", "text": "array(\n                                  'name' => 'product_bundle_items',\n                                  'fields' => array(\n                                      'name',\n                                      'quote_id',\n                                      'description',\n                                      'quantity',\n                                      'product_template_name',\n                                      'product_template_id',\n                                      'deal_calc',\n                                      'mft_part_num',\n                                      'discount_price',\n                                      'discount_amount',\n                                      'tax',\n                                      'tax_class',\n                                      'subtotal',\n                                      'position',\n                                      'currency_id',\n                                      'base_rate',\n                                      'discount_select',\n                                      'custom_product_field_c',\n                                  ),\n                                  'max_num' => -1,\n                              ),\n                          ),\n                          'max_num' => -1,\n                          'order_by' => 'position:asc',\n                      ),\n                  ),\n              ),\n          ),\n      ),\n      ...\n  ),\n);\nQuote PDFs\nUngrouped Quoted Line Items and Notes\nAs of Sugar 7.9, the quotes module allows users to add quoted line items and notes without first adding a group. Adding at least one group to your quote was mandatory in earlier versions. This document will cover how to update your custom PDF templates to support ungrouped QLIs and notes. Ungrouped items are technically added to a default group. The goal is to exclude this group when no items exist in it.\nPDF Manager Templates\nIn your PDF Manager templates, you may have code similar to what is shown below to iterate over the groups in a quote:\n{foreach from=$product_bundles item=\"bundle\"}\n    ....\n{/foreach}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-25", "text": "{foreach from=$product_bundles item=\"bundle\"}\n    ....\n{/foreach}\nTo correct this for 7.9, we will need to add an if statement to check to see if the group is empty. If it is empty, it will be ignored in your PDF. The benefit is that it will also exclude any other empty groups in your quote and clean the generated PDF.\n{foreach from=$product_bundles item=\"bundle\"}\n    {if $bundle.products|@count}\n        ....\n    {/if}\n{/foreach}\nSmarty Templates\nIn Smarty templates, you may have code similar to what is shown below to iterate over the groups in a quote:\n{literal}{foreach from=$product_bundles item=\"bundle\"}{/literal}\n    ...\n{literal}{/foreach}{/literal}\nTo correct this for 7.9, we will need to add an if statement to check to see if the group is empty. If it is empty, it will be ignored in your PDF. The benefit is that it will also exclude any other empty groups in your quote and clean the generated PDF.\n{literal}{foreach from=$product_bundles item=\"bundle\"}{/literal}\n    {literal}{if $bundle.products|@count}{/literal}\n        ...\n    {literal}{/if}{/literal}\n{literal}{/foreach}{/literal}\nCreating Custom PDF Templates\nWith Sugar, there are generally two routes that can be taken to create custom PDF templates. The first and most recommended route is to use the PDF Manager found in the Admin > PDF Manager. The second route is to extend the Sugarpdf class and write your own template using PHP and the TCPDF library. This method should only be used if you are unable to accomplish your business needs through the PDF Manager.\nCreating the TCPDF Template", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-26", "text": "Creating the TCPDF Template\nThe first step is to create your custom TCPDF template in ./custom/modules/Quotes/sugarpdf/. For our example, we will extend QuotesSugarpdfStandard, found at ./modules/Quotes/sugarpdf/sugarpdf.standard.php, to a new file in ./custom/modules/Quotes/sugarpdf/ to create a custom invoice. The QuotesSugarpdfStandard class sets up our general quote requirements and extends the Sugarpdf class. Technical documentation on templating can be found in the Sugar PDF documentation. Our class will be named QuotesSugarpdfCustomInvoice as the naming must be in the format of <module>Sugarpdf<pdf view>.\n./custom/modules/Quotes/sugarpdf/sugarpdf.custominvoice.php\n<?php\nif (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nrequire_once('modules/Quotes/sugarpdf/sugarpdf.standard.php');\nclass QuotesSugarpdfCustomInvoice extends QuotesSugarpdfStandard\n{\n    function preDisplay()\n    {\n        global $mod_strings, $timedate;\n        parent::preDisplay();\n        $quote[0]['TITLE'] = $mod_strings['LBL_PDF_INVOICE_NUMBER'];\n        $quote[1]['TITLE'] = $mod_strings['LBL_PDF_QUOTE_DATE'];\n        $quote[2]['TITLE'] = $mod_strings['LBL_PURCHASE_ORDER_NUM'];\n        $quote[3]['TITLE'] = $mod_strings['LBL_PAYMENT_TERMS'];\n        $quote[0]['VALUE']['value'] = format_number_display($this->bean->quote_num, $this->bean->system_id);\n        $quote[1]['VALUE']['value'] = $timedate->nowDate();", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-27", "text": "$quote[1]['VALUE']['value'] = $timedate->nowDate();\n        $quote[2]['VALUE']['value'] = $this->bean->purchase_order_num;\n        $quote[3]['VALUE']['value'] = $this->bean->payment_terms;\n        // these options override the params of the $options array.\n        $quote[0]['VALUE']['options'] = array();\n        $quote[1]['VALUE']['options'] = array();\n        $quote[2]['VALUE']['options'] = array();\n        $quote[3]['VALUE']['options'] = array();\n        $html = $this->writeHTMLTable($quote, true, $this->headerOptions);\n        $this->SetHeaderData(PDF_HEADER_LOGO, PDF_HEADER_LOGO_WIDTH, $mod_strings['LBL_PDF_INVOICE_TITLE'], $html);\n    }\n    /**\n     * This method build the name of the PDF file to output.\n     */\n    function buildFileName()\n    {\n        global $mod_strings;\n        $fileName = preg_replace(\"#[^A-Z0-9\\-_\\.]#i\", \"_\", $this->bean->shipping_account_name);\n        if (!empty($this->bean->quote_num)) {\n            $fileName .= \"_{$this->bean->quote_num}\";\n        }\n        $fileName = $mod_strings['LBL_INVOICE'] . \"_{$fileName}.pdf\";\n        if (isset($_SERVER['HTTP_USER_AGENT']) && preg_match(\"/MSIE/\", $_SERVER['HTTP_USER_AGENT'])) {\n            //$fileName = $locale->translateCharset($fileName, $locale->getExportCharset());\n            $fileName = urlencode($fileName);\n        }\n        $this->fileName = $fileName;\n    }\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-28", "text": "}\n        $this->fileName = $fileName;\n    }\n}\nNext, register the layout. This is a two step process. The first step is to create ./custom/modules/Quotes/Layouts.php which will map our view action to the physical PHP file.\n./custom/modules/Quotes/Layouts.php\n<?php\n$layouts['CustomInvoice'] = 'custom/modules/Quotes/sugarpdf/sugarpdf.custominvoice.php';\nThe second step is to update the layouts_dom dropdown list by navigating to Admin > Dropdown Editor. Once there, create a new entry in the list with an Item Name of \"CustomInvoice\" and a Display Label of your choice. It's also recommended to remove the Quote and Invoice Templates if they are not being used to avoid confusion. This will create a ./custom/Extension/application/Ext/Language/en_us.sugar_layouts_dom.php file that should look similar to:\n./custom/Extension/application/Ext/Language/en_us.sugar_layouts_dom.php\n<?php\n$app_list_strings['layouts_dom']=array (\n  'CustomInvoice' => 'Custom Invoice',\n);\nOnce the layout is registered, we need to extend\u00c2\u00a0the pdfaction field for the Quotes module to render our custom pdf templates in the record view. An example of this is shown below:\n./custom/modules/Quotes/clients/base/fields/pdfaction/pdfaction.js\n/**\n * @class View.Fields.Base.Quotes.PdfactionField\n * @alias SUGAR.App.view.fields.BaseQuotesPdfactionField\n * @extends View.Fields.Base.PdfactionField\n */\n({\n    extendsFrom: 'PdfactionField',\n    /**\n     * @inheritdoc\n     * Create PDF Template collection in order to get available template list.\n     */\n    initialize: function(options) {\n        this._super('initialize', [options]);\n    },\n    /**", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-29", "text": "this._super('initialize', [options]);\n    },\n    /**\n     * Define proper filter for PDF template list.\n     * Fetch the collection to get available template list.\n     * @private\n     */\n    _fetchTemplate: function() {\n        this.fetchCalled = true;\n        var collection = this.templateCollection;\n        collection.filterDef = {'$and': [{\n            'base_module': this.module\n        }, {\n            'published': 'yes'\n        }]};\n        collection.fetch({\n            success: function(){\n                var models = [];\n                _.each(app.lang.getAppListStrings('layouts_dom'), function(template, id){\n                    var model = new Backbone.Model({\n                        id: id,\n                        name: template\n                    });\n                    models.push(model);\n                });\n                collection.add(models);\n            }\n        });\n    },\n    /**\n     * Build download link url.\n     *\n     * @param {String} templateId PDF Template id.\n     * @return {string} Link url.\n     * @private\n     */\n    _buildDownloadLink: function(templateId) {\n        var sugarpdf = this._isUUID(templateId)? 'pdfmanager' : templateId;\n        var urlParams = $.param({\n            'action': 'sugarpdf',\n            'module': this.module,\n            'sugarpdf': sugarpdf,\n            'record': this.model.id,\n            'pdf_template_id': templateId\n        });\n        return '?' + urlParams;\n    },\n    /**\n     * Build email pdf link url.\n     *\n     * @param {String} templateId PDF Template id.\n     * @return {string} Email pdf url.\n     * @private\n     */", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-30", "text": "* @return {string} Email pdf url.\n     * @private\n     */\n    _buildEmailLink: function(templateId) {\n        var sugarpdf = this._isUUID(templateId)? 'pdfmanager' : templateId;\n        return '#' + app.bwc.buildRoute(this.module, null, 'sugarpdf', {\n                'sugarpdf': sugarpdf,\n                'record': this.model.id,\n                'pdf_template_id': templateId,\n                'to_email': '1'\n            });\n    },\n    /**\n     * tests to see if a templateId is a uuid or template name.\n     *\n     * @param {String} templateId PDF Template id\n     * @return {boolean} true if uuid, false if not\n     * @private\n     */\n    _isUUID: function(templateId) {\n        var regex = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;\n        return regex.test(templateId);\n    }\n})\nOnce the files are in place, navigate to Admin > Repair > Quick Repair and Rebuild. Your changes will now be reflected in the system and navigating to a url in the format of index.php?module=Quotes&record=<record id>&action=sugarpdf&sugarpdf=CustomInvoice will generate the pdf document.\nHiding PDF Buttons", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-31", "text": "Hiding PDF Buttons\nIn some circumstances, users may not have a need to generate PDFs from Quotes. If this should occur, a developer can copy ./modules/Quotes/clients/base/views/record/record.php\u00c2\u00a0to ./custom/modules/Quotes/clients/base/views/record/record.php\u00c2\u00a0if it doesn't already exist. Next, find the array with a name of main_dropwdown in\u00c2\u00a0the $viewdefs['Quotes']['base']['view']['record']['buttons']\u00c2\u00a0index. Once found, you will then need to locate the buttons index within that\u00c2\u00a0array. You will then need to remove the following arrays from that index:\narray(\n    'type' => 'pdfaction',\n    'name' => 'download-pdf',\n    'label' => 'LBL_PDF_VIEW',\n    'action' => 'download',\n    'acl_action' => 'view',\n),\narray(\n    'type' => 'pdfaction',\n    'name' => 'email-pdf',\n    'label' => 'LBL_PDF_EMAIL',\n    'action' => 'email',\n    'acl_action' => 'view',\n),\nYour file should look similar to what is shown below:\ncustom/modules/Quotes/clients/base/views/record/record.php\n<?php\n$viewdefs['Quotes']['base']['view']['record'] = array(\n    'buttons' => array(\n        array(\n            'type' => 'button',\n            'name' => 'cancel_button',\n            'label' => 'LBL_CANCEL_BUTTON_LABEL',\n            'css_class' => 'btn-invisible btn-link',\n            'showOn' => 'edit',\n            'events' => array(\n                'click' => 'button:cancel_button:click',\n            ),\n        ),\n        array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-32", "text": "),\n        ),\n        array(\n            'type' => 'rowaction',\n            'event' => 'button:save_button:click',\n            'name' => 'save_button',\n            'label' => 'LBL_SAVE_BUTTON_LABEL',\n            'css_class' => 'btn btn-primary',\n            'showOn' => 'edit',\n            'acl_action' => 'edit',\n        ),\n        array(\n            'type' => 'actiondropdown',\n            'name' => 'main_dropdown',\n            'primary' => true,\n            'showOn' => 'view',\n            'buttons' => array(\n                array(\n                    'type' => 'rowaction',\n                    'event' => 'button:edit_button:click',\n                    'name' => 'edit_button',\n                    'label' => 'LBL_EDIT_BUTTON_LABEL',\n                    'acl_action' => 'edit',\n                ),\n                array(\n                    'type' => 'shareaction',\n                    'name' => 'share',\n                    'label' => 'LBL_RECORD_SHARE_BUTTON',\n                    'acl_action' => 'view',\n                ),\n                array(\n                    'type' => 'divider',\n                ),\n                array(\n                    'type' => 'convert-to-opportunity',\n                    'event' => 'button:convert_to_opportunity:click',\n                    'name' => 'convert_to_opportunity_button',\n                    'label' => 'LBL_QUOTE_TO_OPPORTUNITY_LABEL',\n                    'acl_module' => 'Opportunities',\n                    'acl_action' => 'create',\n                ),\n                array(\n                    'type' => 'divider',\n                ),\n                array(\n                    'type' => 'rowaction',\n                    'event' => 'button:historical_summary_button:click',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "0160c62e6b45-33", "text": "'event' => 'button:historical_summary_button:click',\n                    'name' => 'historical_summary_button',\n                    'label' => 'LBL_HISTORICAL_SUMMARY',\n                    'acl_action' => 'view',\n                ),\n                array(\n                    'type' => 'rowaction',\n                    'event' => 'button:audit_button:click',\n                    'name' => 'audit_button',\n                    'label' => 'LNK_VIEW_CHANGE_LOG',\n                    'acl_action' => 'view',\n                ),\n                array(\n                    'type' => 'rowaction',\n                    'event' => 'button:find_duplicates_button:click',\n                    'name' => 'find_duplicates_button',\n                    'label' => 'LBL_DUP_MERGE',\n                    'acl_action' => 'edit',\n                ),\n                array(\n                    'type' => 'divider',\n                ),\n                array(\n                    'type' => 'rowaction',\n                    'event' => 'button:delete_button:click',\n                    'name' => 'delete_button',\n                    'label' => 'LBL_DELETE_BUTTON_LABEL',\n                    'acl_action' => 'delete',\n                ),\n            ),\n        ),\n        array(\n            'name' => 'sidebar_toggle',\n            'type' => 'sidebartoggle',\n        ),\n    ),\n    ...\n);\nOnce the files are in place, navigate to Admin > Repair > Quick Repair and Rebuild. Your changes will now be reflected in the system.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Quotes/index.html"}
{"id": "bca86f5e13d9-0", "text": "Module Builder\nOverview\nThe Module Builder tool allows programmers to create custom modules without writing code and to create relationships between new and existing CRM modules. To illustrate how to use Module Builder, this article will show how to create and deploy a custom module.\nFor\u00c2\u00a0this example, a custom module to track media inquiries will be created to track public relations requests within a CRM system. This use case is an often requested enhancement for CRM systems that apply across industries.\nCreating New Modules\nModule Builder functionality is managed within the 'Developer Tools' section of Sugar's administration console.\nUpon selecting 'Module Builder', the user has the option of creating a \"New Package\". Packages are a collection of custom modules, objects, and fields that can be published within the application instance or shared across instances of Sugar. Once the user selects \"New Package\", the usernames and describes the type of Custom Module to be created. A package key, usually based on the organization or name of the package creator is required to prevent conflicts between two packages with the same name from different authors. In this case, the package will be named \"MediaTracking\" to explain its purpose, and a key based on the author name will be used.\nOnce the new package is created and saved, the user is presented with a screen to create a Custom Module. Upon selecting the \"New Module\" icon, a screen appears showing six different object templates.\nUnderstanding Object Templates", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Builder/index.html"}
{"id": "bca86f5e13d9-1", "text": "Understanding Object Templates\nFive of the six object templates contain pre-built CRM functionality for key CRM use cases. These objects are:\"basic\", \"company\", \"file\", \"issue\", \"person\", and \"sale\". The \"basic\" template provides fields such as Name, Assigned to, Team, Date Created, and Description. As their title denotes, the rest of these templates contain fields and application logic to describe entities similar to \"Accounts\", \"Documents, \"Cases\", \"Contacts\", and \"Opportunities\", respectively. Thus, to create a Custom Module to track a type of account, you would select the \"Company\" template. Similarly, to track human interactions, you would select \"People\".\nFor the media tracking use case, the user will use the object template \"Issue\" because inbound media requests have similarities to incoming support cases. In both examples, there is an inquiry, a recipient of the issue, assignment of the issue and resolution. The final object template is named \"Basic\" which is the default base object type. This allows the administrator to create their own custom fields to define the object.\nUpon naming and selecting the Custom Module template named \"Issue\", the user can further customize the module by changing the fields and layout of the application and creating relationships between this new module and existing standard or custom modules. This Edit functionality allows a user to construct a module that meets the specific data requirements of the Custom Module.\nEditing Module Fields\nFields can be edited and created using the field editor. Fields inherited from the custom module's templates can be relabeled while new fields are fully editable. New fields are added using the Add Field button. This displays a tab where you can select the type of field to add as well as any properties that field-type requires.\nEditing Module Layouts", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Builder/index.html"}
{"id": "bca86f5e13d9-2", "text": "Editing Module Layouts\nThe layout editor can be used to change the appearance of the screens within the new module, including the EditView, DetailView and ListView screens. When editing the Edit View or the Detail View, new panels and rows can be dragged from the toolbox on the left side to the layout area on the right. Fields can then be dragged between the layout area and the toolbox. Fields are removed from the layout by dragging them from the layout area to the recycling icon. Fields can be expanded or collapsed to take up one or two columns on the layout using the plus and minus icons. The\u00c2\u00a0List, Search, Dashlet, and Subpanel views can be edited by dragging fields between hidden/visible/available columns.\nBuilding Relationships\nOnce the fields and layout of the Custom Module have been defined, the user then defines relationships between this new module and existing CRM data by clicking \"View Relationships\". The \"Add Relationship\" button allows the user to associate the new module to an existing or new custom module in the same package. In the case of the Media Tracker, the user can associate the Custom Module with the existing, standard 'Contacts' module that is available in every Sugar installation using a many-to-many relationship. By creating this relationship, end-users will see the Contacts associated with each Media Inquiry. We will also add a relationship to the activities module so that a Media Inquiry can be related to calls, meetings, tasks, and emails.\nPublishing and Uploading Packages", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Builder/index.html"}
{"id": "bca86f5e13d9-3", "text": "Publishing and Uploading Packages\nAfter the user has created the appropriate fields, layouts, and relationships for the custom modules, this new CRM functionality can be deployed. Click the \"Deploy\" button to deploy the package to the current instance. This is the recommended way to test your package while developing. If you wish to make further changes to your package or custom modules, you should make those changes in Module Builder, and click the Deploy button again. Clicking the Publish button generates a zip file with the Custom Module definitions. This is the mechanism for moving the package to a test environment and then ultimately to the production environment. The Export button will produce a module loadable zip file, similar to the Publish functionality, except that when the zip file is installed, it will load the custom package into Module Builder for further editing. This is a good method for storing the custom package in case you would like to make changes to it in the future on another Sugar instance. Once your module has been deployed in a production environment, we highly recommend that you do not redeploy the module in Module Builder but modify the module using Studio as outlined in our Best Practices When Building Custom Modules.\nAfter the new package has been published, the administrator must commit the package to the Sugar system through the Module Loader. The administrator uploads the files and commits the new functionality to the live application instance.\nNote: Sugar Sell Essentials customers do not have the ability to upload custom file packages to Sugar using Module Loader.\nAdding Custom Logic Using Code\nWhile the key benefit of the Module Builder is that the Administrator user is able to create entirely new modules without the need to write code, there are still some tasks that require writing PHP code. For instance, adding custom logic or making a call to an external system through a Web Service. This can be done in one of two methods.\nLogic Hooks", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Builder/index.html"}
{"id": "bca86f5e13d9-4", "text": "Logic Hooks\nOne way is by writing PHP code that leverages the event handlers, or \"logic hooks\", available in Sugar. In order to accomplish this, the developer must create the custom code and then add it to the manifest file for the \"Media Inquiry\" package. More information on creating logic hooks can be found in the Logic Hooks section. Information on adding a hook to your installer package can be found in the\u00c2\u00a0Creating an Installable Package for a Logic Hook example.\nCustom Bean files\nAnother method is to add code directly to the custom bean. This is a more complicated approach because it requires understanding the SugarBean class. However, it is a far more flexible and powerful approach.\nFirst, you must \"build\" your module. This can be done by either deploying your module or clicking the Publish button. Module Builder will then generate a folder for your package in ./custom/modulebuilder/builds/. Inside that folder is where Sugar will have placed the bean files for your new module(s). In this case, we want ./custom/modulebuilder/builds/MediaTracking/SugarModules/modules/jsche_mediarequest/\nInside you will find two files of interest. The first one is {module_name}sugar.php. This file is generated by Module Builder and may be erased by further changes in module builder or upgrades to the Sugar application. You should not make any changes to this file. The second is {module_name}.php. This is the file where you make any changes you would like to the logic of your module. To add our timestamp, we would add the following code to jsche_mediarequest.php\nfunction save($check_notify = FALSE)\n{\n     global $current_user;\n     $this->description .= \"Saved on \" . date(\"Y-m-d g:i a\"). \" by \". $current_user->user_name;\n     parent::save($check_notify);\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Builder/index.html"}
{"id": "bca86f5e13d9-5", "text": "parent::save($check_notify);\n}\nThe call to the parent::save function is critical as this will call on the out of box SugarBean to handle the regular Save functionality. To finish, re-deploy or re-publish your package from Module Builder.\nYou can now upload this module, extended with custom code logic, into your Sugar application using the Module Loader as described earlier.\nUsing the New Module\nAfter you upload the new module, the new custom module appears in the Sugar instance. In this example, the new module, named \"Media\" uses the object template \"Issue\" to track incoming media inquiries. This new module is associated with the standard \"Contacts\" modules to show which journalist has expressed interest. In this example, the journalist has requested a product briefing. On one page, users can see the nature of the inquiry, the journalist who requested the briefing, who the inquiry was assigned to, the status, and the description.\nTopicsBest PracticesSugar provides two tools for building and maintaining custom module configurations: Module Builder and Studio. As an administrator of Sugar, it is important to understand the strengths of both tools so that you have a sound development process as you look to build on Sugar's framework.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Builder/index.html"}
{"id": "df06082ec149-0", "text": "Best Practices\nOverview\nSugar provides two tools for building and maintaining custom module configurations: Module Builder and Studio. As an administrator of Sugar, it is important to understand the strengths of both tools so that you have a sound development process as you look to build on Sugar's framework.\nGoal\nThis guide will provide you with all the necessary steps from initial definition of your module to the configuration and customization of the module functionality. Follow these tips to ensure your development process will be sound:\nBuild Your Module in Module Builder\nBuild the initial framework for your module in Module Builder. Add all the fields you feel will be necessary for the module and construct the layouts with those fields. If possible, it is even better to create your custom modules in a development environment that mirrors your production environment.\nNever Redeploy a Package\nOnce a module has been promoted to a production environment, we recommend only making additional changes in Studio.\u00c2\u00a0Redeploying a package will remove all customizations related to your module in the following directories:\n./modules/\n./custom/modules/\n./custom/Extension/modules/\nThis includes workflows, code customizations, changes through Studio, and much more. It is imperative that this directive is followed to ensure any desired configurations remain intact. When working in Studio, you can make the following types of changes:\nadding a new field\nupdating the properties of a field that has been deployed with the module\nchanging field layouts\ncreating, modifying and removing relationships\nEvery Module in Module Builder Gets Its Very Own Package\nWhile it is possible to create multiple modules in a package, this can also cause design headaches down the road. If you end up wanting to uninstall a module and it is part of a larger package, all modules in that package would need to be uninstalled. Keeping modules isolated to their own packages allows greater flexibility in the future if a module is no longer needed.\nCreate Relationships in Studio After the Module Is Deployed", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Builder/Best_Practices_When_Building_Custom_Modules/index.html"}
{"id": "df06082ec149-1", "text": "Create Relationships in Studio After the Module Is Deployed\nThis part is critical for success as relationships created in Module Builder cannot be removed after the module is deployed unless the package is updated and redeployed from Module Builder. Redeploying from Module Builder is what we are trying to avoid as mentioned above. If you deploy the module and then create the relationships in Studio, you can update or remove the relationships via Studio at any future point in time.\nDelete the Package from Module Builder Once It Is Deployed\nOnce the package is deployed, delete it from Module Builder so that it will not accidentally be redeployed. The only exception to this rule is in a development environment as you may want to continue working and testing until you are ready to move the module to your production environment. If you ever want to uninstall the module at a later date, you can do so under Admin > Module Loader.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Builder/Best_Practices_When_Building_Custom_Modules/index.html"}
{"id": "c9c98e9f5287-0", "text": "Filters\nOverview\nFilters are a way to predefine searches\u00c2\u00a0on views that render a list of records\u00c2\u00a0such as list views, pop-up searches, and lookups.\u00c2\u00a0This page\u00c2\u00a0explains how\u00c2\u00a0to implement the various types of filters for record list views.\u00c2\u00a0\nFilters contain the following properties:\nProperty\nType\nDescription\nid\nString\nA unique identifier for the filter\nname\nString\u00c2\u00a0\nThe label key for the display label\u00c2\u00a0of the filter\nfilter_definition\nArray\nThe filter definition to apply to the results\neditable\nBoolean\u00c2\u00a0\nDetermines whether the user can edit the filter. Note:\u00c2\u00a0If you are creating a predefined filter for a user, this should be set to\u00c2\u00a0false\nis_template\nBoolean\nUsed with initial pop-up filters to determine if the\u00c2\u00a0filter is available as a template\nNote: If a filter contains custom fields, those fields must be search-enabled in Studio > {Module Name} > Layouts > Search.\nOperators\nOperators, defined in ./clients/base/filters/operators/operators.php, are expressions used by a\u00c2\u00a0filter to represent query\u00c2\u00a0operators. They are constructed in the\u00c2\u00a0filter_definition to help generate the appropriate query syntax that is sent to the database for a specific field type. Operators can be defined on a global or module level. The accepted paths are listed below:\n./clients/base/filters/operators/operators.php\n./custom/clients/base/filters/operators/operators.php\n./modules/<module>/clients/base/filters/operators.php\n./custom/modules/<module>/clients/base/filters/operators.php\nThe list of stock operators is shown below:\nOperator\nLabel / Key\nDescription\n$contains\nis any of / LBL_OPERATOR_CONTAINSUsed by multienum\nMatches anything that contains the value.\n$empty\nis empty / LBL_OPERATOR_EMPTYUsed by enum and tag\nMatches on empty values.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Filters/index.html"}
{"id": "c9c98e9f5287-1", "text": "is empty / LBL_OPERATOR_EMPTYUsed by enum and tag\nMatches on empty values.\n$not_contains\nis not any of / LBL_OPERATOR_NOT_CONTAINSUsed by multienum\nMatches anything that does not contain the specified value.\n$not_empty\nis not empty / LBL_OPERATOR_NOT_EMPTYUsed by enum and tag\nMatches on non-empty values.\n$in\nis any of / LBL_OPERATOR_CONTAINSUsed by enum, int, relate, teamset, and tag\nFinds anything where field matches one of the values as specified as an array.\n$not_in\nis not any of / LBL_OPERATOR_NOT_CONTAINSUsed by enum, relate, teamset, and tag\nFinds anything where the field does not match any of the values in the specified array of values.\n$equals\nexactly matches / LBL_OPERATOR_MATCHESUsed by varchar, name, email, text, and textarea\nis equal to / LBL_OPERATOR_EQUALSUsed by currency, int, double, float, decimal, and date\nis / LBL_OPERATOR_ISUsed by bool, phone, radioenum, and parent\nPerforms an exact match on that field.\n$starts\nstarts with / LBL_OPERATOR_STARTS_WITHUsed by varchar, name, email, text, textarea, and phone\nis equal to / LBL_OPERATOR_EQUALSUsed by datetime and datetimecombo\nMatches on anything that starts with the value.\n$not_equals\nis not equal to / LBL_OPERATOR_NOT_EQUALSUsed by currency, int, double, float, and decimal\nis not / LBL_OPERATOR_IS_NOTUsed by radioenum\nMatches on non-matching values.\n$gt\nis greater than / LBL_OPERATOR_GREATER_THANUsed by currency, int, double, float, and decimal\nafter / LBL_OPERATOR_AFTERUsed by date\nMatches when the field is greater than the value.\n$lt", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Filters/index.html"}
{"id": "c9c98e9f5287-2", "text": "Matches when the field is greater than the value.\n$lt\nis less than / LBL_OPERATOR_LESS_THANUsed by currency, int, double, float, and decimal\nbefore / LBL_OPERATOR_BEFOREUsed by date\nMatches when the field is less than the value.\n$gte\nis greater than or equal to / LBL_OPERATOR_GREATER_THAN_OR_EQUALSUsed by currency, int, double, float, and decimal\nafter / LBL_OPERATOR_AFTERUsed by datetime and datetimecombo\nMatches when the field is greater than or equal to the value\n$lte\nis less than or equal to / LBL_OPERATOR_LESS_THAN_OR_EQUALSUsed by currency, int, double, float, and decimal\nbefore / LBL_OPERATOR_BEFOREUsed by datetime and datetimecombo\nMatches when the field is less than or equal to the value.\n$between\nis between / LBL_OPERATOR_BETWEENUsed by currency, int, double, float, and decimal\nMatches when a numerical value is between two other numerical values.\nlast_7_days\nlast 7 days / LBL_OPERATOR_LAST_7_DAYSUsed by date, datetime, and datetimecombo\nMatches date in the last 7 days relative to the current date.\nnext_7_days\nnext 7 days / LBL_OPERATOR_NEXT_7_DAYSUsed by date, datetime, and datetimecombo\nMatches dates in the next 7 days relative to the current date.\nlast_30_days\nlast 30 days / LBL_OPERATOR_LAST_30_DAYSUsed by date, datetime, and datetimecombo\nMatches dates in the last 30 days relative to the current date.\nnext_30_days\nnext 30 days / LBL_OPERATOR_NEXT_30_DAYSUsed by date, datetime, and datetimecombo\nMatches dates in the next 30 days relative to the current date.\nlast_month\nlast month / LBL_OPERATOR_LAST_MONTHUsed by date, datetime, and datetimecombo", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Filters/index.html"}
{"id": "c9c98e9f5287-3", "text": "last month / LBL_OPERATOR_LAST_MONTHUsed by date, datetime, and datetimecombo\nMatches dates in the previous month relative to the current month.\nthis_month\nthis month / LBL_OPERATOR_THIS_MONTHUsed by date, datetime, and datetimecombo\nMatches dates in the current month.\nnext_month\nnext month / LBL_OPERATOR_NEXT_MONTHUsed by date, datetime, and datetimecombo\nMatches dates in the next month relative to the current month.\nlast_year\nlast year / LBL_OPERATOR_LAST_YEARUsed by date, datetime, and datetimecombo\nMatches dates in the last year relative to the current year.\nthis_year\nthis year / LBL_OPERATOR_THIS_YEARUsed by date, datetime, and datetimecombo\nMatches dates in the current year.\nnext_year\nnext year / LBL_OPERATOR_NEXT_YEARUsed by date, datetime, and datetimecombo\nMatches dates in the next year relative to the current year.\n$dateBetween\nis between / LBL_OPERATOR_BETWEENUsed by date, datetime, and datetimecombo\nMatches dates between two given dates.\nyesterday\nyesterday / LBL_OPERATOR_YESTERDAYUsed by date, datetime, and datetimecombo\nMatches dates on yesterday relative to the current date.\ntoday\ntoday / LBL_OPERATOR_TODAYUsed by date, datetime, and datetimecombo\nMatches dates in the current date.\ntomorrow\ntomorrow / LBL_OPERATOR_TOMORROWUsed by date, datetime, and datetimecombo\nMatches dates on tomorrow relative to the current date.\nExample\nThe example below defines a filter where the type field must contain the value Customer and the name\u00c2\u00a0field must start with the letter\u00c2\u00a0A.\n$filters = array(\n    array(\n        'type' => array(\n            '$in' => array(\n                'Customer',\n            ),\n        ),\n    ),\n    array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Filters/index.html"}
{"id": "c9c98e9f5287-4", "text": "'Customer',\n            ),\n        ),\n    ),\n    array(\n        'name' => array(\n            '$starts' => 'A',\n        ),\n    ),\n);\nSub-Expressions\nSub-expressions group filter expressions into groupings. By default, all expressions are bound by an $and\u00c2\u00a0expression grouping.\u00c2\u00a0\nSub-Expression\nDescription\n$and\nJoins the filters in an \"and\" expression\n$or\nJoins the filters in an \"or\" expression\nNote: Sub-Expressions are only applicable to predefined filters and cannot be used for initial filters.\u00c2\u00a0\nThe example below defines a filter where the name field must begin with the letters\u00c2\u00a0A or C.\n$filters = array(\n    '$or' => array (\n        array(\n            'name' => array(\n                '$starts' => 'A',\n            ),\n        ),\n        array(\n            'name' => array(\n                '$starts' => 'C',\n            ),\n        ),\n    )\n);\nModule Expressions\nModule expressions\u00c2\u00a0operate on modules instead of specific fields. The current module can be specified by either using the module name _this or by leaving the module name as a blank string.\nModule Expression\nDescription\n$favorite\nFilters the records by the current users favorited items.\n$owner\nFilters the records by the assigned user.\nThe example below defines a filter where records must be favorited items.\n$filters = array(\n    array(\n        '$favorite' => '_this'\n    ),\n);\nFilter Examples\nAdding Predefined Filters to the List View Filter List\nTo add a predefined filter to the module's list view, create a new filter definition extension, which will append the filter to the module's viewdefs.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Filters/index.html"}
{"id": "c9c98e9f5287-5", "text": "The following example will demonstrate how to add a predefined filter on the Accounts module to return all records with an account type of \"Customer\" and industry of \"Other\".\nTo create a predefined filter, create a display label extension in \u00c2\u00a0./custom/Extension/modules/<module>/Ext/Language/. For this example, we will create:\n./custom/Extension/modules/Accounts/Ext/Language/en_us.filterAccountByTypeAndIndustry.php\n<?php\n$mod_strings['LBL_FILTER_ACCOUNT_BY_TYPE_AND_INDUSTRY'] = 'Customer/Other Accounts';\nNext, create a\u00c2\u00a0custom filter extension in \u00c2\u00a0./custom/Extension/modules/<module>/Ext/clients/base/filters/basic/.\nFor this example,\u00c2\u00a0we will create:\n./custom/Extension/modules/Accounts/Ext/clients/base/filters/basic/filterAccountByTypeAndIndustry.php\n<?php\n$viewdefs['Accounts']['base']['filter']['basic']['filters'][] = array(\n    'id' => 'filterAccountByTypeAndIndustry',\n    'name' => 'LBL_FILTER_ACCOUNT_BY_TYPE_AND_INDUSTRY',\n    'filter_definition' => array(\n        array(\n            'account_type' => array(\n                '$in' => array(\n                    'Customer',\n                ),\n            ),\n        ),\n        array(\n            'industry' => array(\n                '$in' => array(\n                    'Other',\n                ),\n            ),\n        ),\n    ),\n    'editable' => false,\n    'is_template' => false,\n);\nYou should notice that the editable and is_template options have been set to \"false\". If editable is not set to \"false\", the filter will not be displayed in the list view filter's list.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Filters/index.html"}
{"id": "c9c98e9f5287-6", "text": "Finally, navigate to Admin > Repair and click \"Quick Repair and Rebuild\" to rebuild the extensions and make the predefined filter available for users.\nAdding Initial Filters to Lookup Searches\nTo add initial filters to record lookups and type-ahead searches, define a filter template. This will allow you\u00c2\u00a0to filter results for users when looking up a parent related record.\u00c2\u00a0The following example will demonstrate how to add an initial filter for the Account lookup on the Contacts module. This initial filter will limit records\u00c2\u00a0to having an\u00c2\u00a0account type of \"Customer\" and a dynamically assigned user value determined by the contact's assigned user.\nTo add an initial filter to the Contacts record view, create a display label for the filter in ./custom/Extension/modules/<module>/Ext/Language/.\u00c2\u00a0For this example , we will create:\n./custom/Extension/modules/Accounts/Ext/Language/en_us.filterAccountTemplate.php\n<?php\n$mod_strings['LBL_FILTER_ACCOUNT_TEMPLATE'] = 'Customer Accounts By A Dynamic User';\nNext, create a\u00c2\u00a0custom template filter extension in \u00c2\u00a0./custom/Extension/modules/<module>/Ext/clients/base/filters/basic/. For this example, create:\n./custom/Extension/modules/Accounts/Ext/clients/base/filters/basic/filterAccountTemplate.php\n<?php\n$viewdefs['Accounts']['base']['filter']['basic']['filters'][] = array(\n    'id' => 'filterAccountTemplate',\n    'name' => 'LBL_FILTER_ACCOUNT_TEMPLATE',\n    'filter_definition' => array(\n        array(\n            'account_type' => array(\n                '$in' => array(),\n            ),\n        ),\n        array(\n            'assigned_user_id' => ''\n        )\n    ),\n    'editable' => true,\n    'is_template' => true,\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Filters/index.html"}
{"id": "c9c98e9f5287-7", "text": "'editable' => true,\n    'is_template' => true,\n);\nAs you can see, the filter_definition contains arrays for account_type and assigned_user_id. These filter definitions will receive their values from the contact record view's metadata. You should also note that this filter has\u00c2\u00a0is_template and editable set to \"true\". This is required for initial filters.\nOnce the filter template is in place, modify the contact record view's metadata. To accomplish this, edit ./custom/modules/Contacts/clients/base/views/record/record.php to adjust the account_name field. If this file does not exist in your local Sugar installation, navigate to Admin > Studio > Contacts > Layouts > Record View and click \"Save & Deploy\" to generate it. In this file, identify\u00c2\u00a0the panel_body array as shown below:\n1 => \narray (\n    'name' => 'panel_body',\n    'label' => 'LBL_RECORD_BODY',\n    'columns' => 2,\n    'labelsOnTop' => true,\n    'placeholders' => true,\n    'newTab' => false,\n    'panelDefault' => 'expanded',\n    'fields' => \n    array (\n        0 => 'title',\n        1 => 'phone_mobile',\n        2 => 'department',\n        3 => 'do_not_call',\n        4 => 'account_name',\n        5 => 'email',\n    ),\n),\nNext, modify the account_name field to contain the\u00c2\u00a0initial filter parameters.\u00c2\u00a0\n1 =>\narray (\n    'name' => 'panel_body',\n    'label' => 'LBL_RECORD_BODY',\n    'columns' => 2,\n    'labelsOnTop' => true,\n    'placeholders' => true,\n    'newTab' => false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Filters/index.html"}
{"id": "c9c98e9f5287-8", "text": "'placeholders' => true,\n    'newTab' => false,\n    'panelDefault' => 'expanded',\n    'fields' =>\n    array (\n        0 => 'title',\n        1 => 'phone_mobile',\n        2 => 'department',\n        3 => 'do_not_call',\n        4 => array (\n            //field name\n            'name' => 'account_name',\n            //the name of the filter template\n            'initial_filter' => 'filterAccountTemplate',\n            //the display label for users\n            'initial_filter_label' => 'LBL_FILTER_ACCOUNT_TEMPLATE',\n            //the hardcoded filters to pass to the templates filter definition\n            'filter_populate' => array(\n                'account_type' => array('Customer')\n            ),\n            //the dynamic filters to pass to the templates filter definition\n            //please note the index of the array will be for the field the data is being pulled from\n            'filter_relate' => array(\n                //'field_to_pull_data_from' => 'field_to_populate_data_to'\n                'assigned_user_id' => 'assigned_user_id',\n            )\n        ),\n        5 => 'email',\n    ),\n),\nFinally, navigate to Admin > Repair and click\u00c2\u00a0\"Quick Repair and Rebuild\". This will rebuild the extensions and make the initial\u00c2\u00a0filter available for users when selecting a parent account for a contact.\nAdding Initial Filters to Drawers from a Controller\nWhen creating your own views, you may need to filter a drawer called from within your custom controller. Using an initial filter, as described in the Adding Initial Filters to Lookup Searches\u00c2\u00a0section, we can filter a drawer with predefined values by creating a filter object and\u00c2\u00a0populating the config.filter_populate\u00c2\u00a0property as shown below:\n//create filter", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Filters/index.html"}
{"id": "c9c98e9f5287-9", "text": "//create filter\nvar filterOptions = new app.utils.FilterOptions()\n    .config({\n        'initial_filter': 'filterAccountTemplate',\n        'initial_filter_label': 'LBL_FILTER_ACCOUNT_TEMPLATE',\n        'filter_populate': {\n            'account_type': ['Customer'],\n            'assigned_user_id': 'seed_sally_id'\n        }\n    })\n    .format();\n//open drawer\napp.drawer.open({\n    layout: 'selection-list',\n    context: {\n        module: 'Accounts',\n        filterOptions: filterOptions,\n        parent: this.context\n    }\n});\nTo create a filtered drawer with dynamic values, create a filter object and populate the config.filter_relate property using the populateRelate method as shown below:\n//record to filter related fields by\nvar contact = app.data.createBean('Contacts', {\n    'first_name': 'John',\n    'last_name': 'Smith',\t\t\n    'assigned_user_id': 'seed_sally_id'\n});\n//create filter\nvar filterOptions = new app.utils.FilterOptions()\n    .config({\n        'initial_filter': 'filterAccountTemplate',\n        'initial_filter_label': 'LBL_FILTER_ACCOUNT_TEMPLATE',\n        'filter_populate': {\n            'account_type': ['Customer'],\n        },\n        'filter_relate': {\n            'assigned_user_id': 'assigned_user_id'\n        }\n    })\n    .populateRelate(contact)\n    .format();\n//open drawer\napp.drawer.open({\n    layout: 'selection-list',\n    context: {\n        module: 'Accounts',\n        filterOptions: filterOptions,\n        parent: this.context\n    }\n});\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Filters/index.html"}
{"id": "db79c742d3c6-0", "text": "Logging\nOverview\nThere are two logging systems implemented in the Sugar application: SugarLogger and PSR-3.\u00c2\u00a0PSR-3\u00c2\u00a0is Sugar's preferred logger solution and should be used going forward.\nPSR-3\nPSR-3 compliant logging solution has been implemented based on PHP Monolog.\u00c2\u00a0\nLog Levels\nLog Level\nDescription\nDebug\nLogs events that help in debugging the application\nInfo\nLogs informational messages and database queries\nWarning\nLogs potentially harmful events\nNotice\nLogs messages for deprecated methods that are still in use.\nError\nLogs error events in the application\nAlert\nLogs severe error events that may cause the application to abort. This is the default and recommended level.\nCritical\nLogs events that may compromise the security of the application\nOff\nTurns off all logging\nWhen you specify a logging level, the system will record messages for the specified level as well as all higher levels. For example, if you specify \"Error\", the system records all Error, Fatal, and Security messages. More information on logging levels can be found in the\u00c2\u00a0logger level\u00c2\u00a0configuration documentation.\nConsiderations\nWhen you are not troubleshooting Sugar, the log level should be set\u00c2\u00a0to\u00c2\u00a0Fatal\u00c2\u00a0in\u00c2\u00a0Admin > System Settings > Logger Settings to\u00c2\u00a0ensure that your environment is not wasting unnecessary\u00c2\u00a0resources to write to the Sugar log.\nLogging Messages\nThe PSR-3 implementation in Sugar can also be used to log messages to the Sugar Log file. You can utilize the implementation to log to the Sugar log file using the default channel or you can specify your own custom channel if you want further control over when your custom logs should be displayed.\u00c2\u00a0\nuse \\Sugarcrm\\Sugarcrm\\Logger\\Factory;\n//Get the default Logger\n$Logger = Factory::getLogger('default');\n$Logger->debug('Debug level message');", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/index.html"}
{"id": "db79c742d3c6-1", "text": "$Logger->debug('Debug level message'); \n$Logger->info('Info level message'); \n$Logger->notice('Notice level message');\n$Logger->warning('Warning level message'); \n$Logger->error('Error level message'); \n$Logger->critical('Critical level message');\n$Logger->alert('Alert level message');\n$Logger->emergency('Emergency level message');\n//Get a custom Log Channel\n$Logger = Factory::getLogger('my_logger');\nNote: For more information on using custom channels, adding custom log handlers and processors see the PSR-3 Logger\u00c2\u00a0documentation.\n\u00c2\u00a0\nSugarLogger\nThe SugarLogger class, located in ./include/SugarLogger/SugarLogger.php, allows for developers and system administrators to log system events to a log file. Sugar then determines which events to write to the log based on the system's Log Level. This can be set in Admin > System Settings.\nLog Levels\nLog Level\nDescription\nDebug\nLogs events that help in debugging the application\nInfo\nLogs informational messages and database queries\nWarn\nLogs potentially harmful events\nDeprecated\nLogs messages for deprecated methods that are still in use.\nError\nLogs error events in the application\nFatal\nLogs severe error events that may cause the application to abort. This is the default and recommended level.\nSecurity\nLogs events that may compromise the security of the application\nOff\nLogging is turned off\nWhen you specify a logging level, the system will record messages for the specified level as well as all higher levels. For example, if you specify \"Error\", the system records all Error, Fatal, and Security messages. More information on logging levels can be found in the logger level documentation.\nConsiderations", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/index.html"}
{"id": "db79c742d3c6-2", "text": "Considerations\nWhen you are not troubleshooting Sugar, the log level should be set to Fatal\u00c2\u00a0in Admin > System Settings > Logger Settings to\u00c2\u00a0ensure that your environment is not wasting unnecessary\u00c2\u00a0resources to write to the Sugar log.\nLogging Messages\nUsing $GLOBALS['log']\nHow to log messages using $GLOBALS['log'] in the system.\n$GLOBALS['log']->debug('Debug level message'); \n$GLOBALS['log']->info('Info level message'); \n$GLOBALS['log']->warn('Warn level message');\n$GLOBALS['log']->deprecated('Deprecated level message');\n$GLOBALS['log']->error('Error level message');\n$GLOBALS['log']->fatal('Fatal level message');\n$GLOBALS['log']->security('Security level message');\nFor more information on the implementation, please refer to\u00c2\u00a0the\u00c2\u00a0SugarLogger documentation.\u00c2\u00a0\nUsing LoggerManager\nHow to log messages using the LoggerManager.\u00c2\u00a0\n$Logger = \\LoggerManager::getLogger();\n$Logger->debug('Debug level message');\n$Logger->info('Info level message');\n$Logger->warn('Warn level message');\n$Logger->deprecated('Deprecated level message');\n$Logger->error('Error level message');\n$Logger->fatal('Fatal level message');\n$Logger->security('Security level message');\nFor more information on the implementation, please refer to\u00c2\u00a0the\u00c2\u00a0SugarLogger\u00c2\u00a0documentation.\u00c2\u00a0\nLog Rotation", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/index.html"}
{"id": "db79c742d3c6-3", "text": "Log Rotation\nThe\u00c2\u00a0SugarLogger\u00c2\u00a0will\u00c2\u00a0automatically rotate the logs when the\u00c2\u00a0logger.file.maxSize\u00c2\u00a0configuration setting has been met or exceeded. When this happens, the Sugar log will be renamed with an integer. For example, if the Sugar log was\u00c2\u00a0named \"sugarcrm.log, it will then be renamed \"sugarcrm_1.log\". The next log rotation after that would create \"sugarcrm_2.log\". This will occur until the\u00c2\u00a0logger.file.maxLogs\u00c2\u00a0configuration setting has been met. Once met, the\u00c2\u00a0log rollover will start over.\nDebugging Messages with _ppl()\nWhen developing, it may be beneficial for a developer to use _ppl()\u00c2\u00a0method to log a message to the Sugar log. The _ppl() method handles converting Objects, so you can quickly dump an entire object to the log while testing during development.\u00c2\u00a0\n_ppl('Debugging message');\nThis will write a message to the Sugar log that defines the message and file location. An example is shown below:\n------------------------------ _ppLogger() output start -----------------------------\nDebugging message\n------------------------------ _ppLogger() output end -----------------------------\n------------------------------ _ppLogger() file: myFile.php line#: 5-----------------------------\n\u00c2\u00a0Note: It is important that you remove _ppl() from your code for production use as it will affect system performance.\nTopicsCreating Custom LoggersCustom loggers, defined in ./custom/include/SugarLogger/, can be used to write log entries to a centralized application management tool or to write messages to a developer tool such as FirePHP.PSR-3 LoggerMonolog\\Handler\\HandlerInterfaceSugarLoggerThe SugarLogger is used for log reporting by the application. The following article outlines the LoggerTemplate interface as well as the LoggerManager object and explains how to programmatically use the SugarLogger.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/index.html"}
{"id": "db79c742d3c6-4", "text": "Last modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/index.html"}
{"id": "328c004d216b-0", "text": "SugarLogger\nOverview\nThe SugarLogger\u00c2\u00a0is used for log reporting by the application. The following article outlines the\u00c2\u00a0LoggerTemplate\u00c2\u00a0interface\u00c2\u00a0as well as the\u00c2\u00a0LoggerManager object and explains how to programmatically use the SugarLogger.\nLoggerTemplate\nThe LoggerManager manages those objects that implement the LoggerTemplate interface found in ./include/SugarLogger/LoggerTemplate.php.\u00c2\u00a0\nMethods\nlog($method, $message)\nThe LoggerTemplate has a single method that should be implemented, which is the log() method.\nArguments\nName\nType\nDescription\n$method\nString\nThe method or level which the Logger should handle the provided message\n$message\nString\nThe logged message\nImplementations\nSugar comes with two stock LoggerTemplate implementations that can be utilized for different scenarios depending on your needs. You can extend from these implementations or create your own class that implements the template as outlined in Creating Custom Loggers\u00c2\u00a0section.\nSugarLogger\nThe SugarLogger\u00c2\u00a0class, found in ./include/SugarLogger/SugarLogger.php, is the default system logging class utilized throughout the majority of Sugar.\u00c2\u00a0\nSugarPsrLogger\nThe SugarPsrLogger was added in Sugar 7.9 to accommodate the PSR-3\u00c2\u00a0compliant logging implementation. This logger works just like the SugarLogger object, however it uses the Monolog implementation of Logger.\nTo configure the SugarPsrLogger as the default system logger, you can add the following to your configuration:\n$sugar_config['logger']['default'] = 'SugarPsrLogger';\nLog Level Mappings", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/SugarLogger/index.html"}
{"id": "328c004d216b-1", "text": "Log Level Mappings\nPSR-3 defines the set of log levels that should be implemented for all PHP Applications, however, these\u00c2\u00a0are different from the log levels defined by the\u00c2\u00a0SugarLogger. Below is the list of\u00c2\u00a0SugarLogger\u00c2\u00a0log levels and their\u00c2\u00a0SugarPsrLogger\u00c2\u00a0compatible mapping. All calls to the SugarLogger log levels are mapped according to the table below. For example, when using the\u00c2\u00a0SugarPsrLogger\u00c2\u00a0class, all calls to the\u00c2\u00a0\u00c2\u00a0fatal()\u00c2\u00a0method will map to the\u00c2\u00a0Alert\u00c2\u00a0log level.\nSugarLogger Level\nSugarPsrLogger Level\u00c2\u00a0(PSR-3)\nDebug\nDebug\nInfo\nInfo\nWarn\nWarning\nDeprecated\nNotice\nError\nError\nFatal\nAlert\nSecurity\nCritical\nLoggerManager\nThe LoggerManager Object acts as a singleton factory that sets up the configured logging object for use throughout the system. This is the object stored in $GLOBALS['log'] in the majority of use cases in the system.\nMethods\ngetLogger()\nThis method is used to get the currently configured Logger class.\nsetLevel($level)\nYou may find that you want to define the log level while testing your code without modifying the configuration. This can be done by using the setLevel() method.\nArguments\nName\nType\nDescription\n$level\nString\nThe method or level which the Logger should handle the provided message\nExample\n\\LoggerManager::getLogger()->setLevel('debug');\nNote: The use of setLevel should be removed from your code for production and it is important to note that it is restricted by package scanner as defined by the\u00c2\u00a0Module Loader Restrictions.\nassert($message, $condition)", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/SugarLogger/index.html"}
{"id": "328c004d216b-2", "text": "assert($message, $condition)\nIn your custom code you may want to submit a debug level log, should a condition not meet your expectations. You could do this with an if statement, otherwise you could just use the assert() method as it allows you to pass the debug message, and the condition to check, and if that condition is FALSE a debug level message is logged.\nArguments\nName\nType\nDescription\n$message\nString\nThe log message\n$condition\nBoolean\nThe condition to check\nExample\n$x = 1;\n\\LoggerManager::getLogger()->assert('X was not equal to 0!', $x==0)\nwouldLog($level)\nIf in your customization you find that extra debugging is needed for particular area of code, and that extra work might have performance impacts on standard log levels, you can use the wouldLog() method to check the current log level before doing the extra work.\nArguments\nName\nType\nDescription\n$level\nString\nThe level\u00c2\u00a0to check against\u00c2\u00a0\nExample\nif (\\LoggerManager::getLogger()->wouldLog('debug')) {\n   //Do extra debugging\n}\nsetLogger($level, $logger)\nThis method allows you to setup a second logger for a specific log level, rather than just using the same logger for all levels. Passing default\u00c2\u00a0as the level, will set the default Logger used by all levels in the system.\nArguments\nName\nType\nDescription\n$level\nString\nThe level\u00c2\u00a0to check against\u00c2\u00a0\n$logger\nString\nThe class name of an installed Logger\nExample\n//Set the debug level to a custom Logger\n\\LoggerManager::getLogger()->setLogger('debug', 'CustomLogger');\n//Set all other levels to SugarPsrLogger\n\\LoggerManager::getLogger()->setLogger('default', 'SugarPsrLogger');\ngetAvailableLoggers()", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/SugarLogger/index.html"}
{"id": "328c004d216b-3", "text": "getAvailableLoggers()\nReturns a list of the names of Loggers found/installed in the system.\nArguments\nNone\nExample\n$loggers = \\LoggerManager::getLogger()->getAvailableLoggers();\ngetLoggerLevels()\nReturns a list of the names of Loggers found/installed in the system.\nArguments\nNone\nExample\n$levels = \\LoggerManager::getLogger()->getLoggerLevels();\nAdding a Custom SugarLogger\nCustom loggers are defined in ./custom/include/SugarLogger/, and can be used to write log entries to a centralized application management tool, to a developer tool such as FirePHP or even to a secondary log file inside the Sugar application.\nThe following is an example of how to create a FirePHP logger.\n./custom/include/SugarLogger/FirePHPLogger.php.\n<?php\n// change the path below to the path to your FirePHP install\nrequire_once('/path/to/fb.php');\nclass FirePHPLogger implements LoggerTemplate\n{\n    /** Constructor */\n    public function __construct()\n    {\n        if (\n            isset($GLOBALS['sugar_config']['logger']['default'])\n            && $GLOBALS['sugar_config']['logger']['default'] == 'FirePHP'\n        )\n        {\n            LoggerManager::setLogger('default','FirePHPLogger');\n        }\n    }\n    /** see LoggerTemplate::log() */\n    public function log($level, $message)\n    {\n        // change to a string if there is just one entry\n        if ( is_array($message) && count($message) == 1 ) {\n            $message = array_shift($message);\n        }\n        switch ($level) {\n            case 'debug':\n                FB::log($message);\n                break;\n            case 'info':\n                FB::info($message);\n                break;", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/SugarLogger/index.html"}
{"id": "328c004d216b-4", "text": "case 'info':\n                FB::info($message);\n                break;\n            case 'deprecated':\n            case 'warn':\n                FB::warn($message);\n                break;\n            case 'error':\n            case 'fatal':\n            case 'security':\n                FB::error($message);\n                break;\n        }\n    }\n}\nYou will then specify your default logger as 'FirePHP' in your ./config_override.php file.\n$sugar_config['logger']['default'] = 'FirePHP';\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/SugarLogger/index.html"}
{"id": "8343d30ea6a5-0", "text": "PSR-3 Logger\nMonolog\\Handler\\HandlerInterface\nOverview\nSugar's\u00c2\u00a0PSR-3\u00c2\u00a0compliant logging solution has been implemented based on PHP Monolog. Accessing the PSR-3 Logger Objects can be done by via the \\Sugarcrm\\Sugarcrm\\Logger namespace. Currently, this logging implementation is only used in a few areas of the system to allow for more in-depth logging in those areas, see the Usage section for more details.\nArchitecture\nThe PSR-3 Logging solution is found in ./src/Logger directory, which is mapped to the \\Sugarcrm\\Sugarcrm\\Logger namespace in the application. The following outlines the architecture and current implementations of those core objects.\nFactory\nThe Logger Factory Object, namespaced as\u00c2\u00a0\\Sugarcrm\\Sugarcrm\\Logger\\Factory, is a singleton factory that creates and manages all Loggers currently being used by the system. The Logger Factory uses 'channels' to allow for multiple Loggers to be utilized and configured independently of default log level set for the system.\u00c2\u00a0It also allows for each channel to use different handlers, formatters, and processors. Check out the Usage section below for further details on configuration and usage.\nMethods\ngetLogger($channel)\nReturns the requested channels \\Psr\\Log\\LoggerInterface implementation\nArguments\nName\nType\nDescription\n$channel\nString\nThe channel for which you are logging against\nExample\nuse \\Sugarcrm\\Sugarcrm\\Logger\\Factory;\n$Logger = Factory::getLogger('default');\nHandlers", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/PSR-3_Logger/index.html"}
{"id": "8343d30ea6a5-1", "text": "$Logger = Factory::getLogger('default');\nHandlers\nHandlers are the primary object used to manage the logs. They control how logs are submitted and where the logs will go. Since the PSR-3 Logging solution is based on Monolog, there are a number of default Handlers included in Sugar, however, they are not set up in the Sugar architecture to be utilized right off the bat. Sugar utilizes a Factory implementation for the handlers so that the\u00c2\u00a0Logger\u00c2\u00a0Factory Object can build out specific Handlers for each channel based on the Sugar Config.\nFactory Interface\nThe Factory Interface for Handlers is used to implement a Logging Handler, so that the Logger Factory can build out the configured handler for a channel, without a lot of work from external developers. The Handler Factory Interface is located in ./src/Logger/Handlers/Factory.php or in code at\u00c2\u00a0the\u00c2\u00a0\\Sugarcrm\\Sugarcrm\\Logger\\Handler\\Factory namespace.\nMethods\nThere is only one method to implement for\u00c2\u00a0a\u00c2\u00a0Handler Factory, which is the create() method. This will contain the necessary Logic to set up the Logger Handler\ncreate($level, $config)\nArguments\nName\nType\nDescription\n$level\nString\nThe log level the Logger Handler will operate at\u00c2\u00a0\n$config\nArray\nThe config parameters set for the handler in the Sugar config file\nReturns\nThe Monolog\\Handler\\HandlerInterface implementation\nImplementations\nBy default, Sugar only comes with a single Handler implementation, which is the File Handler implementation. This is used to log directly to the ./sugarcrm.log file to mirror the functionality of the previous logging framework. For information on adding custom handlers, or implementing the built-in Monolog handlers inside of Sugar PSR-3 Logging framework, see the Customization section below.\nConfiguration\nTo configure the default logging handler for Sugar the following configuration setting is used:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/PSR-3_Logger/index.html"}
{"id": "8343d30ea6a5-2", "text": "Configuration\nTo configure the default logging handler for Sugar the following configuration setting is used:\n$sugar_config['logger']['handler'] = '<handler>';\nYou can also configure a different Logging Handler or Handlers for a specific channel:\n//Single Handler\n$sugar_config['logger']['channels']['test_channel']['handlers'] = '<handler>';\n//Multiple Channels\n$sugar_config['logger']['channels']['test_channel']['handlers'] = array('<handler1>','<handler2>');\nTo pass configuration properties to a Handler your configuration will need to look as follows:\n//For system handler\n$sugar_config['logger']['handlers']['<handler>']['host'] = '127.0.0.1';\n$sugar_config['logger']['handlers']['<handler>']['port'] = 12201;\n//For channel handlers\n$sugar_config['logger']['channels']['test_channel']['handlers']['<handler>']['host'] = '127.0.0.1';\n$sugar_config['logger']['channels']['test_channel']['handlers']['<handler>']['port'] = 12201;\n$sugar_config['logger']['channels']['test_channel']['handlers']['<handler>']['level'] = 'debug';\nNote: For more information, please refer to the logger.channels.channel.handlers documentation.\nFormatters\nFormatters are a component of the Handler Object. By default Sugar only comes with a single Formatter, which is the BackwardCompatibleFormatter used by the File Handler, which simply assures that Log messages are consistent with the legacy Logging functionality. Formatters are used and built out in accordance with the Monolog framework, and under the majority of circumstances, building out a custom formatter is not necessary. For more information on Formatters, you can review the Monolog repository.\nProcessors", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/PSR-3_Logger/index.html"}
{"id": "8343d30ea6a5-3", "text": "Processors\nProcessors provide a way to add more information to Log messages, without having to hard code this information inside the Handler, so that it can be used only when necessary. For example, Sugar's PSR-3 Logging implementation provides two default Processors that can be enabled for a given channel or handler via configuration. These Processors provide functionality such as adding a stack trace or the web request information\u00c2\u00a0to the log message to provide further debugging context.\nFactory Interface\nThe Factory Interface for processors\u00c2\u00a0is used to implement a Logging Processor, so that the Logger Factory can build out the configured handler for a channel, without a lot of work from external developers. The\u00c2\u00a0Processor\u00c2\u00a0Factory Interface is located in ./src/Logger/Processor/Factory.php\u00c2\u00a0or in code at\u00c2\u00a0\\Sugarcrm\\Sugarcrm\\Logger\\Handler\\Factory\u00c2\u00a0namespace.\nMethods\nThere is only one method to implement for\u00c2\u00a0a\u00c2\u00a0Processor Factory, which is the\u00c2\u00a0create()\u00c2\u00a0method. This method will contain the necessary Logic to set up the Processor object.\u00c2\u00a0\ncreate($config)\nArguments\nName\nType\nDescription\n$config\nArray\nThe config parameters set for the\u00c2\u00a0processor\u00c2\u00a0in the Sugar config file\nReturns\nCallable - See Customization section for an example of implementation, otherwise review the included Processor Factory implementations in code in ./src/Logger/Processor/Factory/.\nImplementations\nBy default, Sugar comes with two\u00c2\u00a0Processor\u00c2\u00a0implementations, \\Sugarcrm\\Sugarcrm\\Logger\\Processor\\BacktraceProcessor and\u00c2\u00a0\\Sugarcrm\\Sugarcrm\\Logger\\Processor\\RequestProcessor.\u00c2\u00a0\nBacktraceProcessor", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/PSR-3_Logger/index.html"}
{"id": "8343d30ea6a5-4", "text": "BacktraceProcessor\nAs the name implies, the BacktraceProcessor appends a backtrace or stack trace to the log message output, to easily trace where and how the log message came from. The Factory implementation for this Processor lives in\u00c2\u00a0./src/Logger/Processor/Factory/Backtrace.php, and is referenced in the sugar config as backtrace.\nThe following shows an example of the output that occurs when utilizing this processor:\nFri Mar 23 09:24:19 2018 [90627][1][FATAL] <log message>; Call Trace: \\n0: /var/www/Ent/71110/custom/SugarQueryLogger.php:43 - Sugarcrm\\Sugarcrm\\Logger\\BackwardCompatibleAdapter::fatal()\\n2: /var/www/Ent/71110/include/utils/LogicHook.php:270\\n3: /var/www/Ent/71110/include/utils/LogicHook.php:160 - LogicHook::process_hooks()\\n4: /var/www/Ent/71110/data/SugarBean.php:6684 - LogicHook::call_custom_logic()\\n5: /var/www/Ent/71110/data/SugarBean.php:3317 - SugarBean::call_custom_logic()\\n6: /var/www/Ent/71110/clients/base/api/FilterApi.php:632 - SugarBean::fetchFromQuery()\\n7: /var/www/Ent/71110/clients/base/api/FilterApi.php:397 - FilterApi::runQuery()\\n8: /var/www/Ent/71110/include/api/RestService.php:257 - FilterApi::filterList()\\n9: /var/www/Ent/71110/api/rest.php:23 - RestService::execute()\nNote: when viewing complex logs, you can use the following to print log entries in a more human readable format:\ncat sugarcrm.log | sed s/\\\\n/\\n/g", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/PSR-3_Logger/index.html"}
{"id": "8343d30ea6a5-5", "text": "cat sugarcrm.log | sed s/\\\\n/\\n/g\nRequestProcessor\nThe RequestProcessor appends\u00c2\u00a0Session properties to the Log message that would help identify the request that caused the log message. The Factory implementation for this Processor lives in ./src/Logger/Processor/Factory/Request.php, and is referenced in the sugar config as request.\nThe following list of session properties are appended to the log:\nUser ID\nClient ID (OAuth2 Client)\nPlatform\nThe following shows an example of the output that occurs when utilizing this processor:\nMon Mar 26 09:48:58 2018 [5930][1][FATAL] <log message>; User ID=1; Client ID=sugar; Platform=base\nConfiguration\nTo configure the default Logging Handler for Sugar to utilize the built-in processors:\n//Configure a single Processor\n$sugar_config['logger']['channels']['default']['processors'] = 'backtrace';\n//Configure multiple Processors\n$sugar_config['logger']['channels']['default']['processors'] = array('backtrace','request');\nYou can also configure different channels to utilize the processors:\n//Single Processors\n$sugar_config['logger']['channels']['<channel>']['processors'] = 'backtrace';\n//Multiple Channels\n$sugar_config['logger']['channels']['<channel>']['processors'] = array('backtrace','request');\nTo pass configuration properties to a\u00c2\u00a0Processor\u00c2\u00a0your configuration will need to look as follows:\n$sugar_config['logger']['channels']['<channel>']['processors']['<processor>']['config_key'] = 'test_value';\nNote: For more information, please refer to the logger.channels.channel.processors documentation.\nUsage", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/PSR-3_Logger/index.html"}
{"id": "8343d30ea6a5-6", "text": "Note: For more information, please refer to the logger.channels.channel.processors documentation.\nUsage\nAs previously mentioned the Logger Factory allows for multiple channels to be configured independently of each other. The following examples will showcase how to use the Logger Factory to get a channel's Logger and use it in code, as well as how to configure the system to use multiple channels with different configurations.\nBasic Usage\nuse \\Sugarcrm\\Sugarcrm\\Logger\\Factory;\n//Retrieve the default Logger\n$DefaultLogger = Factory::getLogger('default');\n$DefaultLogger->alert('This is a log message');\nConfiguring Channels\nThe following is an example of the ./config_override.php file that would configure two different channels at different log levels, using the logger.channel.channel.level configuration setting. These two channels would allow for portions of the code to Log messages at Debug (and higher) levels, and other portions to only log Info (and higher) levels.\n$config['logger']['channels']['default'] = array(\n    'level' => 'alert'\n);\n$config['logger']['channels']['channel1'] = array(\n    'level' => 'debug'\n);\nThe following code example shows how to\u00c2\u00a0retrieve the above-configured channels and use the Logger for each channel.\u00c2\u00a0\nuse \\Sugarcrm\\Sugarcrm\\Logger\\Factory;\n//Retrieve the default Logger\n$DefaultLogger = Factory::getLogger('default');\n$DefaultLogger->info(\"This message will not display\");\n//Channel1 Logger\n$Channel1Logger = Factory::getLogger('channel1');\n$Channel1Logger->info(\"This message will display\");", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/PSR-3_Logger/index.html"}
{"id": "8343d30ea6a5-7", "text": "$Channel1Logger->info(\"This message will display\");\nIn the example above, assuming a stock system with the previously mentioned config values set in config_override.php, the default channel logger would be set to Alert level logging, and therefore would not add the info level log to the Log file, however, the channel11 Logger would add the log message to the Sugar log file, since it is configured at the info log level.\nDefault Channels\nBy default, Sugar has a few areas of the system that utilize a different channel than the default. The usage of these channels means that you can configure the log level and processors differently for those areas, without inundating the log file with lower level logs from other areas of the system.\nChannel\nDescription\nauthentication\nThis logger channel is utilized by the AuthenticationController, and can show useful information about failed login attempts.\u00c2\u00a0\ninput_validation\nThis logger channel is utilized by the Input Validation framework and can display information regarding failed validations.\nmetadata\nThis logger channel is utilized by the MetadataManager and mainly provides information on when rebuilds occur.\nrest\nThis channel is utilized by the\u00c2\u00a0RestService object.\ndb\nThis channel is utilized by the databse for query logging.\nCustomization\nYou can use custom channels where ever you would like in your customizations, and configure them as outlined above, but if you need to send logs somewhere other than the Sugar log file, you will need to build out your own Handler. The following will walk through adding a custom Logging Handler that utilizes Monologs built-in Chrome Logger.\nAdding a Custom Handler\nCreate the following file in ./custom/src/Logger/Handler/Factory/ folder.\n./custom/src/Logger/Handler/Factory/Chrome.php\n<?php\nnamespace Sugarcrm\\Sugarcrm\\custom\\Logger\\Handler\\Factory;\nuse Monolog\\Handler\\ChromePHPHandler;", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/PSR-3_Logger/index.html"}
{"id": "8343d30ea6a5-8", "text": "use Monolog\\Handler\\ChromePHPHandler;\nuse Sugarcrm\\Sugarcrm\\Logger\\Handler\\Factory;\nclass Chrome implements Factory\n{\n    public function create($level, array $config)\n    {\n        return new ChromePHPHandler($level);\n    }\n}\nOnce you have the new class in place, you will need to run a Quick Repair and Rebuild so that the new class is auto-loaded correctly. Then you can configure the handler for use in the Sugar config:\n$sugar_config['logger']['channels']['<channel>']['handlers'] = 'Chrome';\n\u00c2\u00a0Note: For more information, please refer to the\u00c2\u00a0logger.channels.channel.handlers\u00c2\u00a0documentation.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/PSR-3_Logger/index.html"}
{"id": "22c04ab727db-0", "text": "Creating Custom Loggers\nCustom Loggers\nCustom loggers,\u00c2\u00a0defined in ./custom/include/SugarLogger/, can be used to write log entries to a centralized application management tool or to write messages to a developer tool such as FirePHP.\nTo do this, you can create a new instance class that implements the LoggerTemplate interface. The following is an example of how to create a FirePHP logger.\n./custom/include/SugarLogger/FirePHPLogger.php.\n<?php\n// change the path below to the path to your FirePHP install\nrequire_once('/path/to/fb.php');\nclass FirePHPLogger implements LoggerTemplate\n{\n    /** Constructor */\n    public function __construct()\n    {\n        if (\n            isset($GLOBALS['sugar_config']['logger']['default'])\n            && $GLOBALS['sugar_config']['logger']['default'] == 'FirePHP'\n        )\n        {\n            LoggerManager::setLogger('default','FirePHPLogger');\n        }\n    }\n    /** see LoggerTemplate::log() */\n    public function log($level, $message)\n    {\n        // change to a string if there is just one entry\n        if ( is_array($message) && count($message) == 1 )\n        {\n            $message = array_shift($message);\n        }\n        switch ($level)\n        {\n            case 'debug':\n                FB::log($message);\n                break;\n            case 'info':\n                FB::info($message);\n                break;\n            case 'deprecated':\n            case 'warn':\n                FB::warn($message);\n                break;\n            case 'error':\n            case 'fatal':\n            case 'security':\n                FB::error($message);\n                break;\n        }\n    }\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/Creating_Custom_Loggers/index.html"}
{"id": "22c04ab727db-1", "text": "FB::error($message);\n                break;\n        }\n    }\n}\nThe only method that needs to be implemented by default is the log() method, which writes the log message to the backend. You can specify which log levels this backend can use in the constructor by calling the LoggerManager::setLogger() method and specifying the level to use for this logger in the first parameter; passing 'default' makes it the logger for all logging levels.\nYou will then specify your default logger as 'FirePHP' in your ./config_override.php file.\n$sugar_config['logger']['default'] = 'FirePHP';\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logging/Creating_Custom_Loggers/index.html"}
{"id": "e2900925ce9a-0", "text": "Email\nOverview\nOutlines\u00c2\u00a0the relationships\u00c2\u00a0between emails, email addresses, and bean records.\nEmail Tables\nTable Name\nDescription\nemail_addresses\nEach record in this table represents an email address in the system. Note that the invalid_email column and opt_out column are stored on this table, meaning that they are treated as properties of the email address itself, not a relationship attribute between a given email address and related record. This means if a Lead opts-out of a campaign, this email address will be considered opted-out in all contexts, not just with further correspondence with that specific Lead.\nemail_addr_bean_rel\nThe email_addr_bean_rel table maintains the relationship between the email address and its parent module record (Contacts, Accounts, Leads, Users, etc) to determine which record of the given module the email address belongs to. Note that this relationship table also has the primary_address and reply_to_address columns to indicate whether a given email address for a given record is the primary email address, the reply to email address, or some other address for the contact. A contact\u00c2\u00a0can have one address flagged as primary, and one flagged as \"Reply To\". This can be the same email address or two different email addresses.\nemails_email_addr_rel\nThe emails_email_addr_rel table maintains the relationships between the email address and email records. Note that this relationship table also has the address_type column to indicate if the email address is related to the email as a \"To\", \"From\", \"CC\", or \"BCC\" address. The valid values at the database level for this column are: from, to, cc, bcc.\nemails\nEach record in this table represents an email in the system. Note that emails fall outside the scope of this document, but are mentioned here for clarity, as the two modules are closely related.\nemails_beans", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Email/index.html"}
{"id": "e2900925ce9a-1", "text": "emails_beans\nSimilar to the email_addr_bean_rel table, the emails_beans table maintains the relationship between an email record and any related records (Contacts, Accounts, Cases, etc.).\n<module>\nThis is used to show\u00c2\u00a0how an email address record relates to a record\u00c2\u00a0in any\u00c2\u00a0module is set on bean_module. If bean_module is set to Contacts, <module>\u00c2\u00a0would be the contacts table.\nThe following diagram illustrates table relationships between email addresses and other modules, email addresses and email records, and email records and other modules.\nHelper Queries\nRetrieve the Primary Email Address of a Contact\nThe following query will fetch the email address given a specific contacts id:\nSELECT\n  email_address\nFROM email_addresses\nJOIN email_addr_bean_rel eabr\n  ON eabr.email_address_id = email_addresses.id\nWHERE eabr.bean_module = \"Contacts\"\nAND eabr.bean_id = \"<contact id>\"\nAND email_addresses.invalid_email = 0\nAND eabr.deleted = 0\nAND eabr.primary_address = 1;\nRetrieve All Records Related to an Email Address\nThe following query will fetch the id and module name of all records related to the specified email address:\nSELECT\n  bean_module,\n  bean_id\nFROM email_addr_bean_rel eabr\nJOIN email_addresses\n  ON eabr.email_address_id = email_addresses.id\nWHERE email_addresses.email_address = \"<email address>\"\nAND eabr.deleted = 0;\nRetrieve All Emails Sent From An Email Address\nThe following query will fetch\u00c2\u00a0all emails sent from a\u00c2\u00a0specified email address:\nSELECT\n  emails.name,\n  emails.date_sent\nFROM emails\nJOIN emails_email_addr_rel eear\n  ON eear.email_id = emails.id\nJOIN email_addresses\n  ON eear.email_address_id = email_addresses.id\nWHERE email_addresses.email_address = \"<email address>\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Email/index.html"}
{"id": "e2900925ce9a-2", "text": "WHERE email_addresses.email_address = \"<email address>\"\nAND eear.address_type = \"from\"\nAND eear.deleted = 0\nCleanup Duplicate Email Addresses\nThe following queries will remove any duplicate\u00c2\u00a0email addresses.\n\u00c2\u00a0First, create a\u00c2\u00a0temporary table\u00c2\u00a0with distinct records from the\u00c2\u00a0email_addr_bean_rel table:\ncreate table email_addr_bean_rel_tmp_ful\nSELECT\n  *\nFROM email_addr_bean_rel\nWHERE deleted = '0'\nGROUP BY email_address_id,\n         bean_module,\n         bean_id\nORDER BY primary_address DESC;\nNext, clear out the email_addr_bean_rel table:\ntruncate email_addr_bean_rel;\nMove the records from the temporary table back to\u00c2\u00a0email_addr_bean_rel:\nINSERT INTO email_addr_bean_rel\n SELECT\n *\n FROM email_addr_bean_rel_tmp;\nValidate that all of the duplicates have been removed:\nSELECT\n COUNT(*) AS repetitions,\n date_modified,\n bean_id,\n bean_module\nFROM email_addr_bean_rel\nWHERE deleted = '0'\nGROUP BY bean_id,\n bean_module,\n email_address_id\nHAVING repetitions > 1;\nFinally, remove the temporary table:\ndrop table email_addr_bean_rel_tmp;\nEmail Address Validation\nSugar validates emails addresses according to the\u00c2\u00a0RFC 5321\u00c2\u00a0and\u00c2\u00a0RFC 5322\u00c2\u00a0standards. The following sections will detail how a developer can validate email addresses both server and client side.\nServer Side\nTo validate an email address in a server-side context, the EmailAddress::isValidEmail() static method should be used. For example:\n$emailAddress = \"test@example.com\";\n$isValid = EmailAddress::isValidEmail($emailAddress);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Email/index.html"}
{"id": "e2900925ce9a-3", "text": "$isValid = EmailAddress::isValidEmail($emailAddress);\nThe\u00c2\u00a0EmailAddress::isValidEmail method leverages the PHPMailer library bundled with Sugar, specifically the PHPMailer::validateAddress method, which validates the address\u00c2\u00a0according to the\u00c2\u00a0RFC 5321\u00c2\u00a0and RFC 5322 standards.\nClient Side\nTo validate an email address client-side context, the\u00c2\u00a0app.utils.isValidEmailAddress()\u00c2\u00a0function can be used.\nvar emailAddress = \"test@example.com\";\nvar isValid = app.utils.isValidEmailAddress(emailAddress);\nNote: This function is more permissive and does not conform exactly to the RFC standards used on the server. As such, the\u00c2\u00a0email address\u00c2\u00a0will be validated again on the\u00c2\u00a0server\u00c2\u00a0when the\u00c2\u00a0record is saved, which could still fail validation.\nTopicsMailer FactoryThe Mailer Factory, located in ./modules/Mailer/MailerFactory.php, helps developers generate outbound mailers for the system account as well as individual user accounts. The Mailer Factory is a replacement for SugarPHPMailer which is now deprecated.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Email/index.html"}
{"id": "38a8561fe5ef-0", "text": "Mailer Factory\nOverview\nThe Mailer Factory, located in ./modules/Mailer/MailerFactory.php, helps developers generate outbound mailers\u00c2\u00a0for the system account as well as individual user accounts. The Mailer Factory is a replacement for SugarPHPMailer which is now deprecated.\nMailers\nThere are\u00c2\u00a0two types of outbound mailers:\u00c2\u00a0System and\u00c2\u00a0User. The follow sections will outline how to use each.\nSystem Mailer\nThe\u00c2\u00a0system outbound mailer can be set\u00c2\u00a0using the\u00c2\u00a0getSystemDefaultMailer\u00c2\u00a0method. This will set the mailer to use the system outbound email account.\u00c2\u00a0\nExample\n$mailer = MailerFactory::getSystemDefaultMailer();\nUser Mailer\nThe user outbound mailer can be set\u00c2\u00a0using the getMailerForUser\u00c2\u00a0method. This will set the mailer to use the outbound email account for a specific user.\u00c2\u00a0\nExample\n$user = BeanFactory::getBean(\"Users\", 1);\n$mailer = MailerFactory::getMailerForUser($user);\nPopulating the Mailer\nSetting the Subject\nTo set the email subject, use the\u00c2\u00a0setSubject method. It accepts a plain text string.\nExample\n$mailer->setSubject(\"Test Mail Subject\");\nSetting the Body\nDepending on your email type, you can use the setTextBody\u00c2\u00a0and/or setHtmlBody methods respectively to populate the content of the email body.\nExample\n// Text Body\n$mailer->setTextBody(\"This is a text body message\");\n// HTML Body\n$mailer->setHtmlBody(\"This is an <b>HTML</b> body message. <br> You can use html tags.\");\nNote:\u00c2\u00a0The email HTML body is not necessary if you have populated the text body.\nAdding Recipients", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Email/Mailer_Factory/index.html"}
{"id": "38a8561fe5ef-1", "text": "Adding Recipients\nTo add recipients to your email, you can use the\u00c2\u00a0addRecipientsTo, addRecipientsCc, or addRecipientsBcc methods . These methods require an EmailIdentity object as a parameter.\nExample\n$mailer->addRecipientsTo(new EmailIdentity('user1@yourcompany.crm', 'User 1'));\n$mailer->addRecipientsCc(new EmailIdentity('user2@yourcompany.crm', 'User 2'));\n$mailer->addRecipientsBcc(new EmailIdentity('user3@yourcompany.crm', 'User 3'));\nClearing Recipients\nYou can clear the current recipients specified in the mailer by using the clearRecipients method.\nExample\n$to = true; \n$cc = true; \n$bcc = true;\n$mailer->clearRecipients($to, $cc, $bcc);\nAdding Attachments\nTo add attachments,\u00c2\u00a0use the\u00c2\u00a0addAttachment method.\nExample\n$path = \"/path/to/your/document\";\n$mailer->addAttachment(new Attachment($path));\nSending Emails\nOnce your email is populated, you can send it using the\u00c2\u00a0send method. The\u00c2\u00a0send method will return\u00c2\u00a0the content of the mail. If the Mailer Factory experiences an error, it will throw an exception. It is highly recommended to use a try and catch when sending emails.\nExample\n$mailSubject = \"Test Mail Subject\";\n$mailHTML = \"<h1>SugarCRM</h1><br> Test body message\";\n$mailTo = array(\n    0 => array(\n        'name' => 'Test User',\n        'email' => 'test@yourcompany.crm',\n    ),\n    1 => array(\n        'name' => 'Other Recipient',\n        'email' => 'email@addres'\n    )\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Email/Mailer_Factory/index.html"}
{"id": "38a8561fe5ef-2", "text": "'email' => 'email@addres'\n    )\n);\n$mailAttachment = \"/path/to/pdf/files/document.pdf\";\ntry {\n    $mailer = MailerFactory::getSystemDefaultMailer();\n    $mailTransmissionProtocol = $mailer->getMailTransmissionProtocol();\n    $mailer->setSubject($mailSubject);\n    $body = trim($mailHTML);\n    $textOnly = EmailFormatter::isTextOnly($body);\n    if ($textOnly) {\n        $mailer->setTextBody($body);\n    } else {\n        $textBody = strip_tags(br2nl($body)); // need to create the plain-text part\n        $mailer->setTextBody($textBody);\n        $mailer->setHtmlBody($body);\n    }\n    $mailer->clearRecipients();\n    foreach ($mailTo as $mailTo) {\n        $mailer->addRecipientsTo(new \\EmailIdentity($mailTo['email'], $mailTo['name']));\n    }\n    $mailer->addAttachment(new \\Attachment($mailAttachment));\n    $result = $mailer->send();\n    if ($result) {\n        // $result will be the body of the sent email\n    } else {\n        // an exception will have been thrown\n    }\n} catch (MailerException $me) {\n    $message = $me->getMessage();\n    switch ($me->getCode()) {\n        case \\MailerException::FailedToConnectToRemoteServer:\n            $GLOBALS[\"log\"]->fatal(\"BeanUpdatesMailer :: error sending email, system smtp server is not set\");\n            break;\n        default:\n            $GLOBALS[\"log\"]->fatal(\"BeanUpdatesMailer :: error sending e-mail (method: {$mailTransmissionProtocol}), (error: {$message})\");\n            break;\n    }\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Email/Mailer_Factory/index.html"}
{"id": "38a8561fe5ef-3", "text": "break;\n    }\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Email/Mailer_Factory/index.html"}
{"id": "9332f9cb19f0-0", "text": "Duplicate Check\nOverview\nThe duplicate-check framework provides the capability to alter how the system searches for duplicate records in the database when creating records. For information on duplicate checking during imports, please refer to the index documentation.\nDefault Strategy\nThe default duplicate-check strategy, located in ./data/duplicatecheck/FilterDuplicateCheck.php, is referred to as FilterDuplicateCheck. This strategy utilizes the Filter API\u00c2\u00a0and a defined filter in the vardefs of the module to search for duplicates and rank them based on matching data.\nCustom Filter\nTo alter a defined filter for a stock\u00c2\u00a0a module, you only need to update the Vardefs using the Extensions framework. If you are working with a custom module, you can modify the vardefs in\u00c2\u00a0./modules/<module>/vardefs.php directly. The FilterDuplicateCheck Strategy accepts two properties in its metadata:\nName\nType\nDescription\nfilter_template\narray\nAn array containing the Filter Definition for which fields to search for duplicates on. Please consult the Filter API for further information on the filter syntax\nranking_fields\narray\nA list of arrays with the following properties. The order in which you list the fields for ranking will determine the ranking score. The first ranks higher, than those after it.\nin_field_name: Name of field in vardefs\ndupe_field_name: Name of field returned by filter\nExample\nThe following example will demonstrate how to manipulate the stock Accounts duplicate check to not filter\u00c2\u00a0on the shipping address city. The default Account\u00c2\u00a0duplicate_check defintion, located in ./modules/Accounts/vardefs.php, is shown below.\n...\n'duplicate_check' => array(\n    'enabled' => true,\n    'FilterDuplicateCheck' => array(\n        'filter_template' => array(\n            array(\n                '$or' => array(\n                    array('name' => array('$equals' => '$name')),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Duplicate_Check/index.html"}
{"id": "9332f9cb19f0-1", "text": "array('name' => array('$equals' => '$name')),\n                    array('duns_num' => array('$equals' => '$duns_num')),\n                    array(\n                        '$and' => array(\n                            array('name' => array('$starts' => '$name')),\n                            array(\n                                '$or' => array(\n                                    array('billing_address_city' => array('$starts' => '$billing_address_city')),\n                                    array('shipping_address_city' => array('$starts' => '$shipping_address_city')),\n                                )\n                            ),\n                        )\n                    ),\n                )\n            ),\n        ),\n        'ranking_fields' => array(\n            array('in_field_name' => 'name', 'dupe_field_name' => 'name'),\n            array('in_field_name' => 'billing_address_city', 'dupe_field_name' => 'billing_address_city'),\n            array('in_field_name' => 'shipping_address_city', 'dupe_field_name' => 'shipping_address_city'),\n        )\n    )\n),\n...\n\u00c2\u00a0To add or remove fields from the check, you will need to manipulate\u00c2\u00a0$dictionary['<module>']['duplicate_check']['FilterDuplicateCheck']['filter_template']\u00c2\u00a0and \u00c2\u00a0\u00c2\u00a0$dictionary['<module>']['duplicate_check']['FilterDuplicateCheck']['ranking_fields']\u00c2\u00a0. For our example, we will simply remove the references to\u00c2\u00a0shipping_address_city. \u00c2\u00a0It is important to familiarize yourself with filter operators before making any changes.\n./custom/Extension/modules/Accounts/Ext/Vardefs/newFilterDuplicateCheck.php\n<?php\n$dictionary['Account']['duplicate_check']['FilterDuplicateCheck'] = array(\n    'filter_template' => array(\n        array(\n            '$or' => array(\n                array('name' => array('$equals' => '$name')),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Duplicate_Check/index.html"}
{"id": "9332f9cb19f0-2", "text": "array('name' => array('$equals' => '$name')),\n                array('duns_num' => array('$equals' => '$duns_num')),\n                array(\n                    '$and' => array(\n                        array('name' => array('$starts' => '$name')),\n                        array(\n                            '$or' => array(\n                                array('billing_address_city' => array('$starts' => '$billing_address_city')),\n                            )\n                        ),\n                    )\n                ),\n            )\n        ),\n    ),\n    'ranking_fields' => array(\n        array('in_field_name' => 'name', 'dupe_field_name' => 'name'),\n        array('in_field_name' => 'billing_address_city', 'dupe_field_name' => 'billing_address_city'),\n    )\n);\nFinally, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then enable the custom duplicate-check class.\nIf you want to disable the duplicate check entirely, you can set\u00c2\u00a0$dictionary['<module>']['duplicate_check']['enabled'] to false in your vardefs and run a Quick Repair and Rebuild.\n$dictionary['Account']['duplicate_check']['enabled'] = false;\nCustom Strategies\nCustom duplicate-check class files are stored under ./custom/data/duplicatecheck/. The files in this directory can be enabled on a module's duplicate_check property located in\u00c2\u00a0./custom/Extension/modules/<module>/Ext/Vardefs/. Only one duplicate-check class can be enabled on a module at a given time.\nDuplicate Check Class\nTo create a custom duplicate-check strategy, you need to create a custom duplicate-check class that extends the base DuplicateCheckStrategy, ./data/duplicatecheck/DuplicateCheckStrategy.php. To work, this custom class requires the implementation of two methods:\nMethod Name\nDescription\nsetMetadata", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Duplicate_Check/index.html"}
{"id": "9332f9cb19f0-3", "text": "Method Name\nDescription\nsetMetadata\nSets up properties for duplicate-check logic based on the passed-in metadata\nfindDuplicates\nFinds possible duplicate records for a given set of field data\nExample\nThe following example will create a new duplicate-check class called \"OneFieldDuplicateCheck\" that will query the database based on the configured field for records that contain data similar to that one field:\n./custom/data/duplicatecheck/OneFieldDuplicateCheck.php\n<?php\nif(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nclass OneFieldDuplicateCheck extends DuplicateCheckStrategy\n{\n    protected $field;\n    public function setMetadata($metadata)\n    {\n        if (isset($metadata['field'])) {\n            $this->field = $metadata['field'];\n        }\n    }\n    public function findDuplicates()\n    {\n        if (empty($this->field)){\n            return null;\n        }\n        $Query = new SugarQuery();\n        $Query->from($this->bean);\n        $Query->where()->ends($this->field,$this->bean->{$this->field});\n        $Query->limit(10);\n        //Filter out the same Bean during Edits\n        if (!empty($this->bean->id)) { \n            $Query->where()->notEquals('id',$this->bean->id);\n        }\n        $results = $Query->execute();\n        return array(\n            'records' => $results\n        );\n    }\n}\nVardef Settings\nThe duplicate-check vardef settings are configured on each module and can be altered using the Extension framework.\nName\nType\nDescription\nenabled\nboolean\nWhether or not duplicate-check framework is enabled on the module\n<class_name>\narray", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Duplicate_Check/index.html"}
{"id": "9332f9cb19f0-4", "text": "boolean\nWhether or not duplicate-check framework is enabled on the module\n<class_name>\narray\nThe class name that will provide duplicate checking, set to an array of metadata that gets passed to the duplicate-check class\n\u00c2\u00a0If you want to enable the OneFieldDuplicateCheck strategy (shown above) for the Accounts module, you must create the following file:\n./custom/Extension/modules/Accounts/Ext/Vardefs/newDuplicateCheck.php\n<?php\n$dictionary['Account']['duplicate_check'] = array(\n\t'enabled' => true,\n\t'OneFieldDuplicateCheck' => array(\n            'field' => 'name'\n        )\n);\nFinally, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then enable the custom duplicate-check class.\nProgrammatic Usage\nYou can also use the duplicate-check framework in code such as in a logic hook or a scheduler. The following example shows how to use the module's defined duplicate-check strategy when utilizing a bean object by simply calling the findDuplicates method on the bean object:\n$account = BeanFactory::newBean('Accounts');\n$account->name = 'Test';\n$duplicates = $account->findDuplicates();\nif (count($duplicates['records'])>0){\n    $GLOBALS['log']->fatal(\"Duplicate records found for Account\");\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Duplicate_Check/index.html"}
{"id": "7672fbafcfbb-0", "text": "Administration\nOverview\nThe Administration class is used to manage settings stored in the database config table.\nThe Administration Class\nThe Administration class is located in ./modules/Administration/Administration.php. Settings modified using this class are written to the config table.\nCreating / Updating Settings\nTo create or update a specific setting, you can specify the new value using the\u00c2\u00a0saveSetting() function as shown here:\nrequire_once 'modules/Administration/Administration.php';\n$administrationObj = new Administration();\n//save the setting\n$administrationObj->saveSetting(\"MyCategory\", \"MySetting\", 'MySettingsValue');\nRetrieving Settings\nYou can access the config settings by using the\u00c2\u00a0retrieveSettings() function. You can filter the settings by category by passing in a filter parameter. If no value is passed to retrieveSettings(), all settings will be returned. An example is shown here:\nrequire_once 'modules/Administration/Administration.php';\n$administrationObj = new Administration();\n//Retrieve all settings in the category of 'MyCategory'.\n//This parameter can be left empty to retrieve all settings.\n$administrationObj->retrieveSettings('MyCategory');\n//Use a specific setting\n$MySetting = $administrationObj->settings['MyCategory_MySetting'];\nConsiderations\nThe Administration class will store the settings in the config table, and the config table is cached using SugarCache as the admin_settings_cache.\u00c2\u00a0This class should be used for storing dynamic settings for a module, connector or the system as a whole, such as the last run date (for a scheduler) or an expiring token (for a connector). You should not use the Administration class to store User-based settings, settings that are frequently changing or being written to via the API, or excessively large values, as this can degrade the performance of the instance since all settings are loaded into the admin_settings_cache, which is used throughout the system.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Administration/index.html"}
{"id": "7672fbafcfbb-1", "text": "Alternatively, you can use the Configurator class, located in ./modules/Configurator/Configurator.php, to store the settings in the ./config_override.php file if the settings are not dynamic or not changing programmatically. It\u00c2\u00a0is important to note that settings stored using the configurator will cause a metadata hash refresh that may lead to users being logged out of the system.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Administration/index.html"}
{"id": "f390d9de93dc-0", "text": "Configurator\nOverview\nThe Configurator class, located in ./modules/Configurator/Configurator.php,\u00c2\u00a0handles the config settings found in ./config.php and ./config_override.php.\nRetrieving Settings\nYou can access the Sugar config settings by using the global variable $GLOBALS['sugar_config'] as shown below:\nglobal $sugar_config;\n//Use a specific setting\n$MySetting = $sugar_config['MySetting'];\nIf you should need to reload the config settings, this is an example of how to retrieve a specific setting using the configurator:\nrequire_once 'modules/Configurator/Configurator.php';\n$configuratorObj = new Configurator();\n//Load config\n$configuratorObj->loadConfig();\n//Use a specific setting\n$MySetting = $configuratorObj->config['MySetting'];\nCreating / Updating Settings\nTo create or update a specific setting, you can specify the new value using the configurator as shown below:\nrequire_once 'modules/Configurator/Configurator.php';\n$configuratorObj = new Configurator();\n//Load config\n$configuratorObj->loadConfig();\n//Update a specific setting\n$configuratorObj->config['MySetting'] = \"MySettingsValue\";\n//Save the new setting\n$configuratorObj->saveConfig();\nConsiderations\nWhen looking to store custom settings, the Configurator class will store the settings in the ./config_override.php file. This class should only be used for long-term\u00c2\u00a0configuration options as\u00c2\u00a0Configurator->saveConfig() will trigger a metadata refresh that may log users out of the system.\nAlternatively, you can use the Administration class, located in ./modules/Administration/Administration.php, to store settings in the config table in the database.\u00c2\u00a0This Administration\u00c2\u00a0class should be used for storing dynamic settings such as a last run date or an expiring token.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/index.html"}
{"id": "f390d9de93dc-1", "text": "TopicsCore SettingsSugar configuration settings.Silent Installer SettingsThe Sugar silent installer facilitates and automates the installation of the Sugar application after the files have been copied onto the server. This is done by populating correct parameters in a configuration file and then making a web request to kick off the installation.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/index.html"}
{"id": "5859f0341340-0", "text": "Silent Installer Settings\nOverview\nThe Sugar silent installer facilitates and automates the installation of the Sugar application after the files have been copied onto the server. This is done by populating correct parameters in a configuration file and then making a web request to kick off the installation.\nconfig_si.php\nThe ./config_si.php file is located at the root level of the Sugar application. It contains an array of name-value pairs consisting of the relevant parameters for installation of the app. The array name is $sugar_config_si. An example file looks like:\n<?php\n$sugar_config_si = array (\n    'setup_site_url' => 'http://${domainname}:${webport}/sugar',\n    'setup_system_name' => '${systemname}',    \n    'setup_db_host_name' => 'localhost',\n    'setup_site_admin_user_name' => 'admin',\n    'setup_site_admin_password' => '${sugarpassword}',\n    'demoData' => true, \n    'setup_db_type' => 'mysql',\n    'setup_db_host_name' => '{db_host_name}',\n    'setup_db_port_num' => 'db_port_number',\n    'setup_db_database_name' => 'sugar',\n    'setup_db_admin_user_name' => 'root',\n    'setup_db_admin_password' => '${rootpassword}',\n    'setup_db_options' => array(\n    \t'ssl' => true,\n    ),\n    'setup_db_drop_tables' => false,\n    'setup_db_create_database' => true,\n    'setup_license_key' => '${slkey}',\n    'setup_license_key_users' => '${slkeyusers}',\n    'setup_license_key_expire_date' => '${slkeyexpiredate}',\n    'setup_license_key_oc_licences' => '${slkey_oc_licenses}',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Silent_Installer_Settings/index.html"}
{"id": "5859f0341340-1", "text": "'setup_license_key_oc_licences' => '${slkey_oc_licenses}',\n    'default_currency_iso4217' => 'USD',\n    'default_currency_name' => 'US Dollars',\n    'default_currency_significant_digits' => '2',\n    'default_currency_symbol' => '$',\n    'default_date_format' => 'Y-m-d',\n    'default_time_format' => 'H:i',\n    'default_decimal_seperator' => '.',\n    'default_export_charset' => 'ISO-8859-1',\n    'default_language' => 'en_us',\n    'default_locale_name_format' => 's f l',\n    'default_number_grouping_seperator' => ',',\n    'export_delimiter' => ',',\n);\nEssential Settings\nThe following are settings that must be set:\nGeneral System Settings\nsetup_system_name\nDescription\nA unique system name for the application that will be displayed on the web browser\nType\nString\nsetup_site_url\nDescription\nThe site location and URL of the Sugar application\nType\nString\nsetup_site_admin_user_name\nDescription\nSpecifies the admin username for the Sugar application\nType\nString\nsetup_site_admin_password\nDescription\nSpecifies the admin password for the Sugar application\nType\nString\ndemoData\nDescription\nIndicates whether the app will be installed with demo data\nType\nBoolean\nDatabase Settings\nsetup_db_type\nDescription\nDefines the type of database being used with Sugar. It is important to note that db2 and oracle are only applicable to Sugar Ent and Ult.\nType\nString: valid options include mysql, mssql, db2, oracle\nsetup_db_host_instance\nDescription\nDefines the host instance for MSSQL connections.\nType\nString : Database Host Instance Name\nsetup_db_host_name\nDescription\nDefines the hostname of the database server.\nType\nString\nsetup_db_port_num", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Silent_Installer_Settings/index.html"}
{"id": "5859f0341340-2", "text": "Description\nDefines the hostname of the database server.\nType\nString\nsetup_db_port_num\nDescription\nDefines the port number on the server to connect to for authentication and transactions.\nType\nString\nsetup_db_database_name\nDescription\nDefines the database name to connect to on the database server.\nType\nString\nsetup_db_admin_user_name\nDescription\nSpecifies the database administrator's username\nType\nString\nsetup_db_admin_password\nDescription\nSpecifies the database administrator's password\nType\nString\nRecommended Database Settings\nThe following are not necessarily required, but it is recommended that at least one is set:\nsetup_db_create_database\nDescription\nSpecifies whether Sugar will create a new database with the name given or use an existing database.\nType\nBoolean\nsetup_db_drop_tables\nDescription\nSpecifies whether Sugar will drop existing tables on a database if the database already exists\nType\nBoolean\nExtended Database Settings\nThere is also an option for an additional array of db config settings. These array entries are equivalent to the Core Settings options prefixed with dbconfigoption. For example dbconfigoption.collation and dbconfigoption.ssl\nsetup_db_options\nDescription\nSee: Architecture/Configurator/Core_Settings/index.html#dbconfigoptionautofree\nType\nArray\nFull-Text Search (ElasticSearch) Settings\nsetup_fts_type\nDescription\nThe Full-Text Search service type\nType\nString, currently only supported value Elastic\nsetup_fts_host\nDescription\nThe hostname of the Full-Text Search service\nType\nString\nsetup_fts_port\nDescription\nThe port number of the Full-Text Search service\nType\nString\nAdvanced Full-Text Search Configuration Settings", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Silent_Installer_Settings/index.html"}
{"id": "5859f0341340-3", "text": "Type\nString\nAdvanced Full-Text Search Configuration Settings\nWhile not required, the Silent Installer offers a few FTS settings not available in the browser-based installation process. These settings are considered more advanced and should not be implemented casually. Further details on advanced ElasticSearch configuration can be found in the ElasticSearch installation guide in the section Advanced Configuration.\nsetup_fts_curl\nDescription\nAdditional settings for the cURL request to the Elasticsearch server, keyed by the PHP cURL constants used for curl_setopt. For example\u00c2\u00a0\u00c2\u00a0\n'setup_fts_curl' => array(\n\tCURLOPT_SSL_VERIFYPEER = false,\n),\nType\nArray\nLicense Settings\nWhile not required during installation, the license settings are required for Sugar to be usable by all users. Setting the license settings during the Silent Install will save the need to enter this required data after the install.\nsetup_license_key\nDescription\nSpecifies the license key\nType\nString\nsetup_license_key_users\nDescription\nSpecifies the number of license key users\nType\nInteger\nsetup_license_key_expire_date\nDescription\nThe expiration date of the license key\nType\nString: yyyy-mm-dd format\nsetup_site_sugarbeet_automatic_checks\nDescription\nSpecifies if License Validation checks should be set to Automatic\nType\nBoolean\nAdditionally, Offline Client license settings can be set in Silent Installer\nsetup_license_key_oc_licences\nDescription\nthe number of offline client users\nType\nInteger\nsetup_num_lic_oc\nDescription\nthe number of offline client users\nType\nInteger\nMaking the Web Request\nAfter the ./config_si.php file is in place, the following web request can be made to kick off the installation:\nhttp://${hostname}/sugar/install.php?goto=SilentInstall&cli=true", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Silent_Installer_Settings/index.html"}
{"id": "5859f0341340-4", "text": "http://${hostname}/sugar/install.php?goto=SilentInstall&cli=true\nwhere ${hostname} is the name of the host. Upon completion of the process, the installation should respond with Success, and you may navigate to the web address to find an installed version of Sugar.\nConfiguring a Sugar-Specific Database User during Install\nBy default, Sugar will use the database user set for the install process as the database user for general use after installation. There are three different Silent Install options for having Sugar use a different database user once installed. Which option the installer users is determined by the dbUSRData config setting.\nThe dbUSRData silent install config setting has four valid options:\nsame\nThis is the default setting used, even when dbUSRData is not explicitly set. The DB user provided for installing Sugar is used for running Sugar after installation.\nauto\nSugar will create a new database user using a self-generated username and password.\nIn your $sugar_config_si array, the options for this to work as expected are:\n'dbUSRData' => 'auto',\n'setup_db_create_sugarsales_user' => true,\nprovide\nSugar will use the provided database username and password after installation, and the installer assumes that the database user has already been created on the database and that the provided password is valid. Essentially this is informing Sugar to use a different existing DB user after the installation has completed.\nIn your $sugar_config_si array, the options for this to work as expected are:\n'dbUSRData' => 'provide',\n'setup_db_create_sugarsales_user' => false,\n'setup_db_sugarsales_user' => '{existing_db_user_name}',\n'setup_db_sugarsales_password' => '{existing_db_user_password}',\n'setup_db_sugarsales_password_retype' => '{existing_db_user_password}',\ncreate", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Silent_Installer_Settings/index.html"}
{"id": "5859f0341340-5", "text": "create\nSugar will create a new database user using the provided database username and password after installation. This is similar to 'provide', except that Sugar assumes that it will be creating the database user during installation.\nIn your $sugar_config_si array, the options for this to work as expected are:\n'dbUSRData' => 'create',\n'setup_db_create_sugarsales_user' => true,\n'setup_db_sugarsales_user' => '{new_db_user_name}',\n'setup_db_sugarsales_password' => '{new_db_user_password}',\n'setup_db_sugarsales_password_retype' => '{new_db_user_password}',\nNote: For create, the installer will create a user with access only to the database created for this Sugar instance. It will also have limited access for which host it can connect from, versus the admin user, which usually has access from any host.\nSugar will set the user to have access to localhost and the provided hostname derived from setup_site_url. If there are issues connecting to the database during or after installation, check that the user was created correctly in the database and that the user can connect from the host that the instance is on.\nOther Silent Install Config Options\nMany of these options match an equivalent Sugar Config option, with further descriptions available at Core Settings.\ncache_dir\nDescription\nThis is the directory Sugar will store all cached files. Can be relative to Sugar root directory.\nType\nString, default \"cache/\"\nLocale Settings\nThe following options are locale settings. With one exception, these can be set or updated through Administration > Locale.\u00c2\u00a0\nexport_delimiter\nDescription\nThe field delimiter (separator) used when exporting records as CSV\nType\nString, default \",\"\ndefault_export_charset\nDescription\nThe default character set for CSV files to be encoded in when exporting\nType", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Silent_Installer_Settings/index.html"}
{"id": "5859f0341340-6", "text": "Description\nThe default character set for CSV files to be encoded in when exporting\nType\nString, default \"ISO-8859-1\"\ndefault_currency_iso4217\nDescription\nThe ISO-4217 code of the default currency\nType\nString, default \"USD\"\ndefault_currency_name\nDescription\nThe name to use for the default currency\nType\nString, default \"US Dollars\"\ndefault_currency_significant_digits\nDescription\nChanges the number of significant digits in currency by default.\nNote that this setting can not be changed through the Admin panel after installation. It can be set for each user through the user's profile or can be updated globally by updating the config array.\nType\nInteger, default 2\ndefault_currency_symbol\nDescription\nThe symbol to use for the default currency\nType\nString, default \"$\"\ndefault_language\nDescription\nSets each user's default language. Possible values include any language offered by Sugar, such as: 'ar_SA', 'bg_BG', 'ca_ES', 'cs_CZ', 'da_DK', 'de_DE', 'el_EL', 'en_UK', 'en_us', 'es_ES', 'es_LA', 'zh_CN'\nType\nString, default \"en_US\"\ndefault_date_format\nDescription\nModifies the default date format for all users.\nType\nString, default \"m/d/Y\"\ndefault_time_format\nDescription\nModifies the default time format for all users.\nType\nString, default \"H:i\"\ndefault_decimal_seperator\nDescription\nSets the character used as a decimal separator for numbers.\nType\nString, default \".\"\ndefault_number_grouping_seperator\nDescription\nSets the character used as the 1000s separator for numbers.\nType\nString, default \",\"\ndefault_locale_name_format\nDescription\nSets the format for displaying full name (eg \"Salutation FirstName LastName\" vs \"LastName, FirstName\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Silent_Installer_Settings/index.html"}
{"id": "5859f0341340-7", "text": "Type\nString, default \"s f l\"\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Silent_Installer_Settings/index.html"}
{"id": "b191d6b5f35c-0", "text": "Core Settings\nOverview\nSugar configuration settings.\nSettings Architecture\nWhen you first install Sugar, all of the default settings are located in ./config.php. As you begin configuring the system, the modified settings are stored in ./config_override.php. Settings in ./config.php are overridden by the values in ./config_override.php.\nSettings\nactivitystreamcleaner\nDescriptionArray that defines the parameters for the Activity Stream purger. TypeArrayVersions9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['activitystreamcleaner'] = array();activitystreamcleaner.keep_all_relationships_activities\nDescriptionThis value is used by the ActivityStreamPurger scheduler job to determine whether the link type activities are to be removed. By default, these records are removed along with other activity types such as create, update, etc.  This can be overridden by setting this value equal to true.TypeBooleanRange of valuestrue or falseVersions9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['activitystreamcleaner']['keep_all_relationships_activities'] = true;activitystreamcleaner.limit_scheduler_run\nDescriptionSets the number of activity stream records to delete per batch when run by the scheduled job that purges activity stream records.TypeInteger : Number of recordsRange of valuesIntegers, values below 0 become 0Versions9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value25000Override Example$sugar_config['activitystreamcleaner']['limit_scheduler_run'] = 1000;activitystreamcleaner.months_to_keep", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-1", "text": "DescriptionThis value is used by the ActivityStreamPurger scheduler job.  When this job runs, it uses this value to determine which Activity Stream records to prune from the activities table.   Activities with a date older than the current date minus this number of months will be removed from the table.TypeInteger : Number of monthsRange of valuesAny integer greater than or equal to 0Versions9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value6Override Example$sugar_config['activitystreamcleaner']['months_to_keep'] = 12;activity_streams\nDescriptionArray that defines parameters for processing Data Privacy erasure requests for activity streams. TypeArrayVersions8.0.1+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['activity_streams'] = array();activity_streams.erasure_job_delay\nDescriptionDefines the number of minutes between Activity Stream Erasure jobs. When multiple jobs are queued, this is the number of minutes that will separate their scheduled execution to allow Data Privacy erasures to occur in batches and minimize concurrent execution. These jobs can take some time to run and can tax the overall server performance if the number of Activity Stream records is very large. This setting is related to activity_streams.erasure_job_limit. These settings should be considered together to optimize throughput of Activity Erasure jobs.TypeInteger : MinutesVersions8.0.1+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value0Override Example$sugar_config['activity_streams']['erasure_job_delay'] = 5;activity_streams.erasure_job_limit", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-2", "text": "DescriptionDefines the maximum number of Data Privacy Records that can be processed by a single running instance of the Activity Stream Erasure job. This setting is related to activity_streams.erasure_job_delay. These settings should be considered together to optimize throughput of Activity Erasure jobs. For example, the longer that an activity erasure job processes, the more delay will be needed to prevent too many jobs executing in parallel.TypeIntegerVersions8.0.1+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value5Override Example$sugar_config['activity_streams']['erasure_job_limit'] = 8;additional_js_config\nDescriptionConfiguration values for when the ./cache/config.js file is generated. It is important to note that after changing this setting or any of its subsettings in your configuration, you must navigate to Admin > Repairs > Quick Repair & Rebuild.TypeArrayVersions7.5.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['additional_js_config'] = array();additional_js_config.alertAutoCloseDelay\nDescriptionDefines the default auto close delay for system alerts. It is important to note that after changing this setting in your configuration, you must navigate to Admin > Repairs > Quick Repair & Rebuild.TypeInteger : MillisecondsVersions7.8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value9000Override Example$sugar_config['additional_js_config']['alertAutoCloseDelay'] = 3000;additional_js_config.authStore", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-3", "text": "DescriptionDefines the implementation of authentication data storage. The default storage, 'cache', is persistent and uses the localStorage API. Alternatively, 'cookie' storage may be used. This will store the authentication data in your browser window until the browser itself is closed. It is important to note that this behavior will differ between browsers. It is important to note that after changing this setting in your configuration, you must navigate to Admin > Repairs > Quick Repair & Rebuild.\nNote: This setting is not respected for instances that use SugarIdentity.TypeStringRange of values'cache' and 'cookie'Versions7.5.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuecacheOverride Example$sugar_config['additional_js_config']['authStore'] = 'cookie';additional_js_config.disableOmnibarTypeahead\nDescriptionDisables the typeahead feature in the listview Omnibar and force users to hit Enter when filtering. From a technical perspective, this will reduce the number of hits to the server.TypeBooleanRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['additional_js_config']['disableOmnibarTypeahead'] = true;additional_js_config.logger.write_to_server\nDescriptionEnables the front end messages to be logged. The logger level must be tuned accordingly under Administration settings. Developers can set the client-side flag by running App.config.logger.writeToServer = true; in their browser's console.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-4", "text": "To simulate logging actions through the console, developers can use:App.logger.trace('message');App.logger.debug('message');App.logger.info('message');App.logger.warn('message');App.logger.fatal('message');TypeBooleanRange of valuestrue and falseVersions7.5.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['additional_js_config']['logger']['write_to_server'] = true;additional_js_config.sidecarCompatMode\nDescriptionBy default, the Sidecar framework will prevent customizations from calling private Sidecar methods. If after upgrading you find this to be an issue, the configuration can be set to true as a temporary workaround. All JavaScript customizations are expected to use public Sidecar APIs. TypeBooleanRange of valuestrue and falseVersions7.10.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['additional_js_config']['sidecarCompatMode'] = true;admin_access_control\nDescriptionRemoves Sugar Updates, Upgrade Wizard, Backups and Module Builder from the Admin menu. For developers, these restrictions can be found in ./include/MVC/Controller/file_access_control_map.php and overriden by creating ./custom/include/MVC/Controller/file_access_control_map.php.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['admin_access_control'] = true;admin_export_only\nDescriptionAllow only users with administrative privileges to export data.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['admin_export_only'] = true;allowFreezeFirstColumn", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-5", "text": "DescriptionGlobal admin config that turns the frozen first columns on/off. This setting can be toggled on and off via Admin > System Settings in Sugar or via code in the config.php file. When this setting is turned off, the ability to freeze the first column of data on a list view is disabled. If the setting is enabled, users will have an option to either freeze or unfreeze the first column on a per-module basis, similar to how you can toggle whether or not a field is included as a column in your list view. Instances running on Sugar's cloud environment will have this setting enforced as true.TypeBooleanVersions12.0.0+ProductsEnterprise, Serve, SellDefault ValuetrueSugarCloud ValuetrueOverride Example$sugar_config['allowFreezeFirstColumn'] = false;allow_oauth_via_get\nDescriptionAs of 7.8, Sugar does not support auth tokens being passed in from GET query string parameters by default. While allowing this functionality is not a recommended practice from a security standpoint, administrators may enable the setting at their own risk.TypeBooleanRange of valuestrue and falseVersions7.8.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['allow_oauth_via_get'] = true;allow_pop_inbound\nDescriptionInbound email accounts are setup to work with IMAP protocols by default. If your email provider required POP3 access instead of IMAP, you can enables POP3 as an available inbound email protocol. Please note that mailboxes configured with a POP3 connection are not supported by SugarCRM and may cause unintended consequences. IMAP is the recommended protocol to use for inbound email accounts.TypeBooleanRange of valuestrue and falseVersions5.5.1+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['allow_pop_inbound'] = true;allow_sendmail_outbound", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-6", "text": "DescriptionEnables the option of choosing sendmail as an SMTP server in Admin > Email Settings. Sendmail must be enabled on the server for this option to work. Please note that mailboxes configured with sendmail are not supported and may cause unintended consequences. Instances running on Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue and falseVersions5.5.1+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuefalseOverride Example$sugar_config['allow_sendmail_outbound'] = true;analytics\nDescriptionAn array defining properties for an analytics connector. Instances running on Sugar's cloud environment will have this setting enforced as a predetermined array.TypeArrayVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellSugarCloud Valuea predetermined arrayOverride Example$sugar_config['analytics'] = array();analytics.connector\nDescriptionThe name of the connector to use for gathering analytics. Instances running on Sugar's cloud environment will have this setting enforced as a predetermined value.TypeString : Connector nameVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellSugarCloud Valuea predetermined valueOverride Example$sugar_config['analytics']['connector'] = 'Pendo';analytics.enabled\nDescriptionDetermines if the analytics are enabled. Instances running on Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuetrueOverride Example$sugar_config['analytics']['enabled'] = true;analytics.id", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-7", "text": "DescriptionThe tracking id for the analytics connector. Instances running on Sugar's cloud environment will have this setting enforced as a predetermined value.TypeString : Tracking IDVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellSugarCloud Valuea predetermined valueOverride Example$sugar_config['analytics']['id'] = 'UA-XXXXXXX-X';api\nDescriptionAPI specific configurations.TypeIntegerVersions7.5.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['api']=array();api.timeout\nDescriptionThe timeout in seconds when uploading files through the REST API.TypeInteger : SecondsVersions7.5.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value180Override Example$sugar_config['api']['timeout'] = 240;authenticationClass\nDescriptionThe class to be used for login authentication.TypeString : Sugar Authentication ClassRange of valuesSAMLAuthenticateVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueSugarAuthenticateOverride Example$sugar_config['authenticationClass'] = 'SAMLAuthenticate';aws\nDescriptionThis configuration's functionality has been deprecated and will be removed in an upcoming release.TypeArrayVersions6.7.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['aws'] = array();aws.aws_key\nDescriptionThis configuration's functionality has been deprecated and will be removed in an upcoming release.TypeString : KeyVersions6.7.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['aws']['aws_key'] = 'key';aws.aws_secret\nDescriptionThis configuration's functionality has been deprecated and will be removed in an upcoming release.TypeString : KeyVersions6.7.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['aws']['aws_secret'] = 'secret';aws.upload_bucket", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-8", "text": "DescriptionThis configuration's functionality has been deprecated and will be removed in an upcoming release.TypeString : S3 bucket nameVersions6.7.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['aws']['upload_bucket'] = 'bucket';cache\nDescriptionArray that defines additional properties for SugarCache if it's enabled (see external_cache).TypeArrayVersions8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['cache'] = array();cache.backend\nDescriptionDefines the SugarCache backend to use via a fully qualified class name (FQCN). Instances running on Sugar's cloud environment will have this setting enforced as Sugarcrm\\Sugarcrm\\Cache\\Backend\\BackwardCompatible.TypeString : Cache LibraryRange of values'Sugarcrm\\Sugarcrm\\Cache\\Backend\\Redis' , '\\Sugarcrm\\Sugarcrm\\Cache\\Backend\\APCu' , '\\Sugarcrm\\Sugarcrm\\Cache\\Backend\\Memcached' , '\\Sugarcrm\\Sugarcrm\\Cache\\Backend\\InMemory' , ''Versions8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueSugarcrm\\Sugarcrm\\Cache\\Backend\\BackwardCompatibleSugarCloud ValueSugarcrm\\Sugarcrm\\Cache\\Backend\\BackwardCompatibleOverride Example$sugar_config['cache']['backend'] = 'Sugarcrm\\Sugarcrm\\Cache\\Backend\\Redis';cache.disable_gz\nDescriptionDefines whether the SugarCache compression should be disabled in multi-tenant deployment, which is not applicable without cache.multi_tenant. This will modify Sugar's caching behavior to disable compression of the cached data. Instances running on Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue and falseVersions12.1.0+ProductsEnterprise, Serve, SellDefault ValuefalseSugarCloud ValuefalseOverride Example$sugar_config['cache']['disable_gz'] = true;cache.encryption_key", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-9", "text": "DescriptionUsed to store encryption key for SugarCache is in multi-tenant mode. By default, Sugar will generate a random UUID string for the encryption key as needed. It is not recommended to change or override this value since it will be regenerated whenever the cache is cleared. Not applicable without  cache.multi_tenant. Instances running on Sugar's cloud environment will have this setting enforced as Random value (unique for each SugarCloud instance).TypeString : UUID stringRange of valuesN/A as it is generated automaticallyVersions8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueRandom value (generated on cache initialization)SugarCloud ValueRandom value (unique for each SugarCloud instance)Override Example$sugar_config['cache']['encryption_key'] = 'Sugar-generated encryption key';cache.gz_level\nDescriptionDefines the SugarCache compression level, which is not applicable without cache.multi_tenant. Instances running on Sugar's cloud environment will have this setting enforced as 9.TypeIntegerRange of values0, 1, 2, 3, 4, 5, 6, 7, 8, 9Versions12.1.0+ProductsEnterprise, Serve, SellDefault Value9SugarCloud Value9Override Example$sugar_config['cache']['gz_level'] = 2;cache.multi_tenant\nDescriptionDefines whether the SugarCache backend will be used by multiple Sugar instances as part of a multi-tenant deployment. This will modify Sugar's caching behavior to maintain isolation between Sugar instances. Instances running on Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuetrueOverride Example$sugar_config['cache']['multi_tenant'] = true;cache_dir", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-10", "text": "DescriptionThis is the directory SugarCRM will store all cached files. Can be relative to Sugar root directory.TypeString : DirectoryVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Valuecache/Override Example$sugar_config['cache_dir'] = 'cache/';cache_expire_timeout\nDescriptionThe length of time cached items should be expired after. TypeInteger : SecondsVersions6.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value300Override Example$sugar_config['cache_expire_timeout'] = 400;calendar\nDescriptionAn array that defines all of the various settings for the Calendar module.TypeArrayVersions6.4.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['calendar'] = array();calendar.day_timestep\nDescriptionSets the default day time step.TypeInteger : DaysRange of values15, 30 and 60Versions6.4.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value15Override Example$sugar_config['calendar']['day_timestep'] = 15;calendar.default_view\nDescriptionChanges the default view in the calendar module.TypeStringRange of values'day', 'week', 'month' and 'share'Versions6.4.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['calendar']['default_view'] = 'week';calendar.items_draggable\nDescriptionEnable/Disable drag-and-drop feature to move calendar items.TypeBooleanRange of valuestrue and falseVersions6.4.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['calendar']['items_draggable'] = true;calendar.items_resizable", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-11", "text": "DescriptionSets whether items on the calendar can be resized via clicking and dragging.TypeBooleanRange of valuestrue and falseVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['calendar']['items_resizable'] = true;calendar.show_calls_by_default\nDescriptionDisplay/Hide calls by default.TypeBooleanRange of valuestrue and falseVersions6.4.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['calendar']['show_calls_by_default'] = true;calendar.week_timestep\nDescriptionThe default week step size when viewing the calendar.TypeInteger : Calendar Step SizeRange of values15, 30, and 60Versions6.4.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['calendar']['week_timestep'] = 30;check_query\nDescriptionValidates queries when adding limits.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['check_query'] = true;check_query_cost\nDescriptionSets the maximum cost limit of a query.TypeIntegerVersions5.2.0+ProductsEnterprise, Ultimate, Serve, SellDefault Value10Override Example$sugar_config['check_query_cost'] = 10;clear_resolved_date\nDescriptionIn Sugar Serve version 9.3 and higher, the Resolved Date field on Cases is automatically cleared when the case's status changes from \"Closed\", \"Rejected\", or \"Duplicate\" to any other value. Setting this parameter to false prevents Sugar from automatically clearing the Resolved Date field.TypeBooleanRange of valuestrue and falseVersions9.3.0+ProductsServeDefault ValuetrueOverride Example$sugar_config['clear_resolved_date'] = false;cloud_insight", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-12", "text": "DescriptionArray that defines the properties for SugarCloud Insights. TypeArrayVersions9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['cloud_insight'] = array();cloud_insight.enabled\nDescriptionDetermines if the SugarCloud Insights service is enabled. TypeBooleanRange of valuestrue and falseVersions9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['cloud_insight']['enabled'] = false;cloud_insight.key\nDescriptionSpecifies the unique key for the SugarCloud Insights service.TypeString : KeyVersions9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['cloud_insight']['key'] = '<insights key>';cloud_insight.url\nDescriptionThe current URL for SugarCloud Insights service. TypeString : URLVersions9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['cloud_insight']['url'] = 'https://sugarcloud-insights.service.sugarcrm.com';collapse_subpanels\nDescriptionPertains to Sidecar modules only. By default, all subpanels are in a collapsed state. If a user expands a subpanel, Sugar caches this preference so that it remains expanded on future visits to the same view. Set this value to 'true' to force a collapsed state for subpanels regardless of user preference, which may improve page-load performance by not querying for data until a user explicitly chooses to expand a subpanel.TypeBooleanRange of valuestrue and falseVersions7.6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['collapse_subpanels'] = true;cron", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-13", "text": "DescriptionArray that defines all of the cron parameters.TypeArrayVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['cron'] = array();cron.enforce_runtime\nDescriptionDetermines if cron.max_cron_runtime is enforced during the cron run.TypeBooleanRange of valuestrue and falseVersions7.2.2.2+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['cron']['enforce_runtime'] = true;cron.max_cron_jobs\nDescriptionMaximum jobs per cron run. Default is 10. If you are using a version prior to 6.5.14, you will need to also populate max_jobs to set this value due to bug #62936 ( https://web.sugarcrm.com/support/issues/62936 ).TypeIntegerVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value6.5.x: 107.6.x: 25Override Example$sugar_config['cron']['max_cron_jobs'] = 10;cron.max_cron_runtime\nDescriptionDetermines the maximum time in seconds that a single job should be allowed to run. If a single job exceeds this limit, cron.php is aborted with the long-running job marked as in progress in the job queue. The next time cron runs, it will skip the job that overran the limit and start on the next job in the queue. This limit is only enforced when cron.enforce_runtime is set to true.TypeInteger : SecondsVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value180Override Example$sugar_config['cron']['max_cron_runtime'] = 60;cron.min_cron_interval", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-14", "text": "DescriptionMinimum time between cron runs. Setting this to 0 will disable throttling completely.TypeInteger : SecondsVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value30Override Example$sugar_config['cron']['min_cron_interval'] = 30;csrf\nDescriptionAn array defining attributes for CSRF token protection.TypeArrayVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['csrf'] = array();csrf.soft_fail_form\nDescriptionWhen opted in for CSRF form authentication, any failures will result in a CSRF message to the user indicating a potential CSRF attack and an aborted action. If you are unsure whether the CSRF tokens are properly implemented in your backward compatible modules, this configuration parameter can be set to true. Setting this to true will avoid any exceptions being thrown to the end user. By default, any failures will result in a fatal log message indicating the issue. If you are running in  \"soft failure\", a second fatal message will be logged such as \"CSRF: attack vector NOT mitigated, soft failure mode enabled\". Be careful enabling this configuration as it will only log CSRF authentication failures and will not protect your system.TypeBooleanRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['csrf']['soft_fail_form'] = true;csrf.token_size\nDescriptionThe size in bytes of the CSRF token to generate.TypeInteger : BytesVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value32Override Example$sugar_config['csrf']['token_size'] = 16;customPortalPlatforms", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-15", "text": "DescriptionThis configuration allows a platform with custom authentication to be excluded from an IDM integration.TypeArray : PlatformsVersions9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['customPortalPlatforms'] = array('platform1', 'platform2');custom_help_base_url\nDescriptionAllows an instance to specify a custom help url for their userTypeString : URLVersions6.4.3+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Valuehttp://www.sugarcrm.com/crm/product_doc.phpOverride Example$sugar_config['custom_help_base_url'] = 'http://www.custom_url/index.php';custom_help_url\nDescriptionDesignate the URL used to redirect the user to help documentation.TypeString : Website addressVersions6.4.3+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Valuehttp://www.sugarcrm.com/crm/product_doc.phpOverride Example$sugar_config['custom_help_url'] = 'http://www.sugarcrm.com/crm/product_doc.php';dbconfig\nDescriptionDefines all of the connection parameters for the database server.TypeArrayVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['dbconfig'] = array();dbconfig.db_host_instance\nDescriptionDefines the host instance for MSSQL connections.TypeString : Database Host Instance NameVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride Example$sugar_config['dbconfig']['db_host_instance'] = 'SQLEXPRESS';dbconfig.db_host_name\nDescriptionPart of the 'dbconfig' array. Defines the host name of the database server.TypeString : Host nameRange of valueshost name of database serverVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride Example$sugar_config['dbconfig']['db_host_name'] = 'localhost';dbconfig.db_manager", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-16", "text": "DescriptionPart of the 'dbconfig' array. Defines the specific library used to connect with your database. Instances running on Sugar's cloud environment will have this setting enforced as MysqliManager.TypeString : Database ManagerRange of valuesThe class name of the database driver, Possible values are: 'MysqlManager', 'MysqliManager', 'FreeTDSManager', 'MssqlManager', and 'SqlsrvManager'.Versions6.4.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueDetermined by install: 'MysqlManager', 'MysqliManager', 'FreeTDSManager', 'MssqlManager', or 'SqlsrvManager'SugarCloud ValueMysqliManagerOverride Example$sugar_config['dbconfig']['db_manager'] = 'MysqliManager';dbconfig.db_name\nDescriptionPart of the 'dbconfig' array. Defines the database name to connect to on the database server.TypeString : Database NameRange of valuesdatabase nameVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride Example$sugar_config['dbconfig']['db_name'] = 'sugar_db';dbconfig.db_password\nDescriptionPart of the 'dbconfig' array. Defines the password that correlates to the db_user_name parameter.TypeString : PasswordRange of valuespassword of the user defined in db_user_nameVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride Example$sugar_config['dbconfig']['db_password'] = 'sql_password';dbconfig.db_port\nDescriptionPart of the 'dbconfig' array. Defines the port number on the server to connect to for authentication and transactions.TypeString : Network PortRange of valuesport number to connect to on the database serverVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value3306Override Example$sugar_config['dbconfig']['db_port'] = '3306';dbconfig.db_type", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-17", "text": "DescriptionDefines the type of database being used with Sugar. It is important to note that db2 and oracle are only applicable to Sugar Enterprise and Ultimate.TypeString : Database EngineRange of values'mysql', 'mssql', 'db2', and 'oci8'Versions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['dbconfig']['db_type'] = 'mysql';dbconfig.db_user_name\nDescriptionDefines the user to connect to the Sugar database as.TypeString : Database UserVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['dbconfig']['db_user_name'] = 'sql_user';dbconfigoption.autofree\nDescriptionAutomatically frees the database reference when it closes the reference.TypeBooleanRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['dbconfigoption']['autofree'] = true;dbconfigoption.collation\nDescriptionThe set of rules to be used for comparing characters in a character set.TypeString : Collation typeVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Valueutf8_general_ciOverride Example$sugar_config['dbconfigoption']['collation'] = 'utf8_general_ci';dbconfigoption.debug\nDescriptionEnables debugging on the database connection.TypeBooleanRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['dbconfigoption']['debug'] = true;dbconfigoption.persistent", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-18", "text": "DescriptionDetermines whether Sugar should use persistent connection when possible to connecting to the database.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['dbconfigoption']['persistent'] = true;dbconfigoption.ssl\nDescriptionEnables SSL on the database connection.TypeBooleanRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['dbconfigoption']['ssl'] = true;dbconfigoption.ssl_options\nDescriptionAn array detailing the SSL database connection options.TypeArrayRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride Example$sugar_config['dbconfigoption']['ssl_options'] = array();dbconfigoption.ssl_options.ssl_capath\nDescriptionThe path the trusted SSL certificate authority file in PEM format for SSL connection to the database.TypeString : File pathRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride Example$sugar_config['dbconfigoption']['ssl_options']['ssl_capath'] = 'path/to/ca-cert';dbconfigoption.ssl_options.ssl_cert\nDescriptionThe path the SSL certificate file for SSL connection to the database.TypeString : File pathRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride Example$sugar_config['dbconfigoption']['ssl_options']['ssl_cert'] = 'path/to/cert';dbconfigoption.ssl_options.ssl_cipher", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-19", "text": "DescriptionThe SSL cipher to be used for encryption.TypeString : CipherRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride Example$sugar_config['dbconfigoption']['ssl_options']['ssl_cipher'] = 'cipher';dbconfigoption.ssl_options.ssl_key\nDescriptionThe path the SSL key for SSL connection to the database.TypeString : File pathRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride Example$sugar_config['dbconfigoption']['ssl_options']['ssl_key'] = 'path/to/key';default_currency_significant_digits\nDescriptionChanges the number of significant digits in currency by default.TypeInteger : Number of significant digitsVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value2Override Example$sugar_config['default_currency_significant_digits'] = 2;default_date_format\nDescriptionModifies the default date format for all users.TypeString : Date formatVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Valuem/d/YOverride Example$sugar_config['default_date_format'] = 'm/d/Y';default_decimal_seperator\nDescriptionSets the character used as a decimal separator for numbers.TypeString : Text characterRange of valuesAny characterVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value.Override Example$sugar_config['default_decimal_seperator'] = '.';default_email_client\nDescriptionSets the default email client that opens when users send emails.TypeString : Email clientRange of values'sugar', 'external'Versions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuesugarOverride Example$sugar_config['default_email_client'] = 'sugar';default_language", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-20", "text": "DescriptionSets each user's default language.  Possible values include any language offered by Sugar, such as: 'ar_SA', 'bg_BG', 'ca_ES', 'cs_CZ', 'da_DK', 'de_DE', 'el_EL', 'en_UK', 'en_us', 'es_ES', 'es_LA', 'et_EE', 'fi_FI', 'fr_FR', 'he_IL', 'hu_HU', 'it_it', 'ja_JP', 'ko_KR', 'lt_LT', 'lv_LV', 'nb_NO', 'nl_NL', 'pl_PL', 'pt_BR', 'pt_PT', 'ro_RO', 'ru_RU', 'sk_SK', 'sq_AL', 'sr_RS', 'sv_SE', 'tr_TR', 'uk_UA', 'zh_CN'TypeString : Language keyRange of valuesAny available languageVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Valueen_usOverride Example$sugar_config['default_language'] = 'en_us';default_number_grouping_seperator\nDescriptionSets the character used as the 1000s separator for numbers.TypeString : Text characterRange of valuesAny characterVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value,Override Example$sugar_config['default_number_grouping_seperator'] = ',';default_permissions\nDescriptionArray that defines the ownership and permissions for directories and files created naturally by the application.TypeArrayVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['default_permissions'] = array();default_permissions.dir_mode", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-21", "text": "DescriptionPart of the 'default_permissions' array. Used in UNIX-based systems only to define the permissions on newly created directories. The value is stored in decimal notation while UNIX file permissions are octal. For example, an octal value of 1528 equates to the permissions 2770. Instances running on Sugar's cloud environment will have this setting enforced as 1528.TypeInteger : Octal ValueVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellSugarCloud Value1528Override Example$sugar_config['default_permissions']['dir_mode'] = 1528;default_permissions.file_mode\nDescriptionPart of the 'default_permissions' array. Used in UNIX-based systems only to define the permissions on newly created files. The value is stored in decimal notation while UNIX file permissions are octal. For example, an octal value of 432 in equates to the permissions 660. Instances running on Sugar's cloud environment will have this setting enforced as 432.TypeInteger : Octal valueVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellSugarCloud Value432Override Example$sugar_config['default_permissions']['file_mode'] = 432;default_permissions.group\nDescriptionUsed in UNIX-based systems only to define the group membership of any newly created directories and files. This value should be a group that the Apache user is a member of to help ensure proper functionality. Instances running on Sugar's cloud environment will have this setting enforced as empty.TypeString : Web groupVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellSugarCloud ValueemptyOverride Example$sugar_config['default_permissions']['group'] = 'apache';default_permissions.user", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-22", "text": "DescriptionPart of the 'default_permissions' array. Used in UNIX-based systems only to define the ownership of any newly created directories and files. This value should be the Apache user. Instances running on Sugar's cloud environment will have this setting enforced as empty.TypeString : Web userRange of valuesApache userVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellSugarCloud ValueemptyOverride Example$sugar_config['default_permissions']['user'] = 'apache';default_user_is_admin\nDescriptionAllows for determining whether a user is a system administrator by default.TypeBooleanRange of valuestrue, falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['default_user_is_admin'] = true;deny_license_update\nDescriptionDetermines whether the license key in Admin > License Management is editable in the user interface. Instances running on Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions9.3.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuetrueOverride Example$sugar_config['deny_license_update'] = true;developerMode\nDescriptionRebuilds various cached files when a page is accessed. Can be set by an admin in Admin > System Settings. Instances running on Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuefalseOverride Example$sugar_config['developerMode'] = true;developer_mode_visible", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-23", "text": "DescriptionDetermines whether the Developer Mode flag is visible to administrators in Admin > System Settings.  Instances running on Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue or falseVersions11.3.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueSugarCloud ValuefalseOverride Example$sugar_config['developer_mode_visible'] = false;diagnostic_file_max_lifetime\nDescriptionThe interval in seconds of when to expire and remove diagnostic files. It is important to note that the \"Remove diagnostic files\" scheduler job must be enabled to remove the diagnostic files.TypeInteger : SecondsVersions7.6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value604800Override Example$sugar_config['diagnostic_file_max_lifetime'] = 604800;disabled_languages\nDescriptionAllows an admin to select languages that are disabled for the instance.TypeString : CSV Language KeysVersions6.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride Example$sugar_config['disabled_languages'] = 'bg_BG,da_DK,de_DE';disable_count_query\nDescriptionRemoves the count totals from listviews. This is commonly used to prevent performing expensive count queries on the database when loading listviews and subpanels. It is important to note that in 7.x, this parameter will only affect modules running in Backward Compatibility mode.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['disable_count_query'] = true;disable_export\nDescriptionPrevents exports of data into .csv files. Normally set in the UI via Admin > Locale.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['disable_export'] = true;disable_related_calc_fields", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-24", "text": "DescriptionWhen a calculated field in Sugar uses the related function in the Sugar Logic, this will cause the calculated field to be executed when the related module is updated. This can cause a cascading effect through the system to update related calculated fields. When this happens you may receive a 502 Gateway Error. Please note that this is a global setting that will affect all modules. If you have a calculated field in Accounts that sums up all Opportunities for the account, setting this value to true will no longer update the opportunity account sum in Accounts until the account record itself is modified. However, if this setting is left disabled, the sum would update any time a related opportunity or the account is modified.TypeBooleanRange of valuestrue and falseVersions6.3.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['disable_related_calc_fields'] = true;disable_team_access_check\nDescriptionPrevents the system from checking to see if the creating/editing user has access to the record being saved. In normal circumstances, if a user creates a record and assigns it to a team they are not part of - their private team will be added. Setting this to true will prevent this.TypeBooleanRange of valuestrue and falseVersions5.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['disable_team_access_check'] = true;disable_unknown_platforms", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-25", "text": "DescriptionControls whether or not unregistered platforms are allowed to be used when logging in using REST API. Custom platforms can be registered via Admin > Configure API Platforms or by using the Platform extension. Used to prevent excessive metadata generation when invalid or unrecognized platform types are specified in an API call.TypeBooleanRange of valuestrue and falseVersions7.6.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value7.6 - 7.10: false7.11 and higher: trueOverride Example$sugar_config['disable_unknown_platforms'] = true;disable_uw_upload\nDescriptionDisables the upgrade wizard from being accessible through the Sugar admin interface. Instances running on Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions5.2.0.j+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuetrueOverride Example$sugar_config['disable_uw_upload'] = true;disable_vcr\nDescriptionDisables record paging in the detailview (VCR controls). Increases performance by not loading all records from a listview into memory when accessing the record detailview. In 7.x versions, this setting is only applicable to modules running in Backward Compatibility Mode.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['disable_vcr'] = true;dump_slow_queries\nDescriptionLogs slow queries to the sugar log file. Instances running on Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuefalseOverride Example$sugar_config['dump_slow_queries'] = true;email_address_separator", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-26", "text": "DescriptionSets the character used to separate email addresses.TypeString : Text characterRange of valuesAny characterVersions6.4.3+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value,Override Example$sugar_config['email_address_separator'] = ',';email_default_client\nDescriptionSets the default email client for all users.TypeString : StringRange of valuessugar, externalVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuesugarOverride Example$sugar_config['email_default_client'] = 'sugar';email_default_delete_attachments\nDescriptionWhen deleting an email, this setting will mark all related notes as deleted, and attempt to delete files that are related to those notes.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['email_default_delete_attachments'] = false;email_default_editor\nDescriptionAllows configuring the default editor type for email. 'plain' sets the editor to only use plain text. 'html' allows the editor to be html enabled.TypeString : StringRange of values'plain' and 'html'Versions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuehtmlOverride Example$sugar_config['email_default_editor'] = 'plain';email_mailer_timelimit\nDescriptionThe timeout period in seconds for SMTP commands. Instances running on Sugar's cloud environment will have this setting enforced as 2.TypeInteger : SecondsRange of valuesAny integer greater than or equal to 1Versions12.2.0+ProductsEnterprise, Ultimate, Serve, SellDefault Value2SugarCloud Value2Override Example$sugar_config['email_mailer_timelimit'] = 30;email_mailer_timeout\nDescriptionThe connection timeout period when sending an email.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-27", "text": "DescriptionThe connection timeout period when sending an email. \nNote: The default value for this configuration is 2 seconds for Sugar versions 12.2.0 and higher. The default value for Sugar versions 7.8.0.0 to 12.1.0 is 10 seconds. \n Instances running on Sugar's cloud environment will have this setting enforced as 2.TypeInteger : SecondsVersions7.8.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value2SugarCloud Value2Override Example$sugar_config['email_mailer_timeout'] = 30;email_recipient_chunk_size\nDescriptionDefines the maximum number of addresses in the email's To field. If an email is to be sent to more than the email_recipient_chunk_size addresses, the list will be split and multiple duplicate emails will be sent, each one with no more than the email_recipient_chunk_size recipients in the To field. Some email service providers limit maximum number of recipients in an email, this option is intended to workaround such limitations. Instances running on Sugar's cloud environment will have this setting enforced as 10.TypeIntegerRange of valuesAny integer greater than or equal to 1Versions12.1.0+ProductsEnterprise, Serve, SellDefault Value10SugarCloud Value10Override Example$sugar_config['email_recipient_chunk_size'] = 20;enable_link_to_drawer\nDescriptionWhen true, the link-to-drawer feature known as \"Focus Drawers\" will be enabled for links to Sidecar module records instance-wide. Focus Drawers are exclusive to Sugar Sell and Sugar Serve.TypeBooleanRange of valuestrue and falseVersions10.3.0+ProductsServe, SellDefault ValuetrueOverride Example$sugar_config['enable_link_to_drawer'] = false;enable_long_text_search", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-28", "text": "DescriptionWhen true, Elasticsearch will enable long-text search for the following field types: 'longtext', 'htmleditable_tinymce'.TypeBooleanRange of valuestrue and falseVersions10.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['enable_long_text_search'] = true;enable_mobile_redirect\nDescriptionFlag indicating whether smartphone users are automatically redirected to the mobile view when navigating to a Sugar instance.TypeBooleanRange of valuestrue and falseVersions7.1.5+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['enable_mobile_redirect'] = false;enable_one_index\nDescriptionIf you are running Elasticsearch 6 or higher, Elasticsearch creates a separate index for each full-text-search-enabled module. However, performance advantages are gained from instead using a single index for the entire instance. The 'enable_one-index' config enables you to move from 1-index-per-module to 1-index-per-instance. This setting can be enabled by an administrator via Admin > Search > Re-Index, and the re-index will automatically switch the instance over to 1 index and change this config to true. TypeBooleanRange of valuestrue or falseVersions11.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['enable_one_index'] = true;exclude_notifications\nDescriptionThis setting controls the modules that are excluded from assignment notifications.TypeArrayVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['exclude_notifications'] = array();exclude_notifications.module\nDescriptionAllows an administrator to explicitly disable modules from sending assignment notifications to users.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['exclude_notifications']['<module>'] = true;external_cache", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-29", "text": "DescriptionSugarCache basic configuration.TypeArrayVersions6.2.0+ProductsEnterprise, Serve, SellOverride Example$sugar_config['external_cache'] = array();external_cache.memcache\nDescriptionThis setting controls the memcache properties.TypeArrayVersions6.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['external_cache']['memcache'] = array();external_cache.memcache.host\nDescriptionThe host url for memchache.TypeString : Host URLVersions6.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value127.0.0.1Override Example$sugar_config['external_cache']['memcache']['host'] = '192.168.1.1';external_cache.memcache.port\nDescriptionThe host port for memcache.TypeInteger : Port numberVersions6.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value11211Override Example$sugar_config['external_cache']['memcache']['port'] = 11212;external_cache.redis\nDescriptionThis setting controls the redis properties.TypeArrayVersions9.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['external_cache']['redis'] = array();external_cache.redis.host\nDescriptionThe IP address or the hostname of the Redis host.TypeStringRange of values'127.0.0.1', '192.168.0.2', 'redis.serveraddress.com', 'local.redis.server.local'Versions9.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value127.0.0.1Override Example$sugar_config['external_cache'] ['redis'] ['host'] = '127.0.0.1';external_cache.redis.persistent", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-30", "text": "DescriptionThe type of connection to the Redis server: persistent or not.TypeBooleanRange of valuestrue and falseVersions9.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['external_cache'] ['redis'] ['persistent'] = false;external_cache.redis.port\nDescriptionThe Port number configured in the Redis host.TypeIntegerRange of valuesAny TCP port numberVersions9.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value6379Override Example$sugar_config['external_cache'] ['redis'] ['port'] = 6377;external_cache.redis.timeout\nDescriptionConnection timeout to the Redis server. 0 means unlimited or OS defined.TypeIntegerRange of valuesAny integer greater than or equal to 0Versions9.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value0Override Example$sugar_config['external_cache'] ['redis'] ['timeout'] = false;external_cache_db_gc_probability\nDescriptionProbability factor to determine when garbage collection on stale keys from the DB backend will happen.TypeInteger : Probability factorVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value0.0001Override Example$sugar_config['external_cache_db_gc_probability'] = 0.0005;external_cache_db_gc_threshold\nDescriptionThe threshold in milliseconds to flag garbage collection queries as [SLOW] in sugarcrm.log.TypeInteger : MillisecondsRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value200Override Example$sugar_config['external_cache_db_gc_threshold'] = 500;external_cache_disabled", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-31", "text": "DescriptionDisables all external caching in Sugar. This is normally set to true to determine if there is a conflict with PHP caching. Instances running on Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuetrueOverride Example$sugar_config['external_cache_disabled'] = true;external_cache_disabled_memcached\nDescriptionDisables Memcached caching from working with Sugar. Recommended setting is false and is normally set to true to determine if there is a conflict with PHP caching. Instances running on Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions6.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuetrueOverride Example$sugar_config['external_cache_disabled_memcached'] = false;external_cache_disabled_wincache\nDescriptionDisables WinCache caching from working with Sugar. Recommended setting is false and is normally set to true to determine if there is a conflict with PHP caching. Instances running on Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuetrueOverride Example$sugar_config['external_cache_disabled_wincache'] = false;external_cache_force_backend\nDescriptionForce given external key/value cache backend. Make sure that the requirements are met and any other cache backend specific configuration is applied.TypeString : Backend typeRange of valuesapc, db, file, memcache, memcached, memory, redis, smash, wincache, and zendVersions6.2.0+ProductsProfessional, EnterpriseDefault ValueemptyOverride Example$sugar_config['external_cache_force_backend'] = 'db';forms", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-32", "text": "DescriptionAn array defining form requirements.TypeArrayVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['forms'] = array();forms.requireFirst\nDescriptionPresents all required fields grouped together in the first panel on the EditView form.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['forms']['requireFirst'] = true;freebusy_use_vcal_cache\nDescriptionPrior to Sugar version 7.6, FreeBusy Calendar searches used the vcals table to cache user meeting and call activity for the purpose of determining user availability in for future free time search. As of 7.6, a new design allowed for more accurate free/busy searching that no longer used this cache, but the cache was still being written to, by default, when calls/meetings were created/updated for backward compatibility reasons. As of Sugar 7.9, in order to enhance performance, the cache is no longer being written to by default.  Instead, the override variable 'FreeBusyCache_Enabled' must be set to true for the Cache to be written.  Since this cache is no longer used inside the Sugar application, this option should be used with caution as the cache itself is expected to be removed from the Sugar product in a future release.TypeBooleanRange of valuestrue and falseVersions6.1.0RC1+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['freebusy_use_vcal_cache'] = true;freezeListHeaders", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-33", "text": "DescriptionGlobal admin config that turns the frozen headers on/off. By default, most list views now have frozen headers and a static pagination element at the bottom of the screen. When the setting is turned off (set to false), this will revert to non-frozen headers and a user having to scroll down to see the pagination buttons. This is enforced in almost every list view in Sugar with the exception of some unique list views that do not have pagination controls. Instances running on Sugar's cloud environment will have this setting enforced as true.TypeBooleanVersions12.0.0+ProductsEnterprise, Serve, SellDefault ValuetrueSugarCloud ValuetrueOverride Example$sugar_config['freezeListHeaders'] = false;gs_use_shortcut_operator\nDescriptionThe default value of true permits use of shortcut operators in global search. These operators are: '&' for AND, '|' for OR, and '-' for NOT. Setting this to false will disable the shortcut operators in global search and cause these characters to be interpreted as literals.TypeBooleanRange of valuestrue and falseVersions8.3.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['gs_use_shortcut_operator'] = falsehide_admin_licensing\nDescriptionHides the License settings subpanel in the administrative panel. Instances running on Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue and falseVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuefalseOverride Example$sugar_config['hide_admin_licensing'] = true;hide_full_text_engine_config", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-34", "text": "DescriptionDetermines if the FTS settings are present in the admin search page in Admin > Search. Instances running on Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions6.5.15+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuetrueOverride Example$sugar_config['hide_full_text_engine_config'] = true;hide_subpanels\nDescriptionThis setting only applies to modules running in Backward Compatibility Mode. When a DetailView is loaded, all subpanels are collapsed. Collapsing subpanels on load increases performance by not querying for data until a user explicitly expands a subpanel.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['hide_subpanels'] = true;hide_subpanels_on_login\nDescriptionThis setting only applies to modules running in backward compatibility mode. Collapses subpanels per session. When a DetailView is initially loaded during a session, all subpanels are collapsed. Once explanded, it will remain expanded until the user logs out. Collapsing subpanels on load increases performance by not querying for data until a user explicitly expands a subpanel.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['hide_subpanels_on_login'] = true;hint\nDescriptionThe array of configurations related to Hint.TypeArrayVersions10.3.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['hint'] = array();hint.hint_install_target_geo", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-35", "text": "DescriptionThis optional property allows you to, before installation of Hint, explicitly set which region you would like Hint to connect to, overriding the default behavior of the Hint installer. The default behavior is for Hint to connect to services hosted in the region nearest to that of the Sugar instance on which it is being installed. See the Hint Administration Guide for more details on Hint service regions: https://support.sugarcrm.com/Documentation/Installable_Connectors/Hint/Hint_Installation_Guide/#Choosing_the_Hint_Services_Region\nNote: Once configured, it is not possible to modify the region Hint connects to. Switching regions requires completely uninstalling and reinstalling Hint, which will cause you to lose all existing system and end-user settings. \nNote: 'APSE' is only available for 12.0 and higher.TypeStringRange of values'US', 'EU', 'APSE'Versions10.3.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['hint']['hint_install_target_geo'] = 'US';history_max_viewed\nDescriptionThe number of history items from the tracker to display for a user.TypeIntegerVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value50Override Example$GLOBALS['sugar_config']['history_max_viewed'] = 25;host_name\nDescriptionSets the host name of the instance, such as the website address or location where the instance is hosted and accessed.TypeString : StringVersions6.5.10+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuelocalhostOverride Example$sugar_config['host_name'] = 'localhost';installer_locked", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-36", "text": "DescriptionSets whether the installer is locked or not. When false, it is possible to access Sugar's initial configuration page to reinstall the instance. Instances running on Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueSugarCloud ValuetrueOverride Example$sugar_config['installer_locked'] = false;jobs\nDescriptionJob Queue configurations.TypeArrayVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['jobs'] = array();jobs.hard_lifetime\nDescriptionHard deletes all jobs that are older than the hard cutoff. Default is 21 days.TypeInteger : DaysVersions6.5.1+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value21Override Example$sugar_config['jobs']['hard_lifetime'] = 21;jobs.max_retries\nDescriptionMaximum number of failures for job. Default is 5.TypeInteger : Number of failuresVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value5Override Example$sugar_config['jobs']['max_retries'] = 5;jobs.min_retry_interval\nDescriptionMinimal interval between job reruns. Default is 30 seconds.TypeInteger : SecondsVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value30Override Example$sugar_config['jobs']['min_retry_interval'] = 30;jobs.soft_lifetime\nDescriptionSoft deletes all jobs that are older than cutoff. Default is 21 days.TypeInteger : DaysVersions6.5.1+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value7Override Example$sugar_config['jobs']['soft_lifetime'] = 7;jobs.timeout", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-37", "text": "DescriptionIf a job is running longer than the limit, the job is failed by force. Specified in seconds. Default is 3600 seconds (1 hour).TypeInteger : SecondsVersions6.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value3600Override Example$sugar_config['jobs']['timeout'] = 86400;languages\nDescriptionThe list of languages available in the system. An administrator can limit the languages available by removing them from this array. When modifying this array, you will need to make sure that the default_language config setting matches a language available in the list.TypeArray : Language KeysVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueAll available languagesOverride Example$sugar_config['languages'] =  array ('en_us' => 'English (US)');list_max_entries_per_page\nDescriptionListview items per page.TypeString : Records per pageVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value20Override Example$sugar_config['list_max_entries_per_page'] = '20';list_report_max_per_page\nDescriptionSets the maximum number of reports that are listed on each page in the Reports module.TypeInteger : Number of recordsVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value100Override Example$sugar_config['list_report_max_per_page'] = 100;logger\nDescriptionAn array that defines all of the logging settings.TypeArrayVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger'] = array();logger.channels", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-38", "text": "DescriptionThis setting controls the PSR-3 Logger channels. There are stock channels included in Sugar that can be utilized for various troubleshooting, and custom channels can easily be utilized in custom code. Please consult the PSR-3 Logger Documentation for further information on modifying channels and utilizing them.TypeArrayVersions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels'] = array();logger.channels.authentication\nDescriptionThis setting controls the PSR-3 Logger Channel configuration for the authentication channel.TypeArrayVersions7.10.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['authentication'] = array();logger.channels.authentication.handlers\nDescriptionThis setting controls the PSR-3 Logger Handler utilized by the authentication logging channel. TypeArrayVersions7.10.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['authentication']['handlers'][] = 'File';logger.channels.authentication.level\nDescriptionThis setting controls the authentication PSR-3 Logger channel's log level. If you need to troubleshoot authentication issues in Sugar, and do not want to enable debug logging on the entire system, you can utilize this channel for more robust logging around the Authentication Controller.TypeString : Logging levelRange of values'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off'Versions7.10.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['authentication']['level'] = 'debug';logger.channels.authentication.processors", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-39", "text": "DescriptionThis setting controls the authentication PSR-3 Logger channels processors. TypeArray : Logging ProcessorsRange of values'request', 'backtrace'Versions7.10.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['authentication']['authentication']['processors'] = array('request', 'backtrace');logger.channels.channel\nDescriptionThis setting controls the PSR-3 Logger channels. There are stock channels included in Sugar that can be utilized for various troubleshooting, and custom channels can easily be utilized in custom code. The channel configuration typically consists of three properties, the level, handlers, and processors, however not all need to be defined as they do inherit their properties from the default Logger implementation. Please consult the PSR-3 Logger Documentation for further information on adding custom channels and utilizing them.TypeArrayVersions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['<channel>'] = array();logger.channels.channel.handlers\nDescriptionThis setting controls the PSR-3 Logger Handler utilized by the defined logging channel. By default Sugar only comes with the 'File' handler, however custom handlers can easily be added as outlined in our PSR-3 Logger Documentation.TypeArrayVersions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['<channel>']['handlers'][] = 'File';logger.channels.channel.level", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-40", "text": "DescriptionThis setting controls the PSR-3 Log Level for the specified log channel.TypeString : Logging levelRange of values'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off'Versions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['<channel>']['level'] = 'alert';logger.channels.channel.processors\nDescriptionThis setting controls a specific PSR-3 Logger channels processors. To more easily debug issues, you can enable the provided backtrace or request Log Processors to provide more insight into a particular log. For more information on adding custom processors and using them on logging channels consult the PSR-3 Logger Documentation.TypeArray : Logging ProcessorsRange of values'request', 'backtrace'Versions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['<channel>']['processors'] = array('request', 'backtrace');logger.channels.db\nDescriptionThis setting controls the PSR-3 Logger Channel configuration for the db channel.TypeArrayVersions8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['db'] = array();logger.channels.db.handlers\nDescriptionThis setting controls the PSR-3 Logger Handler utilized by the db logging channel. TypeArrayVersions8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['db']['handlers'][] = 'File';logger.channels.db.level", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-41", "text": "DescriptionThis setting controls the Log Level for the db channel of the PSR-3 Logger. TypeString : Logging levelRange of values'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off'Versions8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['db']['level'] = 'debug';logger.channels.db.processors\nDescriptionThis setting controls the db PSR-3 Logger channels processors. TypeArray : Logging ProcessorsRange of values'request', 'backtrace'Versions8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['db']['processors'] = array('request', 'backtrace');logger.channels.deprecation\nDescriptionThis setting controls the PSR-3 Logger Channel configuration for the deprecation channel. If you need to clean up your customizations from usage of deprecated functionality of Sugar or some underlying libraries which implement runtime deprecation logging and you do not want to enable warning logging on the entire system, you can utilize this channel. Instances running on Sugar's cloud environment will have this setting enforced as empty.TypeArrayVersions11.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptySugarCloud ValueemptyOverride Example$sugar_config['logger']['channels']['deprecation'] = [];logger.channels.deprecation.handlers", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-42", "text": "DescriptionThis setting controls the PSR-3 Logger Handler utilized by the deprecation logging channel. By default, Sugar only comes with the File handler, however custom handlers can be added as outlined in our PSR-3 Logger documentation. Instances running on Sugar's cloud environment will have this setting enforced as empty.TypeArrayVersions11.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptySugarCloud ValueemptyOverride Example$sugar_config['logger']['channels']['deprecation']['handlers'][] = [ 'type' => 'File', 'name' => 'symfony_deprecations', ];logger.channels.deprecation.level\nDescriptionThis setting controls the deprecation PSR-3 Logger channel's log level. Instances running on Sugar's cloud environment will have this setting enforced as alert.TypeString : Logging LevelRange of valuesemergency, alert, critical, error, warning, notice, info, debug, offVersions11.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuealertSugarCloud ValuealertOverride Example$sugar_config['logger']['channels']['deprecation']['level'] = 'warning';logger.channels.deprecation.processors\nDescriptionThis setting controls the deprecation PSR-3 Logger channels processors. To more easily debug issues, you can enable the provided backtrace or request Log Processors to provide more insight into a particular log. For more information on adding custom processors and using them on logging channels, please refer to the PSR-3 Logger documentation. Instances running on Sugar's cloud environment will have this setting enforced as empty.TypeArray : Logging ProcessorsRange of valuesrequest, backtraceVersions11.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptySugarCloud ValueemptyOverride Example$sugar_config['logger']['deprecation']['processors'] = ['request', 'backtrace'];logger.channels.input_validation", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-43", "text": "DescriptionThis setting controls the PSR-3 Logger Channel configuration for the input_validation channel.TypeArrayVersions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['input_validation'] = array();logger.channels.input_validation.handlers\nDescriptionThis setting controls the PSR-3 Logger Handler utilized by the input_validation logging channel. TypeArrayVersions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['input_validation']['handlers'][] = 'File';logger.channels.input_validation.level\nDescriptionThis setting controls the logging level for input validation failure messages when validation.soft_fail is enabled.TypeString : Logging levelRange of values'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off'Versions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['input_validation']['level'] = 'warning';logger.channels.input_validation.processors\nDescriptionThis setting controls the input_validation PSR-3 Logger channels processors. TypeArray : Logging ProcessorsRange of values'request', 'backtrace'Versions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['input_validation']['processors'] = array('request', 'backtrace');logger.channels.metadata\nDescriptionThis setting controls the PSR-3 Logger Channel configuration for the metadata channel.TypeArrayVersions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['metadata'] = array();logger.channels.metadata.handlers", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-44", "text": "DescriptionThis setting controls the PSR-3 Logger Handler utilized by the metadata logging channel. TypeArrayVersions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['metadata']['handlers'][] = 'File';logger.channels.metadata.level\nDescriptionThis logging channel can be used to track and debug metadata refresh issues. Overly frequent metadata refreshes will cause performance issues for affected Sugar instances. This metadata logging channel can help determine the frequency and causes of metadata refreshes.TypeString : Logging levelRange of values'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off'Versions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['metadata']['level'] = 'debug';logger.channels.metadata.processors\nDescriptionThis setting controls the metadata PSR-3 Logger channels processors. TypeArray : Logging ProcessorsRange of values'request', 'backtrace'Versions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['metadata']['processors'] = array('request', 'backtrace');logger.channels.rest\nDescriptionThis setting controls the PSR-3 Logger Channel configuration for the rest channel.TypeArrayVersions7.10.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['rest'] = array();logger.channels.rest.handlers\nDescriptionThis setting controls the PSR-3 Logger Handler utilized by the rest logging channel. TypeArrayVersions7.10.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['rest']['handlers'][] = 'File';logger.channels.rest.level", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-45", "text": "DescriptionThis setting controls the Log Level for the rest channel of the PSR-3 Logger. TypeString : Logging levelRange of values'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug', 'off'Versions7.10.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['rest']['level'] = 'debug';logger.channels.rest.processors\nDescriptionThis setting controls the rest PSR-3 Logger channels processors. TypeArray : Logging ProcessorsRange of values'request', 'backtrace'Versions7.10.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['logger']['channels']['rest']['processors'] = array('request', 'backtrace');logger.file.dateFormat\nDescriptionThe date format for the log file is any value that is acceptable to the PHP strftime() function. The default is '%c'. For a complete list of available date formats, please see the strftime() PHP documentation at http://php.net/manual/en/function.strftime.php.TypeString : Date formatRange of valuesPattern for date formatVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value%cOverride Example$sugar_config['logger']['file']['dateFormat'] = '%c';logger.file.ext\nDescriptionThe extension of the log file. The default value is '.log'. Instances running on Sugar's cloud environment will have this setting enforced as .log.TypeString : File extensionRange of valuesExtension for the logVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value.logSugarCloud Value.logOverride Example$sugar_config['logger']['file']['ext'] = '.log';logger.file.maxLogs", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-46", "text": "DescriptionWhen the log file grows to the logger.file.maxSize value, the system will automatically roll the log file. The logger.file.maxLogs value controls the max number of logs that will be saved before it deletes the oldest. The default value is 10.TypeInteger : Number of logsVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value10Override Example$sugar_config['logger']['file']['maxLogs'] = 10;logger.file.maxSize\nDescriptionThis value controls the max file size of a log before the system will roll the log file. It must be set in the format '10MB' where 10 is number of MB to store. Always use MB as no other value is currently accepted. To disable log rolling set the value to false. The default value is '10MB'. Instances running on Sugar's cloud environment will have this setting enforced as 10MB.TypeString : SizeVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value10MBSugarCloud Value10MBOverride Example$sugar_config['logger']['file']['maxSize'] = '10MB';logger.file.name\nDescriptionThe name of the log file to be written to. Instances running on Sugar's cloud environment will have this setting enforced as sugarcrm.TypeString : FilenameVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuesugarcrmSugarCloud ValuesugarcrmOverride Example$sugar_config['logger']['file']['name'] = 'sugarcrm';logger.file.suffix", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-47", "text": "DescriptionThe suffix to the file name to track logs chronologically. For instance, if you wanted to append the month and year to a file name, you can change this setting to '%m_%Y'. For a complete list of available date formats, please see the strftime() PHP documentation at http://php.net/manual/en/function.strftime.php. Instances running on Sugar's cloud environment will have this setting enforced as empty.TypeString : Suffix patternVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptySugarCloud ValueemptyOverride Example$sugar_config['logger']['file']['suffix'] = '%m_%Y';logger.level\nDescriptionDetermines the logging level of the system. The recommended setting is 'fatal'. Instances running on Sugar's cloud environment will have this setting enforced as fatal.TypeString : Logging levelRange of values'debug', 'info', 'warn', 'deprecated', 'error', 'fatal', 'security', 'off'Versions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefatalSugarCloud ValuefatalOverride Example$sugar_config['logger']['level'] = 'fatal';logger_visible\nDescriptionDetermines whether the Logger Settings panel is visible to administrators in Admin > System Settings. Instances running on Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue and falseVersions6.7.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueSugarCloud ValuefalseOverride Example$sugar_config['logger_visible'] = false;log_dir", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-48", "text": "DescriptionSets the location in the file system where the Sugar log file will be stored. By default, it is set to '.' meaning that it is stored in the root instance directory. Instances running on Sugar's cloud environment will have this setting enforced as ..TypeString : Directory PathVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value.SugarCloud Value.Override Example$sugar_config['log_dir'] = '.';log_file\nDescriptionDesignates the file name where the instance's logs will be stored. Instances running on Sugar's cloud environment will have this setting enforced as sugarcrm.log.TypeString : Name of the log fileVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Valuesugarcrm.logSugarCloud Valuesugarcrm.logOverride Example$sugar_config['log_file'] = 'new_sugarcrm.log'log_memory_usage\nDescriptionLogs the memory usage. Instances running on Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue and falseVersions5.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuefalseOverride Example$sugar_config['log_memory_usage'] = true;maintenanceMode\nDescriptionAllows the instance to be placed in a maintenance mode where non-admin users cannot access the instance.TypeBooleanRange of valuestrue and falseVersions7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['maintenanceMode'] = false;marketing_extras_enabled\nDescriptionThis configuration disables the marketing content on the Sugar login screen.TypeBooleanRange of valuestrue and falseVersions8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['marketing_extras_enabled'] = false;mark_emails_seen", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-49", "text": "DescriptionDetermines whether to mark an email as read before importing the email to Sugar during the inbound email import. This is not recommended as an import failure will cause the email to be marked as read which will be skipped during the next inbound email import.TypeBooleanRange of valuestrue and falseVersions6.5.17+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['mark_emails_seen'] = true;mass_actions\nDescriptionArray that defines mass action behaviors.TypeArrayVersions7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['mass_actions'] = array();mass_actions.mass_delete_chunk_size\nDescriptionNumber of records per chunk while performing a mass delete.TypeIntegerVersions7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value20Override Example$sugar_config['mass_delete_chunk_size'] = 20;mass_actions.mass_link_chunk_size\nDescriptionNumber of records per chunk while performing mass linking updates.TypeIntegerVersions7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value20Override Example$sugar_config['mass_actions']['mass_link_chunk_size'] = 20;mass_actions.mass_update_chunk_size\nDescriptionNumber of records per chunk while performing a mass update.TypeIntegerVersions7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value500Override Example$sugar_config['mass_actions']['mass_update_chunk_size'] = 500;mass_actions.max_records_to_merge\nDescriptionNumber of records per chunk while performing a mass merge.TypeIntegerVersions7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value5Override Example$sugar_config['mass_actions']['max_records_to_merge'] = 20;maxPinnedModules\nDescriptionThe number of pinned modules to be displayed on the navigation bar (in the collapsed state).", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-50", "text": "DescriptionThe number of pinned modules to be displayed on the navigation bar (in the collapsed state).\nNote: For Sugar versions 13.0.0 and higher, the number of pinned modules can also be configured via Admin > Navigation Bar and Subpanels. Instances running on Sugar's cloud environment will have this setting enforced as 4.TypeIntegerVersions12.3.0+ProductsEnterprise, Serve, SellDefault Value4SugarCloud Value4Override Example$sugar_config['maxPinnedModules'] = 6;max_aggregate_email_attachments_bytes\nDescriptionThe maximum allowed size of all uploaded attachments added together for a single email message. Users may upload files as email attachments within to the lowest of the PHP upload_max_filesize, post_max_size, and system upload_maxsize size limits, but users cannot upload more files to a single message than the max_aggregate_email_attachments_bytes configuration permits.TypeInteger : bytesVersions7.10.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value10000000Override Example$sugar_config['max_aggregate_email_attachments_bytes'] = 20000000;max_session_time\nDescriptionDetermines the maximum lock time in seconds between session requests. When a session request is locked for long periods of time, other requests are blocked until it is released. A null value will not implement a max session time. Instances running on Sugar's cloud environment will have this setting enforced as 1.TypeInteger : SecondsVersions6.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuenullSugarCloud Value1Override Example$sugar_config['max_session_time'] = 1;metrics_enabled\nDescriptionWhether or not system metrics have been enabled.TypeBooleanRange of valuestrue and falseVersions6.7.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['metrics_enabled'] = true;metric_providers", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-51", "text": "DescriptionA Name/Path array of metric providers for measuring system metricsTypeArrayVersions6.7.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['metric_providers'] = array ('provider' => 'path/to/provider');metric_settings\nDescriptionThe individual settings required by a metric provider. And values provided will be passed when instantiating the metric providers object.TypeArray : Metric Provider SettingsVersions6.7.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['metric_settings'] = array ('provider' => array('setting' => 'value'));minify_resources\nDescriptionDetermines whether minification and compression are applied to javascript resourcesTypeBooleanRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['minify_resources'] = false;moduleInstaller\nDescriptionArray that defines restrictions on module installations via the Module Loader utility.TypeArrayVersions5.2.0.j+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['moduleInstaller'] = array();moduleInstaller.disableActions\nDescriptionPart of the moduleInstaller array. When packageScan is set to 'true', Sugar does not restrict any specific actions that can be completed during the installation process. The disableActions parameter allows you to define any actions you wish to restrict from executing.TypeArrayRange of valuesSpecific actions to restrict in module packagesVersions5.2.0j+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Valuearray()Override Example$sugar_config['moduleInstaller']['disableActions'] = array('pre_execute', 'post_execute');moduleInstaller.disableFileScan", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-52", "text": "DescriptionWhen packageScan is set to 'true', Sugar scans all files in an installable package to ensure that the file extensions are acceptable and that the files do not contain denylisted class or function calls. Setting the disableFileScan parameter to 'true' avoids this scan from occurring while still enforcing other parameters set.TypeBooleanRange of valuestrue and falseVersions5.2.0j+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['moduleInstaller']['disableFileScan'] = true;moduleInstaller.packageScan\nDescriptionEnables package scanning on any modules uploaded through Module Loader prior to the installation. If the package is found to violate any restrictions of the packageScan, the installation will not proceed and an error report will be generated to the user attempting the install. Instances running on Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions5.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuetrueOverride Example$sugar_config['moduleInstaller']['packageScan'] = true;moduleInstaller.validExt", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-53", "text": "DescriptionPart of the moduleInstaller array. When moduleInstaller.packageScan is set to true, Sugar will not allow certain file extensions to be present in an installable package. By default, Sugar allows the following extensions: 'png', 'gif', 'jpg', 'css', 'js', 'php', 'txt', 'html', 'htm', 'tpl', 'pdf', 'md5', 'xml', 'hbs', 'less', and 'wsdl'. This parameter allows you to define additional extensions deemed safe to install on your instance of Sugar.  Instances running on Sugar's cloud environment will have this setting enforced as array('eot','svg','tff','woff','woff2','xml','md').TypeArray : ExtensionsRange of valuesFile extensions to allowVersions6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Valuearray()SugarCloud Valuearray('eot','svg','tff','woff','woff2','xml','md')Override Example$sugar_config['moduleInstaller']['validExt'] = array('swf', 'log');mso_fixup_paragraph_tags\nDescriptionDetermines whether email HTML is scrubbed for empty paragraph tags when displayed in the application. Setting this value to true will enable the HTML scrubbing. Enabling this setting does not affect the HTML stored in the database from the initial import. Created as a result of bug 66022 (https://web.sugarcrm.com/support/issues/66022).TypeBooleanRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['mso_fixup_paragraph_tags'] = true;new_email_addresses_opted_out", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-54", "text": "DescriptionIf true, then newly created EmailAddress records in Sugar will be opted-out by default. This setting can also be controlled using the \"Opt-out new email addresses by default\" setting in Admin > System Email Settings.TypeBooleanRange of valuestrue and falseVersions8.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['new_email_addresses_opted_out'] = true;noPrivateTeamUpdate\nDescriptionPrevents name changes to a users private team. This setting can be modified by changing in Admin > System Settings > Advanced > Prevent name changes by users to update their Private Team NameTypeBooleanRange of valuestrue and falseVersions7.6.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['noPrivateTeamUpdate'] = true;oauth2\nDescriptionConfigutations for the oauth2 server.TypeArrayVersions7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['oauth2'] = array();oauth2.access_token_lifetime\nDescriptionThe lifetime of the access token in seconds.  This setting controls how often Sugar will check to see if the user's token has expired. It is recommended for this value not to surpass more than half of the oauth2.refresh_token_lifetime setting. Note: This setting cannot exceed the maximum PHP session timeout, which is configured by PHP setting session.gc_maxlifetime. In SugarCloud the maximum session timeout is set to 7200s (2 hours).Note: This setting is not respected for instances that use SugarIdentity.TypeInteger : SecondsVersions7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value3600Override Example$sugar_config['oauth2']['access_token_lifetime'] = 3600;oauth2.refresh_token_lifetime", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-55", "text": "DescriptionThe lifetime of refresh token in seconds. We recommend the oauth2.refresh_token_lifetime remains at 1209600 seconds or less for security. Should you increase this number, do not exceed 2147220 seconds. Note: This setting is not respected for instances that use SugarIdentity.TypeIntegerVersions7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value1209600Override Example$sugar_config['oauth2']['refresh_token_lifetime'] = 1409600;oauth_token_expiry\nDescriptionSets whether OAuth tokens will expire.TypeStringRange of valuestrue and falseVersions7.5.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueFalseOverride Example$sugar_config['oauth_token_expiry'] = '0';oauth_token_life\nDescriptionSets the length (in seconds) of the life of an OAuth token.TypeInteger : SecondsVersions7.5.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value86400Override Example$sugar_config['oauth_token_life'] = '86400';passwordHash\nDescriptionArray that defines the password hashing behaviors.\nNote: This configuration's functionality has been deprecated in Sugar versions 13.0 and higher and will be removed in a future release.TypeArrayVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['passwordHash'] = array();passwordHash.algo\nDescriptionThe specific algorithm to be used by the hashing backend. The available values depend on the selected passwordHash.backend. See http://php.net/manual/en/password.constants.php for more information when using the native backend.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-56", "text": "Note: This configuration's functionality has been deprecated in Sugar versions 13.0 and higher and will be removed in a future release.TypeString : Algorithm TypeRange of valuesFor native backend:  \"PASSWORD_DEFAULT\" and \"PASSWORD_BCRYPT\".   For sha2 backend:  \"CRYPT_SHA256\" and \"CRYPT_SHA512\"Versions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value\"PASSWORD_DEFAULT\" for native. \"CRYPT_SHA256\" for sha2 backend.Override Example$sugar_config['passwordHash']['algo'] = 'PASSWORD_BCRYPT';passwordHash.allowLegacy\nDescriptionAllow logins of users who have their password stored using the insecure legacy MD5 hash. During the transition period for the 7.7 series, this will be allowed out of the box. Versions past 7.7 will no longer allow by default authentication against insecure hashes. This configuration parameter can be used to change the default behavior.\nNote: This configuration's functionality has been deprecated in Sugar versions 13.0 and higher and will be removed in a future release.TypeBooleanRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value7.7.x: true7.8.x+:falseOverride Example$sugar_config['passwordHash']['allowLegacy'] = false;passwordHash.backend\nDescriptionThe password hash backend class to use. By default, the \"native\" backend is used which uses Blowfish to hash the passwords in the database. An alternative is using the \"sha2\" backend which makes use of SHA-2 hashing instead. Depending on the backend, different configuration options are available for passwordHash.algo and passwordHash.options.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-57", "text": "Note: This configuration's functionality has been deprecated in Sugar versions 13.0 and higher and will be removed in a future release.TypeStringRange of values'sha2' and 'native'Versions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuenativeOverride Example$sugar_config['passwordHash']['backend'] = 'sha2';passwordHash.options\nDescriptionThe available configuration values depend on the selected passwordHash.backend. See http://php.net/manual/en/function.password-hash.php when using the native backend and http://php.net/manual/en/function.crypt.php for the sha2 backend. Note that only the following specified options are allowed. For native backend: passwordHash.options.cost. For sha2 backend: passwordHash.options.rounds.\nNote: This configuration's functionality has been deprecated in Sugar versions 13.0 and higher and will be removed in a future release.TypeArrayVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['passwordHash']['options'] = array();passwordHash.options.cost\nDescriptionAn available option when the passwordHash.backend configuration is set to \"native\". More information on the native backend can be found at http://php.net/manual/en/function.password-hash.php\nNote: This configuration's functionality has been deprecated in Sugar versions 13.0 and higher and will be removed in a future release.TypeIntegerVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value10Override Example$sugar_config['passwordHash']['options']['cost'] = 15;passwordHash.options.rounds\nDescriptionAn available option when the passwordHash.backend configuration is set to \"sha2\". More information on the sha2 backend can be found at http://php.net/manual/en/function.crypt.php", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-58", "text": "Note: This configuration's functionality has been deprecated in Sugar versions 13.0 and higher and will be removed in a future release.TypeIntegerVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value5000Override Example$sugar_config['passwordHash']['options']['rounds'] = 4000;passwordHash.rehash\nDescriptionWhen enabled, the system will automatically rehash the user's password when successfully authenticated. This allows adoption to the newly configured password hash backend without resetting user's passwords.\nNote: This configuration's functionality has been deprecated in Sugar versions 13.0 and higher and will be removed in a future release.TypeBooleanRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['passwordHash']['rehash'] = false;passwordsetting\nDescriptionDefines all of the password requirements for the instance.TypeArrayVersions5.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['passwordsetting'] = array();passwordsetting.forgotpasswordON\nDescriptionEnables the Forgot Password features. When enabled, users will have the ability to reset their own passwords at the Login page. Set in UI via Admin->Password Management.TypeStringRange of values0, 1Versions5.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value1Override Example$sugar_config['passwordsetting']['forgotpasswordON'] = '0';passwordsetting.linkexpiration\nDescriptionDetermines whether the password reset link expires.TypeStringRange of values0, 1Versions6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value0Override Example$sugar_config['passwordsetting']['linkexpiration'] = '0';passwordsetting.onelower", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-59", "text": "DescriptionConfigures whether at least one lower-case letter is required in users' passwords.TypeStringRange of values0, 1Versions6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value0Override Example$sugar_config['passwordsetting']['onespecial'] = '0';passwordsetting.onenumber\nDescriptionConfigures whether at least one number is required in users' passwords.TypeStringRange of values0, 1Versions6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value1Override Example$sugar_config['passwordsetting']['onenumber'] = '1';passwordsetting.oneupper\nDescriptionConfigures whether at least one upper-case letter is required in users' passwords.TypeBooleanRange of values0, 1Versions6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value0Override Example$sugar_config['passwordsetting']['oneupper'] = 1;passwordsetting.systexpirationtype\nDescriptionSpecifies the unit of measurement for passwordsetting.systexpirationtime. The available options are: Days (1), Weeks (7) and Months (30). This value can be set in the UI via Admin > Password Management.TypeIntegerRange of values1, 7, and 30Versions5.5.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value1Override Example$sugar_config['passwordsetting']['systexpirationtype'] = '7';pdf_file_max_lifetime\nDescriptionThe interval in seconds of when to expire and remove generated PDF files. It is important to note that the \"Remove temporary PDF files\" scheduler job must be enabled to remove the PDF files.TypeInteger : SecondsVersions7.6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value86400Override Example$sugar_config['pdf_file_max_lifetime'] = 86400;perfProfile", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-60", "text": "DescriptionAllows for an admin to tweak aspects of the system for performance enhancements when fetching records. As every system is different, your mileage will vary when using the perfProfile settings. Increases or decreases in performance will depend on a combination of primarily the amount of users, amount of unique team sets, and data size per module. The perfProfile parameters are available to be able to fine tune the team security performance no your platform. It is not recommended to change any setting directly in a production environment without testing and understanding the impact.TypeArrayVersions7.2.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['perfProfile'] = array();perfProfile.TeamSecurity\nDescriptionDetermines whether the team security filtering is applied.TypeArrayVersions7.2.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['perfProfile']['TeamSecurity'] = array();perfProfile.TeamSecurity.default\nDescriptionThis setting is used to enable or disable Team Security denormalization feature by default across the application.TypeArrayRange of valuestrue and falseVersions7.7.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['perfProfile']['TeamSecurity']['default'] = array();perfProfile.TeamSecurity.default.disable_subquery_optimizer_hint", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-61", "text": "DescriptionAs of Sugar 11.0.2, the default behavior of TeamSecurity on MySQL no longer uses an INNER JOIN to a 'team_sets' subquery; instead, Sugar 11.0.2 and higher use WHERE team_set_id IN [team_sets subquery] with a MySQL optimizer hint. To disable this approach and switch back to the INNER JOIN implementation, set this config to 'true'.TypeBooleanRange of valuestrue and falseVersions11.0.2+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['perfProfile']['TeamSecurity']['default']['disable_subquery_optimizer_hint'] = true;perfProfile.TeamSecurity.default.teamset_prefetch\nDescriptionFetches the list of team sets that the current user is a member of in a separate query and use those ID's directly in the team security clause to avoid adding a subquery. Under certain conditions, this may improve team security performance.\nIt is important to note that 'default' applies this applied to all modules. To set specific settings for a specific module, you will need to use:\n$sugar_config['perfProfile']['TeamSecurity']['{module}']['teamset_prefetch'] = true;TypeBooleanRange of valuestrue and falseVersions7.2.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['perfProfile']['TeamSecurity']['default']['teamset_prefetch'] = true;perfProfile.TeamSecurity.default.teamset_prefetch_max\nDescriptionThe maximum amount of team set ID's to include in the team security clause. If the current user is a member of more unique teams sets than this value, the system will fall back to using a regular subquery instead. Under certain conditions, this may improve team security performance.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-62", "text": "It is important to note that 'default' applies this applied to all modules. To set specific settings for a specific module, you will need to use:\n$sugar_config['perfProfile']['TeamSecurity']['{module}']['teamset_prefetch_max'] = true;TypeInteger : RecordsVersions7.2.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptyOverride Example$sugar_config['perfProfile']['TeamSecurity']['default']['teamset_prefetch_max'] = 500;perfProfile.TeamSecurity.default.use_denorm\nDescriptionThis setting is used to enable or disable Team Security denormalization feature. Team Security denormalization can significantly improve SQL query performance when there are a large number of Teams in a Sugar instance. The cost is that this feature relies on a separate Team security denormalization table that needs to be updated as records change to ensure Sugar's Team security visibility rules are applied properly.\nIt is important to note that 'default' applies this to all modules. To set specific settings for a specific module, you will need to use:\n$sugar_config['perfProfile']['TeamSecurity']['{module}']['use_denorm'] = true;TypeBooleanRange of valuestrue and falseVersions8.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['perfProfile']['TeamSecurity']['default']['use_denorm'] = true;perfProfile.TeamSecurity.default.where_condition\nDescriptionDetermines whether the team security filtering is applied in the WHERE clause instead of SELECT clause. Under certain conditions, this may improve team security performance.\nIt is important to note that 'default' applies this applied to all modules. To set specific settings for a specific module, you will need to use:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-63", "text": "$sugar_config['perfProfile']['TeamSecurity']['{module}']['where_condition'] = true;TypeBooleanRange of valuestrue and falseVersions7.2.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['perfProfile']['TeamSecurity']['default']['where_condition'] = true;perfProfile.TeamSecurity.gs_use_normalized_teams\nDescriptionDetermines whether the team set IDs are cached; this may improve Elasticsearch indexing performance, especially for those instances with a large number of team sets per user. Admin must schedule re-indexing Elasticsearch server if this value has been changed.TypeBooleanRange of valuestrue and falseVersions11.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['perfProfile']['TeamSecurity']['gs_use_normalized_teams'] = true;perfProfile.TeamSecurity.inline_update\nDescriptionWhen denormalization is in use (perfProfile.TeamSecurity.default.use_denorm config set to true), this setting will allow the denormalization table to be updated in real time as records are updated in the system. If this setting is disabled, the denormalization table must be scheduled by the Sugar administrator via Schedulers > Rebuild Denormalized Team Security Data.TypeBooleanRange of valuestrue and falseVersions8.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['perfProfile']['TeamSecurity']['inline_update'] = true;pmse_settings_default\nDescriptionSettings for troubleshooting and debugging SugarBPMTypeArrayVersions7.6.0.0+ProductsEnterprise, Ultimate, Serve, SellOverride Example$sugar_config['pmse_settings_default'] = array();pmse_settings_default.error_number_of_cycles", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-64", "text": "DescriptionNumber of cycles before triggering an error in SugarBPMTypeString : CyclesVersions7.6.0.0+ProductsEnterprise, Ultimate, Serve, SellDefault Value10Override Example$sugar_config['pmse_settings_default']['error_number_of_cycles'] = 15;pmse_settings_default.error_timeout\nDescriptionTime in seconds of timeout before triggering an error in SugarBPMTypeString : SecondsVersions7.6.0.0+ProductsEnterprise, Ultimate, Serve, SellDefault Value40Override Example$sugar_config['pmse_settings_default']['error_timeout'] = 45;pmse_settings_default.logger_level\nDescriptionThe default logger level for SugarBPMTypeStringRange of valuesemergency, alert, critical, error, warning, notice, info, debugVersions7.6.0.0+ProductsEnterprise, Ultimate, Serve, SellDefault ValuecriticalOverride Example$sugar_config['pmse_settings_default']['logger_level'] = 'emergency';portal_enableSelfSignUp\nDescriptionThis portal configuration option controls whether external portal sign-ups are permitted and is also controlled in the user interface via the \"Allow new users to sign up\" Sugar Portal setting. See the Sugar Portal page in the Administration Guide for details on this setting: https://support.sugarcrm.com/SmartLinks/Administration_Guide/Developer_Tools/Sugar_Portal/hdr_Configure_Portal\nThis option is disabled by default for new instances. Note: Upon upgrade to 11.1.0 or higher from version 11.0.x or lower, the default value will be 'true' for instances that had their portal enabled before upgrade and at least one contact configured for portal.TypeBooleanRange of valuestrue and falseVersions11.1.0+ProductsEnterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['portal_enableSelfSignUp'] = true;processes_auto_save_interval", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-65", "text": "DescriptionDefines the interval (in milliseconds) at which auto-saving of process definitions will occur while using the SugarBPM process designer. A value of 0 will disable auto-saving.TypeInteger : MillisecondsVersions8.3.0+ProductsEnterprise, Ultimate, Serve, SellDefault Value30000Override Example$sugar_config['processes_auto_save_interval'] = 120000processes_auto_validate_on_autosave\nDescriptionDefines whether validation of process definitions will automatically occur when a process definition is auto-saved. To enable this setting, 'processes_auto_save_interval' must be greater than 0.TypeBooleanRange of valuestrue and falseVersions8.3.0+ProductsEnterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['processes_auto_validate_on_autosave'] = falseprocesses_auto_validate_on_import\nDescriptionDetermines whether validation of process definitions will automatically occur immediately after a process definition is imported.TypeBooleanRange of valuestrue and falseVersions8.3.0+ProductsEnterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['processes_auto_validate_on_import'] = falseproxy_visible\nDescriptionDetermines whether the Proxy Settings panel is visible to administrators in Admin > System Settings. Instances running on Sugar's cloud environment will have this setting enforced as false. Instances running on Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue or falseVersions11.3.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueSugarCloud ValuefalseOverride Example$sugar_config['proxy_visible'] = false;push_notification\nDescriptionThe array of configurations related to push notifications.TypeArrayVersions11.0.0+ProductsEnterprise, Ultimate, Serve, SellOverride Example$sugar_config['push_notification'] = array();push_notification.enabled", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-66", "text": "DescriptionFor Sugar instances that are eligible for push notifications, use this setting to turn push notifications on or off. See the Android and iOS User Guides for the requirements to be eligible:\nhttps://support.sugarcrm.com/Documentation/Mobile_Solutions/SugarCRM_Mobile/SugarCRM_Mobile_for_iOS_User_Guide/#Eligible_Sugar_Instances\nhttps://support.sugarcrm.com/Documentation/Mobile_Solutions/SugarCRM_Mobile/SugarCRM_Mobile_for_Android_User_Guide/#Eligible_Sugar_InstancesTypeBooleanRange of valuestrue and falseVersions11.0.0+ProductsEnterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['push_notification']['enabled'] = true;push_notification.service_provider\nDescriptionFor Sugar instances that are eligible for push notifications, this setting specifies the provider. Currently, SugarPush is the only available provider. See the Android and iOS User Guides for the requirements to be eligible:\nhttps://support.sugarcrm.com/Documentation/Mobile_Solutions/SugarCRM_Mobile/SugarCRM_Mobile_for_iOS_User_Guide/#Eligible_Sugar_Instances\nhttps://support.sugarcrm.com/Documentation/Mobile_Solutions/SugarCRM_Mobile/SugarCRM_Mobile_for_Android_User_Guide/#Eligible_Sugar_InstancesTypeStringRange of values'SugarPush'Versions11.0.0+ProductsEnterprise, Ultimate, Serve, SellDefault Value'SugarPush'Override Example$sugar_config['push_notification']['service_provider'] = 'SugarPush';reports_complexity_display\nDescriptionArray that establishes the thresholds for the number of cells in a report above which the formatting changes.TypeArrayRange of valuesPositive integersVersions13.0.0+ProductsEnterprise, Serve, SellOverride Example$sugar_config['reports_complexity_display'] = array();reports_complexity_display.export", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-67", "text": "DescriptionWhen a report has more than this many cells, you will only be able to view results in a table by exporting the table.TypeInteger : Number of cellsRange of valuesAny integer greater than or equal to 1Versions13.0.0+ProductsEnterprise, Serve, SellDefault Value300000Override Example$sugar_config['reports_complexity_display']['export']=30000;reports_complexity_display.simplified\nDescriptionWhen a report has more than this many cells, you will be able to view results as a simplified table or export the results. TypeInteger : Number of cellsRange of valuesAny integer greater than or equal to 1Versions13.0.0+ProductsEnterprise, Serve, SellDefault Value50000Override Example$sugar_config['reports_complexity_display']['simplified']=5000;require_accounts\nDescriptionDetermines whether an account is required for record creation within the system.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['require_accounts'] = false;rest_response_etag_cache_age\nDescriptionControls how long the browser should cache rest responses.TypeInteger : SecondsVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value10Override Example$sugar_config['rest_response_etag_cache_age'] = 15;roleBasedViews\nDescriptionEnables role based views and dropdowns.TypeBooleanRange of valuestrue and falseVersions7.6.0.0+ProductsEnterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['roleBasedViews'] = true;SAML_provisionUser", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-68", "text": "DescriptionDetermines whether or not a new user is auto-provisioned when authenticating through SAML. Setting this setting to false will prevent a new user from being created.TypeBooleanRange of valuestrue and falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['SAML_provisionUser'] = false;SAML_X509Cert\nDescriptionThe SAML Certificate Key.TypeString : SAML Certificate KeyVersions6.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['SAML_X509Cert'] = '-----BEGIN CERTIFICATE-----CERTIFICATE KEY-----END CERTIFICATE-----';schedule_report_with_chart\nDescriptionBy default, reports distributed via the Reports Schedule module in 8.1 and later will not include a chart in the emailed PDF even if one has been configured for display in Sugar. Because the report charts are not re-built when the scheduler runs a scheduled report, the chart may not accurately represent the data presented in the PDF. Instead, the chart will represent the data that was pulled the last time a user triggered a \"Run Report\" action on the report, which may or may not match the data available when the report is generated for the scheduled report. Consider this potential conflict carefully before using this config to override the default behavior.TypeBooleanRange of valuestrue and falseVersions8.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['schedule_report_with_chart'] = true;search_engine\nDescriptionArray that defines the search enginer behaviors.TypeArrayVersions7.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['search_engine'] = array();search_engine.max_bulk_delete_threshold", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-69", "text": "DescriptionThe maximun number of records that can be deleted at a time.TypeInteger : Number of recordsVersions7.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value3000Override Example$sugar_config['search_engine']['max_bulk_delete_threshold'] = 3000;search_engine.max_bulk_query_threshold\nDescriptionThe maximum number of records to process before starting to bulk insert. Prevents memory issues.TypeInteger : Number of recordsVersions7.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value15000Override Example$sugar_config['search_engine']['max_bulk_query_threshold'] = 20000;search_engine.max_bulk_threshold\nDescriptionThe maximum number of records to process before starting to bulk insert. Prevents memory issues.TypeIntegerVersions7.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value5000Override Example$sugar_config['search_engine']['search_engine.max_bulk_threshold'] = 10000;search_engine.postpone_job_time\nDescriptionAmount of time to postpone a job by so that it's not executed twice during the same request.TypeInteger : SecondsVersions7.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value120Override Example$sugar_config['search_engine']['search_engine.postpone_job_time'] = 70;search_wildcard_infront\nDescriptionIn Sugar 7.x+, this setting is only valid for modules running in BWC mode. When enabled, automatically adds a wildcard in front of any searches performed in the application. This setting is not recommended to be enabled as preceding wildcards results in database indices not being utilized and performance decreasing.TypeBooleanRange of valuestrue and falseVersions6.4.3+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['search_wildcard_infront'] = true;security.private_ips", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-70", "text": "DescriptionDefines a range of IPs considered to be private. Such IPs and corresponding domains are not reachable via ExternalResourceClient. Instances running on Sugar's cloud environment will have this setting enforced as ['10.0.0.0|10.255.255.255', '172.16.0.0|172.31.255.255', '192.168.0.0|192.168.255.255', '169.254.0.0|169.254.255.255', '127.0.0.0|127.255.255.255',].TypeArrayRange of valuesPipe-delimited range of IPs (e.g., '10.0.0.0|10.255.255.255')Versions12.1.0+ProductsEnterprise, Serve, SellDefault Value['10.0.0.0|10.255.255.255', '172.16.0.0|172.31.255.255', '192.168.0.0|192.168.255.255', '169.254.0.0|169.254.255.255', '127.0.0.0|127.255.255.255',]SugarCloud Value['10.0.0.0|10.255.255.255', '172.16.0.0|172.31.255.255', '192.168.0.0|192.168.255.255', '169.254.0.0|169.254.255.255', '127.0.0.0|127.255.255.255',]Override Example$sugar_config['security']['private_ips'] = [ '127.0.0.0|127.255.255.255', '8.8.8.0|8.8.8.8', ];security.use_doh", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-71", "text": "DescriptionEnables remote Domain Name System (DNS) resolution via the HTTPS protocol. A goal of the method is to increase user privacy and security by preventing eavesdropping and manipulation of DNS data by man-in-the-middle attacks by using the HTTPS protocol to encrypt the data between the DoH (DNS over HTTPS) client and the DoH-based DNS resolver.\nWhen enabled, it will use dns.google (8.8.4.4) to resolve hostnames. Instances running on Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue and falseVersions13.0.0+ProductsEnterprise, Serve, SellDefault ValuefalseSugarCloud ValuefalseOverride Example$sugar_config['security']['use_doh'] = true;session_dir\nDescriptionDirectory on the server to store Sugar session data. If left empty, the PHP session settings will be inherited. Instances running on Sugar's cloud environment will have this setting enforced as empty.TypeStringRange of valuesDirectory pathVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueemptySugarCloud ValueemptyOverride Example$sugar_config['session_dir'] = '/tmp/SugarSession/';showThemePicker\nDescriptionRemoves the theme selection drop down.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['showThemePicker'] = false;show_download_tab\nDescriptionUsed to determine whether the download tab will appear in the User settings. The download tab provides users with access to Sugar plug-ins and other available downloads.TypeBooleanRange of valuestrue and falseVersions6.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['show_download_tab'] = true;site_url", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-72", "text": "DescriptionCurrent URL of your Sugar instance. This value is critical in its accuracy for multiple points of functionality in the instance.TypeString : URLRange of valuesCurrent URL of SugarVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['site_url'] = 'http://my.sugarinstance.com';slow_query_time_msec\nDescriptionSlow query time threshold. Instances running on Sugar's cloud environment will have this setting enforced as 5000.TypeString : MillisecondsVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value5000SugarCloud Value5000Override Example$sugar_config['slow_query_time_msec'] = '1000';smtp_mailer_debug\nDescriptionThe smtp_mailer_debug is used for increasing the debugging output for PHPMailer on individual instances so that more information can be seen when there are bugs or escalations. The default is 0 and produces no additional output for errors. 1-4 log the additional error information to sugarcrm.log as specified by PHPMailer at https://github.com/PHPMailer/PHPMailer/wiki/SMTP-Debugging#debug-levels .\nTypeIntegerRange of values0, 1, 2, 3, 4Versions7.9.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value0Override Example$sugar_config['smtp_mailer_debug'] = 4;stack_trace_errors\nDescriptionDisplays stack trace of errors. Instances running on Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuefalseOverride Example$sugar_config['stack_trace_errors'] = true;studio_max_history", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-73", "text": "DescriptionWhen layout changes are made in Studio, a history of those changes are recorded with each save & deploy under ./custom/history/modules/. The studio_max_history parameter controls how many files Sugar keeps for a particular module. If this parameter is undefined, a default of 50 is observed and to keep all historical Studio actions, set this parameter to 0. Instances running on Sugar's cloud environment will have this setting enforced as 50.TypeInteger : Number of files to keepRange of valuesAny integerVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value50SugarCloud Value50Override Example$sugar_config['studio_max_history'] = 100;sugar_version\nDescriptionThe current version of Sugar that is being used. This value should not be modified as it is updated in the config when Sugar is upgraded.TypeString : Version NumberVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['sugar_version'] = '6.7.3';symfony_deprecation_log\nDescriptionBy default, the deprecation warnings, triggered by Symfony components, are written to sugarcrm.log in the Sugar root directory. But since the default log level is set to Fatal, the deprecation warning messages will not appear in the log. As an option, you can add the $sugar_config['logger']['channels']['deprecation'] configuration and configure the log level and output method to just capture the deprecation warnings in a separate deprecations.log file.   Instances running on Sugar's cloud environment will have this setting enforced as false.TypeBooleanRange of valuestrue and falseVersions12.2.0+ProductsEnterprise, Ultimate, Serve, SellDefault ValuefalseSugarCloud ValuefalseOverride Example$sugar_config['symfony_deprecation_log'] = true;time_aware_job_max_batch_size", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-74", "text": "DescriptionThe number of records processed per batch by the \"Process Time-Aware Schedules\" job scheduler.  It is important to note that the scheduler job must be enabled.TypeInteger : RecordsVersions10.3.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value100Override Example$sugar_config['time_aware_job_max_batch_size'] = 200;tmp_dir\nDescriptionThe directory path for temporary XML files used by charts and diagnostics.TypeString : Directory pathRange of valuesFilesystem pathVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Valuecache/xml/Override Example$sugar_config['tmp_dir'] = 'cache/xml/';tmp_file_max_lifetime\nDescriptionThe interval in seconds of when to expire and remove temporary upload files. It is important to note that the \"Remove temporary files\" scheduler job must be enabled to remove the temporary files.TypeInteger : SecondsVersions7.6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value86400Override Example$sugar_config['tmp_file_max_lifetime'] = 86400;tracker_max_display_length\nDescriptionThe number of records that will be shown per record in the \"Last Viewed\" section located under each module tab.TypeInteger : Number of recordsVersions6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['tracker_max_display_length'] = 45;tracker_module_config\nDescriptionArray that defines the parameters that control which modules are tracked when Tracker Actions are enabled.TypeArrayVersions11.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['tracker_module_config'] = array();tracker_module_config.disable", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-75", "text": "DescriptionThe list of modules that are ignored by Tracker Actions. If tracker_module_config.enable_only is defined, then tracker_module_config.disable will be ignored. If neither config is defined, then all modules are enabled. By default, neither config is defined and all actions for all modules across all platforms will be enabled when Tracker Actions is enabled.TypeArrayRange of valuesModule keysVersions11.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['tracker_module_config']['disable'] = ['Reports', 'ActivityStream'];tracker_module_config.enable_only\nDescriptionA list of module names for which records are saved in the tracker table when Tracker Actions are enabled; all other modules will be disabled. If tracker_module_config.enable_only is empty or null or undefined, tracker_module_config.disable will apply. If neither config is defined, then all modules are enabled. By default, neither config is defined and all actions for all modules across all platforms will be enabled when Tracker Actions is enabled.\nTypeArrayRange of valuesModule keysVersions11.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['tracker_module_config']['enable_only'] = ['Reports', 'ActivityStream'];uninstallOnError\nDescriptionToggles the switch that uninstalls the package that was just installed if the install ended up with a PHP error.  Instances running on Sugar's cloud environment will have this setting enforced as true.TypeBooleanRange of valuestrue and falseVersions12.0.3+ProductsEnterprise, Ultimate, Serve, SellDefault ValuetrueSugarCloud ValuetrueOverride Example$sugar_config['uninstallOnError'] = false;uninstall_timeout\nDescriptionControls the timeout time in seconds for an uninstall process.TypeInteger : SecondsVersions10.2.1+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value600Override Example$sugar_config['uninstall_timeout'] = 300;unique_key", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-76", "text": "DescriptionSpecifies the unique identifier for the instance. This value is used in features such as PHP caching, FTS indexing, and email archiving. It is extremely important that this string is unique from any other instances deployed even if they are only for development purposes only.TypeString : Unique IdentifierVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['unique_key'] = 'c0b5475f3f5b26ddb2976edc8865b5f6';upload_badext\nDescriptionAn array of extensions that cannot be uploaded in their native file format. Sugar will append a .txt extension to the end of any files with an invalid extension to avoid security issues with running unauthorized scripts on an instance.TypeArrayRange of valuesExtensions that cannot be uploaded as isVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['upload_badext'][] = 'swf';upload_dir\nDescriptionThe directory path where uploaded files are stored for note attachments, documents, and module loadable packages. By default, uploads are stored in the ./upload/ directory. For more information, refer to the Uploads documentation.TypeStringRange of valuesDirectory pathVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Valueupload/Override Example$sugar_config['upload_dir'] = 'upload/'upload_maxsize", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-77", "text": "DescriptionThe maximum individual file size that users can upload to modules that support file uploads. Restricts the upload limit from within Sugar without affecting any other applications that may be running on your server. This limit can be easily adjusted in Sugar via Admin > System Settings but is only useful if it is set to a size smaller than the php.ini limits. For more information, refer to the Uploads documentation.TypeInteger : Filesize in bytesVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['upload_maxsize'] = 40000000;upload_wrapper_class\nDescriptionThe name of the class used as upload wrapper.TypeString : Upload wrapper classVersions6.7.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueUploadStreamOverride Example$sugar_config['upload_wrapper_class'] = 'SugarUploadS3';use_common_ml_dir\nDescriptionA security control that allows you to restrict Module Loader to read modules from a specific directory on the server and disable the ability to upload new modules into the Module Loader. To specify a new directory you will need to populate the config parameter 'common_ml_dir'.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['use_common_ml_dir'] = true;use_php_code_json\nDescriptionDetermines if the environment has a valid version of PHP-JSON. This should be determined by the function returnPhpJsonStatus() and shouldn't be overridden.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['use_php_code_json'] = true;use_real_names", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-78", "text": "DescriptionDisplay users' full names instead of their User Names in assignment fields.TypeBooleanRange of valuestrue and falseVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['use_real_names'] = true;use_sprites\nDescriptionA sprite is a two-dimensional image or animation that is integrated into a larger scene. This parameter is used to disable sprites. This is set to true by default (if you have GD libraries installed).TypeBooleanRange of valuestrue and falseVersions6.4.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['use_sprites'] = false;validation\nDescriptionAn array that defines settings for user input validation behaviors.TypeArrayVersions7.7.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['validation'] = array();validation.compat_mode\nDescriptionDetermines compatibility mode for superglobals in the input validation framework. When enabled, setting, unsetting, and modifying $_GET, $_POST, or $_REQUEST values through PHP code is supported. Using PHP code to manipulate superglobals is discouraged. User input parameters should be considered read-only. As a transition period, this is currently allowed out-of-box, but may change in a future release. It is highly recommended for developers to verify their customizations work with this parameter set to false in preparation for the 7.9 release.TypeBooleanRange of valuestrue and falseVersions7.7.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value7.7.x: true7.8.x: true7.9.x: falseOverride Example$sugar_config['validation']['compat_mode'] = false;validation.soft_fail", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-79", "text": "DescriptionDetermines whether soft failure mode for the input validation framework is enabled. When this mode is enabled, any input validation violations will only be reported as a warning in the sugarcrm.log without having any negative impact on the request. When disabled, violations are reported as fatal in the sugarcrm.log and actual exceptions are being thrown resulting in an HTTP 500 response. \nIt is highly recommended for developers to verify their customizations work with this parameter set to false in preparation for the 8.0 release.TypeBooleanRange of valuestrue and falseVersions7.7.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value7.7.x: true7.8.x: true7.9.x: true8.0.x: falseOverride Example$sugar_config['validation']['soft_fail'] = false;vcal_time\nDescriptionUsed to determine the number of months in advance of the current date that the Free/Busy information for calls and meetings will be published. To turn Free/Busy publishing off, set this variable to '0'. The minimum is 1 month; the maximum is 12 months.TypeString : MonthsRange of values'1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', and '12'Versions5.2.0.c+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value2Override Example$sugar_config['vcal_time'] = '5';verify_client_ip\nDescriptionWhether or not to verify the client IP. Setting this to true will enable the system checking to see if the user is accessing Sugar from the IP address of their last page load.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-80", "text": "Note: This default value must be set to \"false\" in order to use Sugar Connect and Sugar Integrate.TypeBooleanRange of valuestrue and falseVersions10.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['verify_client_ip'] = true;web_logic_hook_timeout\nDescriptionTimeout for requests to web logic hooks. Any requests that run longer than the set limit will fail and trigger an error in the log.TypeInteger : secondsVersions11.1.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value10Override Example$sugar_config['web_logic_hook_timeout'] = 2;wl_list_max_entries_per_page\nDescriptionThe number of records to be shown per page on the listview of the mobile browser.TypeInteger : Number of records to displayVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value10Override Example$sugar_config['wl_list_max_entries_per_page'] = 10;wl_list_max_entries_per_subpanel\nDescriptionDetermines the number of records shown in the subpanels on the DetailView of the mobile browser.TypeInteger : RecordsVersions5.2.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value3Override Example$sugar_config['wl_list_max_entries_per_subpanel'] = 3;xhprof_config\nDescriptionConfiguration settings for xhprof. More information on xhprof can be found at http://pecl.php.net/package/xhprof.TypeArrayVersions6.5.10+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['xhprof_config'] = array();xhprof_config.enable", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-81", "text": "DescriptionEnables the xhprof profiler.TypeBooleanRange of valuestrue and falseVersions6.5.10+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuefalseOverride Example$sugar_config['xhprof_config']['enable'] = true;xhprof_config.filter_wt\nDescriptionThe wall time. Values are specified in milliseconds.TypeInteger : Wall time in millisecondsVersions7.6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value0Override Example$sugar_config['xhprof_config']['filter_wt'] = 2;xhprof_config.flags\nDescriptionThe flags for xhprof profiler.TypeString : xhprof flagsVersions6.5.10+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['xhprof_config']['flags'] = XHPROF_FLAGS_CPU + XHPROF_FLAGS_MEMORY;xhprof_config.ignored_functions\nDescriptionAn array of function names to ignore from the profile.TypeArray : Function namesVersions6.5.10+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['xhprof_config']['ignored_functions'] = array(\"function_name\");xhprof_config.log_to\nDescriptionThe path to log the xhprof profiler output to.TypeString : Directory pathVersions6.5.10+ProductsProfessional, Enterprise, Ultimate, Serve, SellOverride Example$sugar_config['xhprof_config']['log_to'] = '{instance server path}/cache/xhprof';xhprof_config.manager\nDescriptionThe xhprof manager class to use. Prior to 7.7, specifying values xhprof_config.save_to, xhprof_config.mongodb_uri, xhprof_config.mongodb_db, xhprof_config.mongodb_collection, xhprof_config.mongodb_options, and", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-82", "text": "xhprof_config.filter_wt will need to have set xhprof_config.manager set to 'SugarXHprofPerformance'. As of 7.7, setting xhprof_config.manager is not longer required. \nIf you want to customize SugarXHprof, you can create the folder ./custom/include/SugarXHprof/ and create a file with your custom class class name. The custom class will need to extend SugarXHprof. If a custom class doesn't exist or hasn't been specified, SugarXHprof will be used.TypeString : ClassVersions6.5.10+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueSugarXHprofOverride Example$sugar_config['xhprof_config']['manager'] = 'CustomSugarXHprof';xhprof_config.memory_limit\nDescriptionThe memory limit to set while saving profile data to storage.TypeString : Memory UsageVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value2048MOverride Example$sugar_config['xhprof_config']['memory_limit'] = '1024M';xhprof_config.mongodb_collection\nDescriptionThe name of the mongo db collections.TypeString : Mongo collection nameVersions7.6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueresultsOverride Example$sugar_config['xhprof_config']['mongodb_db'] = 'results_new';xhprof_config.mongodb_db\nDescriptionThe name of the mongo database.TypeString : Database nameVersions7.6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuexhprofOverride Example$sugar_config['xhprof_config']['mongodb_db'] = 'xhprof2';xhprof_config.mongodb_options", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-83", "text": "DescriptionOptions for mongo db connection. The list of construct options can be found at: http://php.net/manual/en/mongoclient.construct.php#mongo.mongoclient.construct.parametersTypeArray : Mongo db optionsVersions7.6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValueresultsOverride Example$sugar_config['xhprof_config']['mongodb_options'] = array();xhprof_config.mongodb_uri\nDescriptionThe mongo server URL.TypeString : URLVersions7.6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Valuemongodb://localhost:27017Override Example$sugar_config['xhprof_config']['mongodb_uri'] = 'mongodb://localhost:27018';xhprof_config.sample_rate\nDescriptionThe sample rate of the xhprof profiler. 1/{specified value} requests are profiled. To sample all requests, set this value to 1.TypeInteger : Sample Rate (1/{value})Versions6.5.10+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault Value10Override Example$sugar_config['xhprof_config']['sample_rate'] = 1;xhprof_config.save_to\nDescriptionThe place to save xhprof data. If set to 'mongodb', the data is stored in the mongo database.TypeString : Save LocationRange of values'file' and 'mongodb'Versions7.6.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuemongodbOverride Example$sugar_config['xhprof_config']['save_to'] = 'mongodb';xhprof_config.track_elastic", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "b191d6b5f35c-84", "text": "DescriptionWhether or not to track elastic data.TypeBooleanRange of valuestrue or falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['xhprof_config']['track_elastic'] = false;xhprof_config.track_elastic_backtrace\nDescriptionWhether or not to store the elastic backtrace data.TypeBooleanRange of valuestrue or falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['xhprof_config']['track_elastic_backtrace'] = false;xhprof_config.track_sql\nDescriptionWhether or not to track SQL queries.TypeBooleanRange of valuestrue or falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['xhprof_config']['track_sql'] = false;xhprof_config.track_sql_backtrace\nDescriptionWhether or not to store the SQL backtrace data.TypeBooleanRange of valuestrue or falseVersions7.7.0.0+ProductsProfessional, Enterprise, Ultimate, Serve, SellDefault ValuetrueOverride Example$sugar_config['xhprof_config']['track_sql_backtrace'] = false;\n  \tLast modified: 2023-05-25 16:37:57", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Configurator/Core_Settings/index.html"}
{"id": "c4d92fa83f81-0", "text": "Validation Constraints\nOverview\nThis article will cover how to add validation constraints to\u00c2\u00a0your custom\u00c2\u00a0code.\nConstraints\nValidation constraints\u00c2\u00a0allow developers to validate user input\nSymfony Validation Constraints\nThe\u00c2\u00a0Symfony's Validation library, located in ./vendor/symfony/validator/,\u00c2\u00a0contains many open source constraints. You can find the full list of constraints documented in Symphony's\u00c2\u00a0Validation Constraints. They are listed below for your reference.\nBasic Constraints\nNotBlank\nBlank\nNotNull\nIsNull\nIsTrue\nIsFalse\nType\nString Constraints\nEmail\nLength\nUrl\nRegex\nIp\nUuid\nNumber Constraints\nRange\nComparison Constraints\nEqualTo\nNotEqualTo\nIdenticalTo\nNotIdenticalTo\nLessThan\nLessThanOrEqual\nGreaterThan\nGreaterThanOrEqual\nDate Constraints\nDate\nDateTime\nTime\nCollection Constraints\nChoice\nCollection\nCount\nUniqueEntity\nLanguage\nLocale\nCountry\nFile Constraints\nFile\nImage\nFinancial and other Number Constraints\nBic\nCardScheme\nCurrency\nLuhn\nIban\nIsbn\nIssn\nOther Constraints\nCallback\nExpression\nAll\nUserPassword\nValid\nSugar Constraints\nSugar contains\u00c2\u00a0its own\u00c2\u00a0set of\u00c2\u00a0validation constraints. These constraints extend\u00c2\u00a0from Symfony's validation constraints\u00c2\u00a0and are located in ./src/Security/Validator/Constraints of\u00c2\u00a0your Sugar installation.\nBean/ModuleName\nBean/ModuleNameValidator\nComponentName\nComponentNameValidator\nDelimited\nDelimitedValidator\nDropdownList\nDropdownListValidator\nFile\nFileValidator\nGuid\nGuidValidator\nInputParameters\nInputParametersValidator\nJSON\nJSONValidator\nLanguage\nLanguageValidator\nLegacyCleanString\nLegacyCleanStringValidator\nMvc/ModuleName\nMvc/ModuleNameValidator\nPhpSerialized\nPhpSerializedValidator\nSql/OrderBy\nSql/OrderByValidator\nSql/OrderDirection\nSql/OrderDirectionValidator\nSugarLogic/FunctionName\nSugarLogic/FunctionNameValidator", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Validation_Constraints/index.html"}
{"id": "c4d92fa83f81-1", "text": "Sql/OrderDirectionValidator\nSugarLogic/FunctionName\nSugarLogic/FunctionNameValidator\nCustom Constraints\nIf you find that the existing constraints do not meet your needs,\u00c2\u00a0you can also create your own. These constraints exist under\u00c2\u00a0./custom/src/Security/Validator/Constraints/.\u00c2\u00a0The following section will outline the details.\u00c2\u00a0The example below will demonstrate how to create a phone number validation constraint.\u00c2\u00a0\nThe constraint file will contain your validations error message.\n./custom/src/Security/Validator/Constraints/Phone.php\n<?php\nnamespace Sugarcrm\\Sugarcrm\\custom\\Security\\Validator\\Constraints;\nuse Symfony\\Component\\Validator\\Constraint;\n/**\n *\n * @see PhoneValidator\n *\n */\nclass Phone extends Constraint \n{\n    public $message = 'Phone number violation: %msg%';\n}\nThe validator file will contain the logic to determine whether the value meets the requirements.\n./custom/src/Security/Validator/Constraints/PhoneValidator.php\n<?php\nnamespace Sugarcrm\\Sugarcrm\\custom\\Security\\Validator\\Constraints;\nuse Symfony\\Component\\Validator\\Constraint;\nuse Symfony\\Component\\Validator\\ConstraintValidator;\nuse Symfony\\Component\\Validator\\Exception\\UnexpectedTypeException;\n/**\n *\n * Phone validator\n *\n */\nclass PhoneValidator extends ConstraintValidator\n{\n    /*\n     * Phone Pattern Examples;\n     * +1 12 3456789\n     * +1.12.3456789\n     */\n    const PHONE_PATTERN = '/^([+]?\\d+(?:[ \\.]\\d+)*)$/';\n    /**\n     * {@inheritdoc}\n     */\n    public function validate($value, Constraint $constraint)\n    {\n        if (!$constraint instanceof Phone) {\n            throw new UnexpectedTypeException($constraint, __NAMESPACE__ . '\\Phone');\n        }", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Validation_Constraints/index.html"}
{"id": "c4d92fa83f81-2", "text": "throw new UnexpectedTypeException($constraint, __NAMESPACE__ . '\\Phone');\n        }\n        if (null === $value || '' === $value) {\n            return;\n        }\n        if (!is_scalar($value) && !(is_object($value) && method_exists($value, '__toString'))) {\n            throw new UnexpectedTypeException($value, 'string');\n        }\n        $value = (string) $value;\n        // check for allowed characters\n        if (!preg_match(self::PHONE_PATTERN, $value)) {\n            $this->context->buildViolation($constraint->message)\n                ->setParameter('%msg%', 'invalid format')\n                ->setInvalidValue($value)\n                ->addViolation();\n            return;\n        }\n    }\n}\nOnce the files are in place,\u00c2\u00a0navigate to Admin > Repairs and run a Quick Repair and Rebuild. Once completed, your constraint will be ready for use.\nUsing Constraints in API End Points\nIn this section, we will create a custom endpoint and trigger\u00c2\u00a0the custom phone constraint we created above.\u00c2\u00a0The\u00c2\u00a0code below will create a\u00c2\u00a0REST\u00c2\u00a0API endpoint path of\u00c2\u00a0/phoneCheck:\n./custom/clients/base/api/MyEndpointsApi.php\n<?php\nif (!defined('sugarEntry') || !sugarEntry) {\n    die('Not A Valid Entry Point');\n}\nuse Sugarcrm\\Sugarcrm\\Security\\Validator\\ConstraintBuilder;\nuse Sugarcrm\\Sugarcrm\\Security\\Validator\\Validator;\nclass MyEndpointsApi extends SugarApi\n{\n    public function registerApiRest()\n    {\n        return array(\n            //POST\n            'MyEndpointsApi' => array(\n                //request type\n                'reqType' => 'POST',\n                //endpoint path\n                'path' => array('phoneCheck'),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Validation_Constraints/index.html"}
{"id": "c4d92fa83f81-3", "text": "//endpoint path\n                'path' => array('phoneCheck'),\n                //endpoint variables\n                'pathVars' => array(''),\n                //method to call\n                'method' => 'phoneCheck',                //minimum api version                'minVersion' => 10,\n                //short help string to be displayed in the help documentation\n                'shortHelp' => 'An example of a POST endpoint to validate phone numbers',\n                //long help to be displayed in the help documentation\n                'longHelp' => 'custom/clients/base/api/help/MyEndPoint_phoneCheck_help.html',\n            ),\n        );\n    }\n    /**\n     * Method to be used for my MyEndpointsApi/phoneCheck endpoint\n     */\n    public function phoneCheck($api, $args)\n    {\n        $validator = Validator::getService();\n        /**\n         * Validating Phone Number\n         */\n        $phoneContraintBuilder = new ConstraintBuilder();\n        $phoneConstraints = $phoneContraintBuilder->build(\n            array(\n                'Assert\\Phone',\n            )\n        );\n        $errors = $validator->validate($args['phone'], $phoneConstraints);\n        if (count($errors) > 0) {\n            /*\n             * Uses a __toString method on the $errors variable which is a\n             * ConstraintViolationList object. This gives us a nice string\n             * for debugging.\n             */\n            $errorsString = (string) $errors;\n            // include/api/SugarApiException.php\n            throw new SugarApiExceptionInvalidParameter($errorsString);\n        }\n        //custom logic\n        return $args;\n    }\n}\nAfter creating the endpoint, navigate to Admin > Repairs and run a Quick Repair and Rebuild. The API will then be ready to use.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Validation_Constraints/index.html"}
{"id": "c4d92fa83f81-4", "text": "Valid Payload - POST to /phoneCheck\nThe example below demonstrates a valid phone number post the /phoneCheck\u00c2\u00a0endpoint.\n{    phone: \"+1.23.456.789\"}\nResult\n{    phone: \"+1.23.456.789\"}\nInvalid Payload - POST to /phoneCheck\nThe example below demonstrates an invalid phone number post the\u00c2\u00a0/phoneCheck\u00c2\u00a0endpoint.\n{    phone: \"Invalid+1.23.456.789\"}\nResult\n{    \"error\":\"invalid_parameter\",    \"error_message\":\"Invalid+1.23.456.789:\\n    Phone number violation: invalid format\\n\"}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Validation_Constraints/index.html"}
{"id": "52fdaae5e07c-0", "text": "Sugar Logic\nOverview\nSugar Logic, a feature in all Sugar products, enables custom business logic that is easy to create, manage, and reuse on both the server and client.\nSugar Logic is made up of multiple components that build on each other and is extensible at every step. The base component is the Sugar Formula Engine, which parses and evaluates human-readable formulas. Dependencies are units made up of triggers and actions that can express custom business logic. Each dependency defines a list of actions to be performed depending on the outcome of a trigger formula.\nTerminology\nFormula : An expression that conforms to the Formula Engine syntax, consisting of nested functions and field variables\nFunction : A method that can be called in a formula\nTrigger : A formula that evaluates to either true or false when a field in the equation is updated or when a record is retrieved/saved\nAction : A method that modifies the current record or layout in some way\nDependency : A complete logical unit that includes a trigger and one or more actions\nSugar Formula Engine\nFormulas\nThe fundamental object is called a formula. A formula can be evaluated for a given record using the Sugar Logic parser.\nSome example formulas are:\nBasic addition:\nadd(1, 2)\nBoolean values:\nnot(equal($billing_state, \"CA\"))\nCalculation:\nmultiply(number($employees), $seat_cost, 0.0833)\nTypes\nSugar Logic has several fundamental types: number, string, boolean, and enum (lists). Functions may take in any of these types or combinations thereof and return as output one of these types. Fields may also often have their value set to only a certain type.\nNumber Type\nNumber types essentially represent any real number (which includes positive, negative, and decimal numbers). They can be plainly typed as input to any function. For example, the operation (10 + 10 + (15 - 5)) can be performed as follows:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/index.html"}
{"id": "52fdaae5e07c-1", "text": "add(10, 10, subtract(15, 5))\nString Type\nA string type is very much like a string in most programming languages. However, it can only be declared within double quotes. For example, consider this function, which returns the length of the input string:\nstrlen(\"Hello World\")\nThe function would appropriately return the value 11.\nBoolean Type\nA boolean type is simple. It can be one of two values: \"true\" or \"false\". This type mainly acts as a flag that indicates whether a condition has been met or not. For example, this function contains takes two strings as input and returns \"true\" if the first string contains the second string, or \"false\" otherwise:\nand(contains(\"Hello World\", \"llo Wo\"), true)\nThe function would appropriately return the value \"true\".\nEnum Type (list)\nAn enum type is a collection of items. The items do not need to all be of the same type, they can be varied. An enum can be declared using the enum function as follows:\nenum(\"hello world!\", false, add(10, 15))\nAlternatively, the createList() function (an alias to enum) can be used to create enums in a formula.\ncreateList(\"hello world!\", false, add(10, 15))\nThis function would appropriately return an enum type containing \"hello world!\", false, and 25 as its elements.\nLink Type (relationship)\nA link represents one side of a relationship and is used to access related records. For example, the accounts link field of Contacts is used to access the account_type field of the account related to a contact:\nrelated($accounts, \"account_type\")\nFor most of the out-of-the-box relationships, links are named with the name of the related module, in lower case.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/index.html"}
{"id": "52fdaae5e07c-2", "text": "Follow these steps to find the name of the link fields for relationships that do not follow the convention above:\nOpen the vardef file for the module you are working on: ./cache/modules/{module}/{module}vardefs.php\nFind the link field that matches the relationship you are looking for.\nFunctions\nFunctions are methods to be used in formulas. Each function has a function name, a parameter count, a parameter type requirement, and returns a value. Some functions such as add() can take any number of parameters. For example: add(1), add(1, 2), and add(1, 2, 3) are all valid formulas. Functions are designed to produce the same result whether executed on the server or client.\nTriggers\nA trigger is an object that listens for changes in field values and, after a change occurs, triggers the associated actions in a dependency.\nActions\nActions are functions that\u00c2\u00a0modify a target in some way and are fired when the trigger is TRUE. Most Actions require at least two parameters: a target and a formula. For example, a style action will change the style of a field based on a passed-in string formula. A value action will update a value of a field by evaluating a passed in formula.\nnotActions\nnotActions are functions that\u00c2\u00a0modify a target in some way and are fired when the trigger is FALSE. notActions are optional and if they are not defined then nothing will fire when the trigger is FALSE.\u00c2\u00a0 Most notActions require at least two parameters: a target and a formula. For example, a style action will change the style of a field based on a passed-in string formula. A value action will update a value of a field by evaluating a passed in formula.\nDependencies", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/index.html"}
{"id": "52fdaae5e07c-3", "text": "Dependencies\nA Dependency describes a set of rules based on a trigger and a set of actions. Examples include a field whose properties must be updated dynamically or a panel which must be hidden when a drop down value is not selected. When a Dependency is triggered it will appropriately carry out the action it is designed to. A basic Dependency is when a field's value is dependent on the result of evaluating a Expression. For example, consider a page with five fields with It's \"a\", \"b\", \"c\", \"d\", and \"sum\". A generic Dependency can be created between \"sum\" and the other four fields by using an Expression that links them together, in this case an add Expression. So we can define the Expression in this manner: 'add($a, $b, $c, $d)' where each field id is prefixed with a dollar ($) sign so that the value of the field is dynamically replaced at the time of the execution of the Expression.\nAn example of a more customized Dependency is when the field's style must be somehow updated to a certain value. For example, the DIV with id \"temp\" must be colored blue. In this case we need to change the background-color property of \"temp\". So we define a StyleAction in this case and pass it the field id and the style change that needs to be performed and when the StyleAction is triggered, it will change the style of the object as we have specified.\nSugar Logic Based Features\nCalculated Fields\nFields with calculated values can now be created from within Studio and Module Builder. The values are calculated based on Sugar Logic formulas. These formulas are used to create a new dependency that are executed on the client side in edit views and the server side on save. The formulas are saved in the varies or vardef extensions and can be created and edited directly. For example, the metadata for a simple calculated commission field in opportunities might look like:\n'commission_c' => array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/index.html"}
{"id": "52fdaae5e07c-4", "text": "'commission_c' => array(\n    'name' => 'commission_c',\n    'type' => 'currency',\n    'calculated' => true,\n    'formula' => 'multiply($amount, 0.1)',\n    //enforced causes the field to appear read-only on the layout\n    'enforced' => true\n),\nDependent fields\nA dependent field will only appear on a layout when the associated formula evaluates to the Boolean value true. Currently these cannot be created through Studio and must be enabled manually with a custom vardef or vardef extension. The \"dependency\" property contains the expression that defines when this field should be visible. An example field that only appears when an account has an annual revenue greater than one million.\n'dep_field'=> array(\n    'name' => 'dep_field',\n    'type' => 'varchar',\n    'dependency' => 'greaterThan($annual_revenue, 1000000)',\n),\nDependent dropdowns\nDependent dropdowns are dropdowns for which options change when the selected value in a trigger dropdown changes. The metadata is defined in the vardefs and contains two major components, a \"trigger\" id which is the name of the trigger dropdown field and a 'visibility grid' that defines the set of options available for each key in the trigger dropdown. For example, you could define a sub-industry field in accounts whose available values depend on the industry field.\n'sub_industry_c' => array(\n    'name' => 'sub_industry_c',\n    'type' => 'enum',\n    'options' => 'sub_industry_dom',\n    'visibility_grid'=> array(\n        'trigger' => 'industry',\n        'values' => array(\n            'Education' => array(\n                'primary', \n                'secondary', \n                'college'\n            ),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/index.html"}
{"id": "52fdaae5e07c-5", "text": "'primary', \n                'secondary', \n                'college'\n            ),\n            'Engineering' => array(\n                'mechanical', \n                'electrical', \n                'software'\n            ),\n        ),\n    ),\n),\nClearing the Sugar Logic Cache\nThe ./updatecache.php script traverses the Expression directory for every file that ends with \"Expression.php\" (ignoring a small list of excepted files) and constructs both a PHP and a JavaScript functions cache file which resides in ./cache/Expressions/functions_cache.js and ./cache/Expressions/functionmap.php. If you create your custom expressions, you will need to rebuild the sugar logic functions by navigating to:\nAdmin > Repair > Rebuild Sugar Logic Functions\nTopicsDependency ActionsThe following sections outline the available SugarLogic dependency actions.Extending Sugar LogicHow to write custom Sugar Logic functions.Using Sugar Logic DirectlyHow to use Sugar Logic\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/index.html"}
{"id": "d5f594202e9a-0", "text": "Dependency Actions\nOverview\nThe following sections outline the available SugarLogic dependency actions.\nDependency Parameters\nDependency definitions will generally contain\u00c2\u00a0most, if not all, of the parameters displayed in the table below. The following sections will outline each dependency\u00c2\u00a0action as well as dependency specific parameters.\nParameter\nType\nDescription\nhooks\n\u00c2\u00a0Array\n\u00c2\u00a0The views to execute the trigger on. Possible values are:\u00c2\u00a0\"edit\", \"view\", \"save\" and \"all\". \u00c2\u00a0 If you include 'save' or\u00c2\u00a0'all' then SugarCRM will try to save the calculated value to the database. \u00c2\u00a0So if your dependency is display only then\u00c2\u00a0only include the views that it will show up on.\ntrigger\n\u00c2\u00a0String\n\u00c2\u00a0Optional. The trigger for the dependency. Defaults to 'true'.\ntriggerFields\n\u00c2\u00a0Array\n\u00c2\u00a0The list of fields to watch for change events. When changed, the trigger expressions will be recalculated.\nonload\n\u00c2\u00a0Boolean\n\u00c2\u00a0Whether or not to trigger the dependencies when the page is loaded.\nactions\n\u00c2\u00a0Array\n\u00c2\u00a0The list of dependencies to execute when the trigger expression is true.\nnotActions\n\u00c2\u00a0Array\n\u00c2\u00a0The list of dependencies to execute when the trigger expression is false.\n\u00c2", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Dependency_Actions/index.html"}
{"id": "d5f594202e9a-1", "text": "\u00c2\u00a0The list of dependencies to execute when the trigger expression is false.\n\u00c2\u00a0\nTopicsReadOnlyThe SugarLogic ReadOnly action, located in ./include/Expressions/Actions/ReadOnlyAction.php, is used to determine if a field is editable or not based on a formula.SetOptionsThe SugarLogic SetOptions action, located in ./include/Expressions/Actions/SetOptionsAction.php, is used to set the options list of a dropdown field based on a formula.SetPanelVisibilityThe SugarLogic SetPanelVisibility action, defined in ./include/Expressions/Actions/PanelVisibilityAction.php, is used to determine the visibility of a record view panel based on a formula.SetRequiredThe SugarLogic SetRequired action, located in ./include/Expressions/Actions/SetRequiredAction.php, is used to determine if a field is required.SetValueThe SugarLogic SetValue action, located in ./include/Expressions/Actions/SetValueAction.php, is used to set the value of a field based on a formula.SetVisibilityThe SugarLogic SetVisibility action, located in ./include/Expressions/Actions/VisibilityAction.php , is used to determine the visibility logic of a field based on a formula.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Dependency_Actions/index.html"}
{"id": "1e62e6705f0d-0", "text": "SetValue\nOverview\nThe SugarLogic\u00c2\u00a0SetValue action, located in ./include/Expressions/Actions/SetValueAction.php, is used to set the value of a field based on a formula.\nImplementation\nWhile the dependency metadata for your module can be defined in\u00c2\u00a0./modules/<module>/metadata/dependencydefs.php and \u00c2\u00a0./custom/modules/<module>/metadata/dependencydef.php, it is recommended to use the extension framework when customizing stock modules to prevent third party\u00c2\u00a0plugins from conflicting with your customizations. The following section\u00c2\u00a0will demonstrate how to implement a read-only dependency.\nSetValue Parameters\nParameter\nType\nDescription\ntarget\nString\nThe name of the field to target for visibility.\nvalue\nString\nSugarLogic formula used to get the value for the target field.\nFor more information on the various parameters in the dependency definitions, please refer to the dependency actions documentation.\nExamples\nThe follow sections outline the various ways this dependency can be implemented.\nDependency Extensions\nFor our example, we will create a dependency on the Leads module that will display the number of activities related to a Lead. \u00c2\u00a0Activities are composed of calls, meetings, tasks, notes, and emails.\u00c2\u00a0An\u00c2\u00a0example extension definition is shown below:\n./custom/Extension/modules/<module>/Ext/Dependencies/custom_phone_alternate.php\n<?php\n$dependencies['Leads']['activity_count_dep'] = array(\n    'hooks' => array(\"edit\", \"view\"), //not including save so that the value isn't stored in the DB\n    'trigger' => 'true', //Optional, the trigger for the dependency. Defaults to 'true'.\n    'onload' => true, //Whether or not to trigger the dependencies when the page is loaded\n    'actions' => array(\n        array(\n            'name' => 'SetValue',\n            'params' => array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Dependency_Actions/SetValue/index.html"}
{"id": "1e62e6705f0d-1", "text": "'name' => 'SetValue',\n            'params' => array(\n                'target' => 'activity_count_c',\n                'value' => 'add(\n                    count($notes),\n                    count($calls),\n                    count($emails),\n                    count($meetings),\n                    count($tasks)\n                )'\n            )\n        )\n    )\n);\nOnce you have\u00c2\u00a0the file in place, you will need to navigate to Admin > Repairs > and\u00c2\u00a0run\u00c2\u00a0a Quick Repair and Rebuild.\nNote: It is important that the module name is plural ('Cases' vs. 'Case') and that the name of the dependency, \"activity_count_dep\" in this example,\u00c2\u00a0is\u00c2\u00a0unique.\nChaining Dependencies\nYou can also add as many actions as you need to the array.\u00c2\u00a0In the example below, we want to display our count value but prevent users from being able to edit the value.\u00c2\u00a0An\u00c2\u00a0example extension definition is shown below:\n<?php\n$dependencies['Leads']['number_of_cases_dep'] = array(\n    'hooks' => array(\"edit\", \"view\"), //not including save so that the value isn't stored in the DB\n    'trigger' => 'true', //Optional, the trigger for the dependency. Defaults to 'true'.\n    //'triggerFields' => array('status'), //unneeded for this example as its not field triggered\n    'onload' => true,\n    'actions' => array(\n        array(\n            'name' => 'SetValue',\n            'params' => array(\n                'target' => 'activity_count_c',\n                'value' => 'add(\n                    count($notes),\n                    count($calls),\n                    count($emails),\n                    count($meetings),\n                    count($tasks)", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Dependency_Actions/SetValue/index.html"}
{"id": "1e62e6705f0d-2", "text": "count($emails),\n                    count($meetings),\n                    count($tasks)\n                )'\n            )\n        ),\n        array(\n            'name' => 'ReadOnly',\n            'params' => array(\n                'target' => 'activity_count_c',\n                'value' => 'true',  //Set to true instead of a formula because its always read-only\n            ),\n        )\n    )\n);\nOnce you have\u00c2\u00a0the file in place, you will need to navigate to Admin > Repairs > and\u00c2\u00a0run\u00c2\u00a0a Quick Repair and Rebuild.\nNote: It is important that the module name is plural ('Cases' vs. 'Case') and that the name of the dependency, \"number_of_cases_dep\" in this example,\u00c2\u00a0is\u00c2\u00a0unique.\nDependencies in Field Definitions\nUnlike several of the other dependencies, SetValue is built into Studio.\u00c2\u00a0 So this dependency can be set as a custom vardef value or in the vardefs file of a\u00c2\u00a0custom module.\u00c2\u00a0 If you wanted to add this dependency to an existing field then you can create a vardef extension\u00c2\u00a0such as\u00c2\u00a0./custom/Extension/modules/<module>/Ext/Vardefs/.\u00c2\u00a0An\u00c2\u00a0example extension definition is shown below:\n./custom/Extension/modules/Accounts/Ext/Vardefs/activity_count_c.php\n<?php\n$dictionary['Lead']['fields']['activity_count_c']['options'] = 'numeric_range_search_dom';\n$dictionary['Lead']['fields']['activity_count_2_c']['calculated'] = 'true';\n$dictionary['Lead']['fields']['activity_count_2_c']['formula'] = 'add(\n    count($calls),\n    count($emails),\n    count($meetings),\n    count($notes),\n    count($tasks)\n)';", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Dependency_Actions/SetValue/index.html"}
{"id": "1e62e6705f0d-3", "text": "count($notes),\n    count($tasks)\n)';\n$dictionary['Lead']['fields']['activity_count_2_c']['enforced'] = 'true';\n$dictionary['Lead']['fields']['activity_count_2_c']['enable_range_search'] = '1';\nOnce you have\u00c2\u00a0the file in place, you will need to navigate to Admin > Repairs > and\u00c2\u00a0run\u00c2\u00a0a Quick Repair and Rebuild.\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Dependency_Actions/SetValue/index.html"}
{"id": "e87c2fec07a6-0", "text": "ReadOnly\nOverview\nThe SugarLogic \u00c2\u00a0ReadOnly\u00c2\u00a0action, located in ./include/Expressions/Actions/ReadOnlyAction.php, is used to determine\u00c2\u00a0if a field is editable or not based on a formula.\nImplementation\nWhile the dependency metadata for your module can be defined in\u00c2\u00a0./modules/<module>/metadata/dependencydefs.php and \u00c2\u00a0./custom/modules/<module>/metadata/dependencydef.php, it is recommended to use the extension framework when customizing stock modules to prevent third-party\u00c2\u00a0plugins from conflicting with your customizations. The following section\u00c2\u00a0will demonstrate how to implement a read-only dependency.\nReadOnly Parameters\nParameter\nType\nDescription\ntarget\nString\nThe name of the field to make read only.\nvalue\nString\nThis parameter can accept a boolean formula or\u00c2\u00a0true\u00c2\u00a0and\u00c2\u00a0false\u00c2\u00a0values.\u00c2\u00a0 Normally you would put aSugarLogic formula here to set the boolean.\nFor more information on the various parameters in the\u00c2\u00a0dependency definitions, please refer to the dependency actions\u00c2\u00a0documentation.\nExample\nFor our example, we will create a dependency on the Accounts module that makes the name field read-only\u00c2\u00a0when the lock_record_c field has been checked.\u00c2\u00a0The first step is to create the\u00c2\u00a0\u00c2\u00a0lock_record_c\u00c2\u00a0checkbox field in Studio and add it to your Record View layout. When this checkbox is checked, we will make the name field read-only. Our example extension definition is shown below:\u00c2\u00a0\n./custom/Extension/modules/<module>/Ext/Dependencies/custom_name_read_only.php\n<?php\n$dependencies['Accounts']['readonly_fields'] = array(\n    'hooks' => array(\"edit\"),\n    'trigger' => 'true',\n    //Optional, the trigger for the dependency. Defaults to 'true'.\n    'triggerFields' => array('lock_record_c'),\n    'onload' => true,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Dependency_Actions/ReadOnly/index.html"}
{"id": "e87c2fec07a6-1", "text": "'onload' => true,\n    //Actions is a list of actions to fire when the trigger is true\n    // You could list multiple fields here each in their own array under 'actions'\n    'actions' => array(\n        array(\n            'name' => 'ReadOnly',\n            //The parameters passed in will depend on the action type set in 'name'\n            'params' => array(\n                'target' => 'name',\n                'value' => 'equal($lock_record_c,true)',\n            ),\n        ),\n    ),\n);\nOnce you have all the files in place you will need to navigate to Admin > Repairs > and\u00c2\u00a0run\u00c2\u00a0a Quick Repair and Rebuild.\nNote: It is important that the module name is plural ('Accounts' vs. 'Account') and that the name of the dependency, \"readonly_fields\" in this example,\u00c2\u00a0is\u00c2\u00a0unique.\nConsiderations\nIn some scenarios, you may want a specific field to always be read-only. To accomplish this, you can modify the\u00c2\u00a0'value'\u00c2\u00a0attribute to always be \"true\". Given the above example, you would\u00c2\u00a0modify:\n'value' => 'equal($lock_record_c,true)',  \nto be:\n'value' => 'true',   \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Dependency_Actions/ReadOnly/index.html"}
{"id": "add168159293-0", "text": "SetRequired\nOverview\nThe SugarLogic SetRequired action, located in ./include/Expressions/Actions/SetRequiredAction.php, is used to determine\u00c2\u00a0if a field is required.\u00c2\u00a0\nImplementation\nWhile the dependency metadata for your module can be defined in\u00c2\u00a0./modules/<module>/metadata/dependencydefs.php and \u00c2\u00a0./custom/modules/<module>/metadata/dependencydef.php, it is recommended to use the extension framework when customizing stock modules to prevent third-party\u00c2\u00a0plugins from conflicting with your customizations. The following section\u00c2\u00a0will demonstrate how to implement a read-only dependency.\nSetRequired Parameters\nParameter\nType\nDescription\ntarget\nString\nThe name of the field to make required.\nlabel\nString\nid of label element for this field\nvalue\nString\nFormula used to determine if the field should be required.\nFor more information on the various parameters in the dependency definitions, please refer to the dependency actions documentation.\nExample\nFor our example, we will create a dependency on the Cases module that will mark the resolution field as required when the status field is set to \"Closed\".\u00c2\u00a0Our example extension definition is shown below:\n./custom/Extension/modules/<module>/Ext/Dependencies/required_resolution_dep.php\n<?php\n$dependencies['Cases']['required_resolution_dep'] = array(\n    'hooks' => array(\"edit\"),\n    'trigger' => 'true',\n    'triggerFields' => array('status'),\n    'onload' => true,\n    //Actions is a list of actions to fire when the trigger is true\n    'actions' => array(\n        array(\n            'name' => 'SetRequired',\n            //The parameters passed in will depend on the action type set in 'name'\n            'params' => array(\n                'target' => 'resolution',\n                'label' => 'resolution_label',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Dependency_Actions/SetRequired/index.html"}
{"id": "add168159293-1", "text": "'target' => 'resolution',\n                'label' => 'resolution_label',\n                'value' => 'equal($status, \"Closed\")',\n            ),\n        ),\n    ),\n);\nOnce you have\u00c2\u00a0the file in place, you will need to navigate to Admin > Repairs > and\u00c2\u00a0run\u00c2\u00a0a Quick Repair and Rebuild.\nNote: It is important that the module name is plural ('Cases' vs. 'Case') and that the name of the dependency, \"required_resolution_dep\" in this example,\u00c2\u00a0is\u00c2\u00a0unique.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Dependency_Actions/SetRequired/index.html"}
{"id": "56ffbe1f1dba-0", "text": "SetOptions\nOverview\nThe SugarLogic\u00c2\u00a0SetOptions action, located in ./include/Expressions/Actions/SetOptionsAction.php, is used to set the options list of a dropdown field based on a formula.\nImplementation\nWhile the dependency metadata for your module can be defined in\u00c2\u00a0./modules/<module>/metadata/dependencydefs.php and \u00c2\u00a0./custom/modules/<module>/metadata/dependencydef.php, it is recommended to use the extension framework when customizing stock modules to prevent third party\u00c2\u00a0plugins from conflicting with your customizations. The following section\u00c2\u00a0will demonstrate how to implement a read-only dependency.\nSetoptions Parameters\nParameter\nType\nDescription\ntarget\nString\nThe name of the dropdown field that you want to change the option list for\nkeys\nString\nA formula used to get the option list keys for the target field or a list name from which keys will be extracted.\nlabels\nString\nA formula used to get the option list labels for the target field or a list name from which labels will be extracted.\nFor more information on the various parameters in the dependency definitions, please refer to the dependency actions documentation.\nExamples\nThe following sections outline the various ways this dependency can be implemented.\nUsing an Existing DropDown List\nYou can also set the options list to any current options list already in the system\u00c2\u00a0 For example if you wanted to have the industry dropdown in Accounts show the 'bug_type_dom' list from Bugs you could do this\n<?php\n$dependencies['Leads']['setoptions_industry'] = array(\n   'hooks' => array(\"edit\",\"save\"),\n   'trigger' => 'true',\n   'triggerFields' => array('industry'),\n   'onload' => true,\n   'actions' => array(\n     array(\n       'name' => 'SetOptions',\n       'params' => array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Dependency_Actions/SetOptions/index.html"}
{"id": "56ffbe1f1dba-1", "text": "'name' => 'SetOptions',\n       'params' => array(\n         'target' => 'industry',\n         'keys' => 'getDropdownKeySet(\"bug_type_dom\")',\n         'labels' => 'getDropdownValueSet(\"bug_type_dom\")'\n       ),\n     ),\n   ),\n);\nThis would grab the keys and label from the 'bug_type_dom' using the getDropdownKeySet() and getDropdownValueSet() JavaScript functions and display them instead of the normal list.\u00c2\u00a0\nOnce you have\u00c2\u00a0the file in place, you will need to navigate to Admin > Repairs > and\u00c2\u00a0run\u00c2\u00a0a Quick Repair and Rebuild.\nNote: It is important that the module name is plural ('Accounts' vs. 'Account') and that the name of the dependency, \"setoptions_industry\" in this example,\u00c2\u00a0is\u00c2\u00a0unique.\nComplex Dynamic Lists\nFor our first example, we will change a dropdown called fruits_c to include only fruits that are\u00c2\u00a0in season.\u00c2\u00a0 This could be done with a dependent dropdown but that would require the user to pick the proper season.\u00c2\u00a0 With this, we can have a function that returns only fruit that is in season right now.\u00c2\u00a0 I added the dropdown fruits_c to Leads and created a new list for it that looks like this\n$app_list_strings['fruits_list']=array (\n\t'Apples' => 'Apples',\n\t'Strawberries' => 'Strawberries',\n\t'Mangos' => 'Mangos',\n\t'Pineapples' => 'Pineapples',\n\t'Blackberries' => 'BlackBerries',\n\t'BlueBerries' => 'BlueBerries',\n);\nTo keep it simple I made the labels and the keys the same.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Dependency_Actions/SetOptions/index.html"}
{"id": "56ffbe1f1dba-2", "text": ");\nTo keep it simple I made the labels and the keys the same.\nThen I extended SugarLogic as outlined in Extending SugarLogic and made a new function\u00c2\u00a0called fruitInSeason() that returns a string reflecting what fruit is in season right now. \u00c2\u00a0To work for the createList() function it would return a list like \"Apples\",\"Mangos\",\"BlueBerries\".\n./custom/Extension/modules/<module>/Ext/Dependencies/custom_fruit_in_season.php\n<?php\n$dependencies['Leads']['setoptions_fruit'] = array(\n   'hooks' => array(\"edit\",\"save\"),\n   'trigger' => 'true',\n   'triggerFields' => array('fruits_c'),\n   'onload' => true,\n   'actions' => array(\n      array(\n        'name' => 'SetOptions',\n        'params' => array(\n           'target' => 'fruits_c',\n           'keys' => \"createList(fruitInSeason())\",\n           'labels' => \"createList(fruitInSeason())\"\n        ),\n      ),\n    ),\n);\nThe createList() function is a JavaScript function from Sidecar.\u00c2\u00a0 It requires a comma delimited quote enclosed list of options.\u00c2\u00a0\nWe only want this to affect EditViews and Saves, not normal record views since they need to be able to display all fruits and not a truncated list of them.\u00c2\u00a0 So we make the 'hooks' array\n'hooks' => array(\"edit\",\"save\"),\nOnce you have\u00c2\u00a0the file in place, you will need to navigate to Admin > Repairs > and\u00c2\u00a0run\u00c2\u00a0a Quick Repair and Rebuild.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Dependency_Actions/SetOptions/index.html"}
{"id": "56ffbe1f1dba-3", "text": "Note: It is important that the module name is plural ('Leads' vs. 'Lead') and that the name of the dependency, \"setoptions_fruit\" in this example,\u00c2\u00a0is\u00c2\u00a0unique.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Dependency_Actions/SetOptions/index.html"}
{"id": "2949c5c6b17b-0", "text": "SetVisibility\nOverview\nThe SugarLogic\u00c2\u00a0SetVisibility\u00c2\u00a0action, located in\u00c2\u00a0./include/Expressions/Actions/VisibilityAction.php\u00c2\u00a0, is used to\u00c2\u00a0determine\u00c2\u00a0the visibility logic of a field based on a formula.\nImplementation\nWhile the dependency metadata for your module can be defined in\u00c2\u00a0./modules/<module>/metadata/dependencydefs.php and \u00c2\u00a0./custom/modules/<module>/metadata/dependencydef.php, it is recommended to use the extension framework when customizing stock modules to prevent third party\u00c2\u00a0plugins from conflicting with your customizations. The following section\u00c2\u00a0will demonstrate how to implement a read-only dependency.\nSetVisibility Parameters\nParameter\nType\nDescription\ntarget\nString\nThe name of the field to target for visibility.\nvalue\nString\nThis parameter can accept a boolean formula or\u00c2\u00a0true\u00c2\u00a0and\u00c2\u00a0false\u00c2\u00a0values.\u00c2\u00a0 Normally you would put aSugarLogic formula here to set the boolean.\nFor more information on the various parameters in the dependency definitions, please refer to the dependency actions documentation.\nExamples\nThe follow sections outline the various ways this dependency can be implemented.\u00c2\u00a0\nSetVisibility Dependency Extensions\nFor our example, we will create a dependency on the Accounts module that shows the phone_alternate field when the phone_office field has been populated. An example is shown below.\n./custom/Extension/modules/<module>/Ext/Dependencies/custom_phone_alternate.php\n<?php\n$dependencies['Accounts']['phone_alternate_hide'] = array(\n        'hooks' => array(\"edit\"),\n        'triggerFields' => array('phone_office'),\n        'onload' => true,\n        //Actions is a list of actions to fire when the trigger is true\n        'actions' => array(\n            array(\n                'name' => 'SetVisibility',\n                'params' => array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Dependency_Actions/SetVisibility/index.html"}
{"id": "2949c5c6b17b-1", "text": "'name' => 'SetVisibility',\n                'params' => array(\n                    'target' => 'phone_alternate',\n                    'value' => 'not(equal($phone_office,\"\"))',\n                ),\n            ),\n        ),\n    );\nOnce you have\u00c2\u00a0the file in place, you will need to navigate to Admin > Repairs > and\u00c2\u00a0run\u00c2\u00a0a Quick Repair and Rebuild.\nNote: It is important that the module name is plural ('Accounts' vs. 'Account') and that the name of the dependency, \"phone_alternate_hide\" in this example,\u00c2\u00a0is\u00c2\u00a0unique.\u00c2\u00a0\nVisibility Dependencies in Field Definitions\nUnlike several of the other dependencies, SetVisibility is built into Studio.\u00c2\u00a0 So this dependency can be set as a custom vardef value or in the varefs file for a new module. If you wanted to add this dependency to an existing field then you could add a file to ./custom/Extension/modules/<module>/Ext/Vardefs/. An example is shown below.\nTo accomplish this, we will create an extension in ./custom/Extension/modules/Accounts/Ext/Vardefs/.\u00c2\u00a0\n./custom/Extension/modules/Accounts/Ext/Vardefs/phone_alternate.php\n<?php\n$dictionary['Account']['fields']['phone_alternate']['dependency']='not(equal($phone_office,\"\"))\nNext, you will need to navigate to Admin > Repairs > and\u00c2\u00a0run\u00c2\u00a0a Quick Repair and Rebuild. Once that is done, you can enter a value into phone_office and the phone_alternate field will show up once you tab out of the phone_office field. If you were coding a custom\u00c2\u00a0module with new fields, then you would just include it in the modules vardefs.php file\u00c2\u00a0as shown below\n<?php\n$dictionary['myModule'] = array(\n    ...", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Dependency_Actions/SetVisibility/index.html"}
{"id": "2949c5c6b17b-2", "text": "<?php\n$dictionary['myModule'] = array(\n    ...\n    'fields' => array(\n        ...\n        'phone_alternate' => array(            \n\t    'name' => 'phone_alternate',            \n\t    'vname' => 'LBL_PHONE_ALTERNATE',            \n\t    'type' => 'varchar',            \n\t    'len' => 10,            \n\t    'dependency'=> 'not(equal($phone_office,\"\"))',            \n\t    'comment' => 'Other Phone Number',            \n\t    'merge_filter' => 'enabled',        \n        ),\n        ...\n    )\n    ...\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Dependency_Actions/SetVisibility/index.html"}
{"id": "1412c9e60367-0", "text": "SetPanelVisibility\nOverview\nThe SugarLogic SetPanelVisibility\u00c2\u00a0action,\u00c2\u00a0defined in ./include/Expressions/Actions/PanelVisibilityAction.php, is used to determine\u00c2\u00a0the visibility of a record view panel based on a formula.\u00c2\u00a0\nImplementation\nWhile the dependency metadata for your module can be defined in\u00c2\u00a0./modules/<module>/metadata/dependencydefs.php and \u00c2\u00a0./custom/modules/<module>/metadata/dependencydef.php, it is recommended to use the extension framework when customizing stock modules to prevent third-party\u00c2\u00a0plugins from conflicting with your customizations. The following section\u00c2\u00a0will demonstrate how to implement a read-only dependency.\nSetPanelVisibility Parameters\nParameter\nType\nDescription\ntarget\nString\nThe id of the panel to hide\nvalue\nString\nFormula used to determine if the panel should be visible.\nFor more information on the various parameters in the dependency definitions, please refer to the dependency actions documentation.\nExample\nFor our example, we will create a dependency on the Cases module that will hide a specific\u00c2\u00a0panel\u00c2\u00a0if the status field on\u00c2\u00a0a case is set to \"Closed\". Our example extension definition is shown below:\u00c2\u00a0\n./custom/Extension/modules/<module>/Ext/Dependencies/hide_panel_2_dep.php\n<?php\n$dependencies['Cases']['panel_2_visibility'] = array(\n    'hooks' => array(\"edit\",\"view\"),\n    'trigger' => 'equal($status, \"Closed\")',\n    'triggerFields' => array('status'),\n    'onload' => true,\n    //Actions is a list of actions to fire when the trigger is true\n    'actions' => array(\n        array(\n            'name' => 'SetPanelVisibility',\n            'params' => array(\n                'target' => 'detailpanel_2',\n                'value' => 'true',\n            ),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Dependency_Actions/SetPanelVisibility/index.html"}
{"id": "1412c9e60367-1", "text": "'value' => 'true',\n            ),\n        )\n    ),\n    //notActions is a list of actions to fire when the trigger is false\n    'notActions' => array(\n        array(\n            'name' => 'SetPanelVisibility',\n            'params' => array(\n                'target' => 'detailpanel_2',\n                'value' => 'false',\n            ),\n        ),\n    ),\n);\nOnce you have\u00c2\u00a0the file in place, you will need to navigate to Admin > Repairs > and\u00c2\u00a0run\u00c2\u00a0a Quick Repair and Rebuild.\nNote: It is important that the module name is plural ('Cases' vs. 'Case') and that the name of the dependency, \"panel_2_visibility\" in this example,\u00c2\u00a0is\u00c2\u00a0unique.\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Dependency_Actions/SetPanelVisibility/index.html"}
{"id": "9bb980ce6094-0", "text": "Extending Sugar Logic\nOverview\nHow to write custom Sugar Logic functions.\nWriting a Custom Formula Function\nThe most important feature of Sugar Logic is that it is simply and easily extendable. Both custom formula functions and custom actions can be added in an upgrade-safe manner to allow almost any custom logic to be added to Sugar. Custom functions will be stored in ./custom/include/Expressions/Expression/{Type}/{Function_Name}.php.\nThe first step in writing a custom function is to decide what category the function falls under. Take, for example, a function for calculating the factorial of a number. In this case, we will be returning a number so we will create a file in ./custom/include/Expressions/Expression/Numeric/ called FactorialExpression.php. In the new PHP file we just created, we will define a class called FactorialExpression that will extend NumericExpression. All formula functions must follow the format {functionName}Expression.php and the class name must match the file name.\nNext, we need to decide what parameters the function will accept. In this case, we need take in a single parameter, the number to return the factorial of. Since this class will be a sub-class of NumericExpression, it by default accepts only numeric types and we do not need to worry about specifying the type requirement.\nNext, we must define the logic behind evaluating this expression. So we must override the abstract evaluate() function. The parameters can be accessed by calling an internal function getParameters() which returns the parameters passed into this object. So, with all this information, we can go ahead and write the code for the function.\nNote: For the custom function to appear in Studio after completing these steps, you must compile your code by running the Rebuild Sugar Logic Functions job in Admin > Schedulers and then clear your browser cache.\n<?php\nrequire_once 'include/Expressions/Expression/Numeric/NumericExpression.php';\nclass FactorialExpression extends NumericExpression", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Extending_Sugar_Logic/index.html"}
{"id": "9bb980ce6094-1", "text": "class FactorialExpression extends NumericExpression\n{\n    function evaluate()\n    {\n        $params = $this->getParameters();\n        // params is an Expression object, so evaluate it\n        // to get its numerical value\n        $number = $params->evaluate();\n        // exception handling\n        if ( ! is_int( $number ) )\n        {\n            throw new Exception(\"factorial: Only accepts integers\");\n        }\n        if ( $number < 0 )\n        {\n            throw new Exception(\"factorial: The number must be positive\");\n        }\n        // special case 0! = 1\n        if ( $number == 0 ) return 1;\n        // calculate the factorial\n        $factorial = 1;\n        for ( $i = 2 ; $i <= $number ; $i ++ )\n        {\n            $factorial = $factorial * $i;\n        }\n        return $factorial;\n     }\n     // Define the javascript version of the function\n     static function getJSEvaluate()\n     {\n        return <<<EOQ\n        var params = this.getParameters();\n        var number = params.evaluate();\n        // reg-exp integer test\n        if ( ! /^\\d*$/.test(number) )\n        throw \"factorial: Only accepts integers\";\n        if ( number < 0 )\n        throw \"factorial: The number must be postitive\";\n        // special case, 0! = 1\n        if ( number == 0 ) return 1;\n        // compute factorial\n        var factorial = 1;\n        for ( var i = 2 ; i <= number ; i ++ )\n        factorial = factorial * i;\n        return factorial;\nEOQ;\n        }\n        function getParameterCount()\n        {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Extending_Sugar_Logic/index.html"}
{"id": "9bb980ce6094-2", "text": "EOQ;\n        }\n        function getParameterCount()\n        {\n            return 1; // we only accept a single parameter\n        }\n        static function getOperationName()\n        {\n            return \"factorial\";\n            // our function can be called by 'factorial'\n        }\n    }\n?>\nOne of the key features of Sugar Logic is that the functions should be defined in both PHP and JavaScript and have the same functionality under both circumstances. As you can see above, the getJSEvaluate() method should return the JavaScript equivalent of your evaluate() method. The JavaScript code is compiled and assembled for you after you run the \"Rebuild Sugar Logic Functions\" script through Admin > Schedulers.\nWriting a Custom Action\nUsing custom actions, you can easily create reusable custom logic or integrations that can include user-editable logic using the Sugar Formula Engine. Custom actions will be stored in ./custom/include/Expressions/Actions/{ActionName}.php. Actions files must end in Action.php and the class defined in the file must match the file name and extend the AbstractAction class. The basic functions that must be defined are fire, getDefinition, getActionName, getJavascriptClass, and getJavscriptFire. Unlike functions, there is no requirement that an action works exactly the same\u00c2\u00a0for both server and client side as this is not always sensible or feasible.\nA simple action could be \"WarningAction\" that shows an alert warning the user that something may be wrong and logs a message to the ./sugarcrm.log file if triggered on the server side. It will take in a message as a formula so that the message can be customized at runtime. We would do this by creating a PHP file in ./custom/include/Expressions/Actions/WarningAction.php as shown below:\n./custom/include/Expressions/Actions/WarningAction.php\n<?php", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Extending_Sugar_Logic/index.html"}
{"id": "9bb980ce6094-3", "text": "./custom/include/Expressions/Actions/WarningAction.php\n<?php\nrequire_once(\"include/Expressions/Actions/AbstractAction.php\");\nclass WarningAction extends AbstractAction    {\n    protected $messageExp = \"\";\n    /**\n    * Returns the javascript class equavalent to this php class\n    * @return string javascript.\n    */\n    static function getJavascriptClass()\n    {\n        return <<<EOQ\n        SUGAR.forms.WarningAction = function(message)\n        {\n            this.messageExp = message;\n        };\n        //Use the sugar extend function to extend AbstractAction\n        SUGAR.util.extend(SUGAR.forms.WarningAction, SUGAR.forms.AbstractAction,\n        {\n            //javascript exection code\n            exec : function()\n            {\n            //assume the message is a formula\n            var msg = SUGAR.forms.evalVariableExpression(this.messageExp);\n            alert(msg.evaluate());\n            }\n        });\n    EOQ;\n    }\n    /**\n    * Returns the javascript code to generate this actions equivalent.\n    * @return string javascript.\n    */\n    function getJavascriptFire()\n    {\n        return \"new SUGAR.forms.WarningAction('{$this->messageExp}')\";\n    }\n    /**\n    * Applies the Action to the target.\n    * @param SugarBean $target\n    */\n    function fire(&$target)\n    {\n        //Parse the message formula and log it to fatal.\n        $expr = Parser::replaceVariables($this->messageExp, $target);\n        $result = Parser::evaluate($expr)->evaluate();\n        $GLOBALS['log']->warn($result);\n    }\n    /**\n    * Returns the definition of this action in array format.\n    */\n    function getDefinition()\n    {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Extending_Sugar_Logic/index.html"}
{"id": "9bb980ce6094-4", "text": "*/\n    function getDefinition()\n    {\n        return array(\"message\" => $this->messageExp);\n    }\n    /**\n    * Returns the short name used when defining dependencies that use this action.\n    */\n    static function getActionName()\n    {\n        return \"Warn\";\n    }\n}\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Extending_Sugar_Logic/index.html"}
{"id": "f47353f32369-0", "text": "Using Sugar Logic Directly\nHow to use Sugar Logic\nTopicsAccessing an External API with a Sugar Logic ActionLet us say we were building a new Action called \"SetZipCodeAction\" that uses the Yahoo geocoding API to get the zip code for a given street + city + state address.Creating a Custom Dependency for a ViewDependencies can also be created and executed outside of the built in features. For example, if you wanted to have the description field of the Calls module become required when the subject contains a specific value, you could extend the calls edit view to include that dependency.Creating a Custom Dependency Using MetadataThe files should be located in ./custom/Extension/modules/{module}/Ext/Dependencies/{dependency name}.php and be rebuilt with a quick repair after modification.Using Dependencies in Logic HooksDependencies can not only be executed on the server side but can be useful entirely on the server. For example, you could have a dependency that sets a rating based on a formula defined in a language file.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Using_Sugar_Logic_Directly/index.html"}
{"id": "478387601208-0", "text": "Creating a Custom Dependency for a View\nDependencies can also be created and executed outside of the built in features. For example, if you wanted to have the description field of the Calls module become required when the subject contains a specific value, you could extend the calls edit view to include that dependency.\n./custom/modules/Calls/views/view.edit.php\n<?php\nrequire_once \"include/MVC/View/views/view.edit.php\";\nrequire_once \"include/Expressions/Dependency.php\";\nrequire_once \"include/Expressions/Trigger.php\";\nrequire_once \"include/Expressions/Expression/Parser/Parser.php\";\nrequire_once \"include/Expressions/Actions/ActionFactory.php\";\nclass CallsViewEdit extends ViewEdit\n{\n    function CallsViewEdit()\n    {\n        parent::ViewEdit();\n    }\n    function display()\n    {\n        parent::display();\n        $dep = new Dependency(\"description_required_dep\");\n        $triggerExp = 'contains($name, \"important\")';\n        //will be array('name')\n        $triggerFields = Parser::getFieldsFromExpression($triggerExp);\n        $dep->setTrigger(new Trigger($triggerExp, $triggerFields));\n        //Set the description field to be required if \"important\" is in the call subject\n        $dep->addAction(ActionFactory::getNewAction('SetRequired', array(\n            'target' => 'description',\n            'label' => 'description_label',\n            'value' => 'true'\n        )));\n        //Set the description field to NOT be required if \"important\" is NOT in the call subject\n        $dep->addFalseAction(ActionFactory::getNewAction('SetRequired', array(\n            'target' => 'description',\n            'label' => 'description_label',\n            'value' => 'false'\n        )));", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Using_Sugar_Logic_Directly/Creating_a_Custom_Dependency_for_a_View/index.html"}
{"id": "478387601208-1", "text": "'value' => 'false'\n        )));\n        //Evaluate the trigger immediatly when the page loads\n        $dep->setFireOnLoad(true);\n        $javascript = $dep->getJavascript();\n        echo \n        SUGAR.forms.AssignmentHandler.registerView('EditView');\n        {$javascript}\n        \nEOQ;\n    }\n}\n?>\nThe above code creates a new Dependency object with a trigger based on the 'name' (Subject) field in of the Calls module. It then adds two actions. The first will set the description field to be required when the trigger formula evaluates to true (when the subject contains \"important\"). The second will fire when the trigger is false and removes the required property on the description field. Finally, the javascript version of the Dependency is generated and echoed onto the page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Using_Sugar_Logic_Directly/Creating_a_Custom_Dependency_for_a_View/index.html"}
{"id": "296d69dda5da-0", "text": "Accessing an External API with a Sugar Logic Action\nLet us say we were building a new Action called \"SetZipCodeAction\" that uses the Yahoo geocoding API to get the zip code for a given street + city + state address.\nSince the Yahoo geocoding API requires JSON requests and returns XML data, we will have to write both PHP and JavaScript code to make and interpret the requests. Because accessing external APIs in a browser is considered cross-site scripting, a local proxy will have to be used. We will also allow the street, city, state parameters to be passed in as formulas so the action could be used in more complex Dependencies.\nFirst, we should add a new action that acts as the proxy for retrieving data from the Yahoo API. The easiest place to add that would be a custom action in the \"Home\" module. The file that will act as the proxy will be .custom/modules/Home/geocode.php. It will take in the parameters via a REST call, make the call to the Yahoo API, and return the result in JSON format.\ngeocode.php contents:\n<?php\nfunction getZipCode($street, $city, $state)\n{\n    $appID = \"6ruuUKjV34Fydi4TE.ca.I02rWh.9LTMPqQnSQo4QsCnjF5wIvyYRSXPIzqlDbI.jfE-\";\n    $street = urlencode($street);\n    $city = urlencode($city);\n    $state = urlencode($state);\n    $base_url = \"http://local.yahooapis.com/MapsService/V1/geocode?\";\n    $params = \"appid={$appID}&street={$street}&city={$city}&state={$state}\";\n    //use file_get_contents to easily make the request\n    $response = file_get_contents($base_url . $params);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Using_Sugar_Logic_Directly/Accessing_an_External_API_with_a_Sugar_Logic_Action/index.html"}
{"id": "296d69dda5da-1", "text": "$response = file_get_contents($base_url . $params);\n    //The PHP XML parser is going to be overkill in this case, so just pull the zipcode with a regex.\n    preg_match('/\\([\\d-]*)\\/', $response, $matches);\n    return $matches[1];\n}\nif (!empty($_REQUEST['execute']))\n{\n\tif (empty($_REQUEST['street']) || empty($_REQUEST['city']) || empty($_REQUEST['state']))\n\t{\n\t\techo(\"Bad Request\");\n\t}\n\telse\n\t{\n\t\techo json_encode(array('zip' => getZipCode($_REQUEST['street'], $_REQUEST['city'], $_REQUEST['state'])));\n\t}\n}\n?>\nNext, we will need to map the geocode action to the geocode.php file. This is done by adding an action map to the Home Module. Create the file ./custom/modules/Home/action_file_map.php and add the following line of code:\n<?php\n$action_file_map['geocode'] = 'custom/modules/Home/geocode.php';\nWe are now ready to write our Action. Start by creating the file ./custom/include/Expressions/Actions/SetZipCodeAction.php. This file will use the proxy function directly from the PHP side and make an asynchronous call on the javascript side to the proxy.\nSetZipCodeAction.php contents:\n<?php\nrequire_once \"include/Expressions/Actions/AbstractAction.php\";\nclass SetZipCodeAction extends AbstractAction\n{\n    protected $target = \"\";\n    protected $streetExp = \"\";\n    protected $cityExp = \"\";\n    protected $stateExp = \"\";\n    function SetZipCodeAction($params)\n    {\n        $this->target = empty($params['target']) ? \" \" : $params['target'];", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Using_Sugar_Logic_Directly/Accessing_an_External_API_with_a_Sugar_Logic_Action/index.html"}
{"id": "296d69dda5da-2", "text": "$this->streetExp = empty($params['street']) ? \" \" : $params['street'];\n        $this->cityExp = empty($params['city']) ? \" \" : $params['city'];\n        $this->stateExp = empty($params['state']) ? \" \" : $params['state'];\n    }\n    static function getJavascriptClass()\n    {\n        return \"'($this->target}', '{$this->streetExp}', '{$this->cityExp}', '{$this->stateExp}')\";\n    }\n    function fire(&$bean)\n    {\n        require_once(\"custom/modules/Home/geocode.php\");\n        $vars = array(\n            'street' => 'streetExp',\n            'city' => 'cityExp',\n            'state' => 'stateExp'\n        );\n        foreach($vars as $var => $exp)\n        {\n            $toEval = Parser::replaceVariables($this->$exp, $bean);\n            $var = Parser::evaluate($toEval)->evaluate();\n        }\n        $target = $this->target;\n        $bean->$target = getZipCode($street, $city, $state);\n    }\n    function getDefinition()\n    {\n        return array(\n            \"action\" => $this->getActionName(),\n            \"target\" => $this->target,\n        );\n    }\n    static function getActionName()\n    {\n        return \"SetZipCode\";\n    }\n}\n?>\nOnce you have the action written, you need to call it somewhere in the code. Currently, this must be done as shown above using custom views, logic hooks, or custom modules.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Using_Sugar_Logic_Directly/Accessing_an_External_API_with_a_Sugar_Logic_Action/index.html"}
{"id": "399c878a35a5-0", "text": "Creating a Custom Dependency Using Metadata\nThe files should be located in ./custom/Extension/modules/{module}/Ext/Dependencies/{dependency name}.php and be rebuilt with a quick repair after modification.\nDependencies can have the following properties:\nhooks : Defines when the dependency should be evaluated. Possible values are edit (on edit/quickCreate views), view (Detail/Wireless views), save (during a save action), and all (any time the record is accessed/saved).\ntrigger : A boolean formula that defines if the actions should be fired. (optional, defaults to 'true')\ntriggerFields : An array of field names that when when modified should trigger re-evaluation of this dependency on edit views. (optional, defaults to the set of fields found in the trigger formula)\nonload : If true, the dependency will be fired when an edit view loads (optional, defaults to true)\nactions : An array of action definitions to fire when the trigger formula is true.\nnotActions : An array of action definitions to fire when the trigger formula is false. (optional)\nThe actions are defined as an array with the name of the action and a set of parameters to pass to that action. Each action takes different parameters, so you will have to check each actions class constructor to check what parameters it expects.\nThe following example dependency will set the resolution field of cases to be required when the status is Closed:\n<?php\n$dependencies['Cases']['required_resolution_dep'] = array(\n    'hooks' => array(\"edit\"),\n    //Optional, the trigger for the dependency. Defaults to 'true'.\n    'trigger' => 'true', \n    'triggerFields' => array('status'),\n    'onload' => true,\n    //Actions is a list of actions to fire when the trigger is true\n    'actions' => array(\n        array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Using_Sugar_Logic_Directly/Creating_a_custom_dependency_using_metadata/index.html"}
{"id": "399c878a35a5-1", "text": "'actions' => array(\n        array(\n            'name' => 'SetRequired',\n            //The parameters passed in will depend on the action type set in 'name'\n            'params' => array(\n                'target' => 'resolution',\n                //id of the label to add the required symbol to\n                'label' => 'resolution_label',\n                //Set required if the status is closed\n                'value' => 'equal($status, \"Closed\")' \n            )\n        ),\n    ),\n    //Actions fire if the trigger is false. Optional.\n    'notActions' => array(),\n);\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Using_Sugar_Logic_Directly/Creating_a_custom_dependency_using_metadata/index.html"}
{"id": "2fcaf2e098f2-0", "text": "Using Dependencies in Logic Hooks\nOverview\nDependencies can not only be executed on the server side\u00c2\u00a0but can be useful entirely on the server. For example, you could have a dependency that sets a rating based on a formula defined in a language file.\n<?php\nrequire_once \"include/Expressions/Dependency.php\";\nrequire_once \"include/Expressions/Trigger.php\";\nrequire_once \"include/Expressions/Expression/Parser/Parser.php\";\nrequire_once \"include/Expressions/Actions/ActionFactory.php\";\nclass Update_Account_Hook\n{\n    function updateAccount($bean, $event, $args)\n    {\n        $formula = translate('RATING_FORMULA', 'Accounts');\n        $triggerFields = Parser::getFieldsFromExpression($formula);\n        $dep = new Dependency('updateRating');\n        $dep->setTrigger(new Trigger('true', $triggerFields));\n        $dep->addAction(ActionFactory::getNewAction('SetValue', array(\n            'target' => 'rating',\n            'value' => $formula\n        )));\n        $dep->fire($bean);\n    }\n}\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Sugar_Logic/Using_Sugar_Logic_Directly/Using_dependencies_in_Logic_Hooks/index.html"}
{"id": "73fee97a1d47-0", "text": "Performance Tuning\nThe following sections detail ways to enhance the performance of your Sugar instance.\nTopicsSugar PerformancePerformance recommendations when working with Sugar.PHP ProfilingAs of the 6.6.2 release, Sugar introduced the ability to profile via XHProf, which is an easy-to-use, hierarchical profiler for PHP. This allows developers to better manage and understand customer performance issues introduced by their customizations. This tool enables quick and accurate identification of the sources of performance sinks within the code by generating profiling logs. Profiling gives you the ability to see the call stack for the entire page load with timing details around function and method calls as well as statistics on call frequency.Integrating Sugar With New Relic APM for Performance ManagementSugar\u00c2\u00ae 7 includes support for New Relic APM\u00e2\u0084\u00a2, a third-party Application Performance Management (APM) tool that can facilitate deep insight into your Sugar instance in order to troubleshoot sluggish response times. This article explains how to set up and use New Relic in conjunction with Sugar for powerful performance management capabilities.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Performance_Tuning/index.html"}
{"id": "d965c373ed42-0", "text": "Sugar Performance\nOverview\nAs your company uses Sugar over time, the size of your database will naturally grow and, without the proper maintenance, performance will inevitably begin to degrade. The purpose of this article is to review some of the most common recommendations for increasing the performance in Sugar to help increase the system's efficiency for your users.\nNote: This guide is intended for on-site installations. Customers hosted on Sugar's cloud service should file a support case for any performance issues.\nGeneral Settings in Sugar\nThe following recommendations can be modified in the Sugar admin interface\nDo Not Set Listview and Subpanel Items Per Page to Excessive Settings. Under Admin > System Settings, there are two settings 'Listview items per page' and 'Subpanel items per page'. The defaults for these settings are 20 and 10 respectively. When increasing these values, it should be expected that general system wide performance will be impacted. We generally recommend keeping listview settings to 100 or less and subpanel settings to be set to 10 or less to keep system performance optimal.\nMake sure 'Developer Mode' is disabled under Admin > System Settings. This setting should never be enabled in a production environment as it causes cached files to be rebuilt on every page load.\nSet the 'Log Level' to 'Fatal' and 'Maximum log size' to '10M' under Admin > System Settings. The log level should only be set to more verbose levels when troubleshooting the application as it will cause a performance degradation as user activity increases.\nEnsure the scheduled job, 'Prune Database on the 1st of Month', is set to 'Active'. This will go through your database and delete any records that have been deleted by your users. Sugar only soft deletes records when a user deletes a record and over time, this will cause performance degradation if these records are not removed from the database.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Performance_Tuning/Sugar_Performance/index.html"}
{"id": "d965c373ed42-1", "text": "Make sure 'Tracker Performance' and 'Tracker Queries' are disabled under Admin > Tracker. These settings are intended to help diagnose performance issues and should never be left enabled in a production environment.\nEnsure large scheduler jobs are running at slower intervals under Admin > Scheduler. Jobs such as 'Check Inbound Mailboxes' can decrease overall performance if they are running every minute and polling a lot of data. It is important to set these jobs to every 5 or 10 minutes to help offset the performance impacts for your users.\nSugar Performance Settings\nGeneral Settings\nDisable client IP verification\u00c2\u00a0:\u00c2\u00a0Eliminates the system checking to see if the user is accessing Sugar from the IP address of their last page load.\n$sugar_config['verify_client_ip'] = false;\nBWC Modules\nFor modules running in Backward Compatibility mode, the following settings can be used to speed up performance:\nDrop the absolute totals from listviews :\u00c2\u00a0Eliminates performing expensive count queries on the database when populating listviews and subpanels.\n$sugar_config['disable_count_query'] = true;\nDisable automatic searches on listviews :\u00c2\u00a0Forces a user to perform a search when they access a listview rather than loading the results from their last search.\n$sugar_config['save_query'] = 'populate_only';\n\u00c2\u00a0Hide all subpanels\u00c2\u00a0:\u00c2\u00a0 Increases performance by collapsing all subpanels when accessing a detailview every time and not querying for data until a user explicitly expands a subpanel\u00c2\u00a0\n$sugar_config['hide_subpanels'] = true;\nHide subpanels per session\u00c2\u00a0:\u00c2\u00a0 Increases performance by collapsing all subpanels when accessing a detailview when the user logs in but any subpanels expanded during the user's session will remain expanded until the user logs out\n$sugar_config['hide_subpanels_on_login'] = true;\nGeneral Environment Checks", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Performance_Tuning/Sugar_Performance/index.html"}
{"id": "d965c373ed42-2", "text": "$sugar_config['hide_subpanels_on_login'] = true;\nGeneral Environment Checks\nDepending on your environment and version of Sugar, there may be additional changes your system administrator can make to improve performance.\nIf your instance is running Sugar 6.3.x or lower, we highly recommend upgrading to 6.4.x or 6.5.x. Beginning in 6.4.x, we made a number of query improvement to address overall application performance. With 6.5.x, we drastically improved the UI to improve the speed of page loads.\nIf your instance of Sugar is version 6.3.x or higher with a MySQL database, we highly recommend upgrading the MySQL 5.5. MySQL 5.5 offers performance improvements in a number of areas over 5.1 such as subselects in queries.\nIf you are using MySQL as your database, we strongly recommend using InnoDB. InnoDB is tested to be better performing than MyISAM and should be the default configuration for using MySQL with Sugar.\nIf you are running PHP 5.2.x, we strongly recommend upgrading to a supported version of PHP 5.3. Our current list of supported PHP versions can be found on our Supported Platforms page.\nIf you are using a single server setup (web server and database on the same server), we have the following recommendations.\nThe server should have a minimum of 8 GB of RAM and roughly follow the 60/40 rule (60% for database / 40% for web server). On a 8 GB server, this would mean 4.8 GB for database and 3.2 GB for web server.\nMake sure the following parameters are set for MySQL (assumption is that the engine is InnoDB)\ninnodb_buffer_pool_size = 4294967296 (4 GB in size)", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Performance_Tuning/Sugar_Performance/index.html"}
{"id": "d965c373ed42-3", "text": "innodb_buffer_pool_size = 4294967296 (4 GB in size)\ninnodb_log_buffer_size = anywhere from 10485760 (10 MB - Minimal writes) to 104857600 (100 MB - Lots of writes)\nIf you are using IE 8 or lower, we recommend upgrading to IE 9 or using Google Chrome. Earlier versions of IE 8 exhibit poor performance with our application and we recommend updating your browser to IE 9 or changing to Chrome.\nPHP Caching\nWhether your instance of Sugar is deployed on a Linux or Windows server, you should utilize opcode caching to ensure optimal performance. For Linux servers, APC is the recommended opcode cache for PHP with the following guidelines and settings:\nUse the latest stable version.\napc.shm size should be close to your program size. For Sugar, that's at least 150 MB (default for apc.shm is 32 MB). When in doubt, more is always better.\napc.stat_ctime should be enabled. This will ensure file changes are noticed. You should note that this may increase the\u00c2\u00a0stat() activity to your NFS.\napc.file_update_protection should be enabled.\u00c2\u00a0This helps the system when trying to add multiple files to\u00c2\u00a0the cache at the same time.\nIf your installation of Sugar is located on a network filesystem such as NFS or CIFS, make sure apc.stat is enabled.\napc.ttl should be set to 0. This parameter disables garbage collection and can cause fragmentation. Earlier APC releases had locking issues that made caches with many entries take forever to be garbage collected.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Performance_Tuning/Sugar_Performance/index.html"}
{"id": "d965c373ed42-4", "text": "apc.shm_segments should be set to the default of 1. If you think you really need multiple shm_segments, you must also read the documentation on apc.mmap_file_mask as well and understand and set that value accordingly. If you don't understand apc.mmap_file_mask, you should leave apc.shm_segments at the default value.\nAPC ships with an additional apc.php file that when hit with a browser, will show settings, cache information, and fragmentation. If you suspect APC problems, this is a great tool to start checking things out.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Performance_Tuning/Sugar_Performance/index.html"}
{"id": "b51d8c58060a-0", "text": "Integrating Sugar With New Relic APM for Performance Management\nOverview\nSugar\u00c2\u00ae 7 includes support for New Relic APM\u00e2\u0084\u00a2, a third-party Application Performance Management (APM) tool that can facilitate deep insight into your Sugar instance in order to troubleshoot sluggish response times. This article explains how to set up and use New Relic in conjunction with Sugar for powerful performance management capabilities.\nNote:\u00c2\u00a0This article pertains to on-site installations of Sugar only.\u00c2\u00a0SugarCloud customers who are experiencing performance-related issues should contact the Sugar Support team for assistance.\nPrerequisites\nTo install and configure New Relic for use with your Sugar instance, you must have Sugar hosted on-site and have access to the root directory.\u00c2\u00a0\nYou must be a New Relic account holder. To sign up for New Relic, please visit newrelic.com to find the subscription level best suited for your needs.\nSteps to Complete\nNew Relic can provide useful information outside of the Sugar integration, but the feedback it provides will be limited to the instance's PHP file structure, which could make troubleshooting your instance a challenge. Follow these instructions to set up and use New Relic for PHP with your Sugar instance.\nInstalling the New Relic for PHP Agent\nFirst, install the New Relic for PHP agent. For the most current installation steps, please refer to the Getting Started Guide on the documentation site for New Relic for PHP.\nConfiguring Sugar to Work With New Relic for PHP\nEnable the Sugar integration with New Relic by editing the\u00c2\u00a0./config_override.php\u00c2\u00a0file. Add the following lines to the end of the file contents (explanation follows):\n$sugar_config['metrics_enabled'] = 1;\n$sugar_config['metric_providers']['SugarMetric_Provider_Newrelic'] = 'include/SugarMetric/Provider/Newrelic.php';", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Performance_Tuning/Integrating_Sugar_With_New_Relic_APM_for_Performance_Management/index.html"}
{"id": "b51d8c58060a-1", "text": "$sugar_config['metric_settings']['SugarMetric_Provider_Newrelic']['applicationname'] = \"SugarCRM New Relic\";\nThe first line of the configuration enables metrics collection for your Sugar instance.\nThe second line specifies the path where the New Relic provider files can be found. Note: When overwriting the New Relic provider, this path must be changed to the location where the files are located in the ./custom/ directory.\nThe last line allows you to configure a custom application name so that you may make a distinction between production, staging and development environments. This name will be displayed in your New Relic application list. Simply replace the text inside the double quotes with your desired application name. In the example above, we name the application, \"SugarCRM New Relic\".\nUsing New Relic for PHP\nNew Relic integrated with Sugar enables you to view the exact functions that cause unusual performance behavior in your instance, such as unexpected triggering of logic hooks, database queries that should be optimized, or customizations that are responding slower than expected.\nShortly after completing the configuration steps above, a new application will appear in the New Relic APM interface's application list.\u00c2\u00a0Click on the appropriate application's name to view the overview dashboard.\nOverview Dashboard\nThe dashboard gives you a quick overview of\u00c2\u00a0server response times over a selected period. By default, it will show data collected within the last 30 minutes. To the right of this chart is the Apdex\u00c2\u00a0(short for application performance index) chart. Apdex provides an easy way to measure whether performance meets user expectations.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Performance_Tuning/Integrating_Sugar_With_New_Relic_APM_for_Performance_Management/index.html"}
{"id": "b51d8c58060a-2", "text": "In this instance, the Apdex threshold, or T-value, is configured to 0.5 seconds. This means that an app server response time of 0.5 seconds or less is satisfactory for the users, a response time between 0.5 seconds and 2.0 seconds is tolerable, and any value higher than 2.0 seconds becomes frustrating.\u00c2\u00a0\nThe default Apdex T-value for New Relic\u00c2\u00a0is 0.5 seconds but it can be configured to match your current environment and user expectations. For information on changing the Apdex T-value, please refer to the\u00c2\u00a0Change Your\u00c2\u00a0Apdex Settings\u00c2\u00a0article in the New Relic documentation.\nTransactions\nThe Transactions listing is one of the most powerful tools available in New Relic. It will reveal the specific calls or actions that are taking the most time and resources from the server, and speculate as to why. Select \"Transactions\" in the menu on the left to see a full overview of all the calls done in sugar, sorted by the most time consuming.\nIn this\u00c2\u00a0case, rest_Calls_filterList is selected, which monitors the length of time that it takes to call the Calls module's list view. The performance data for this transaction is displayed on the right. As you can see at the top of the chart, calling the Calls listview has an average response time of 1.5 seconds.\nRefer to the breakdown table\u00c2\u00a0in the lower part of the screen to see which part of the call is taking the most time, with a representation of the performed actions on the database per segment.\nBelow the breakdown table\u00c2\u00a0is a list of transaction traces. New Relic will automatically generate a transaction trace when a response time is in the frustrating zone of the Apdex\u00c2\u00a0or slower.\u00c2\u00a0Click on the transaction trace to learn what is having the negative impact on the performance for this activity.\u00c2", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Performance_Tuning/Integrating_Sugar_With_New_Relic_APM_for_Performance_Management/index.html"}
{"id": "b51d8c58060a-3", "text": "The transaction trace shows how long various components took to load. In this case, the SELECT query on the Calls table took a significant amount of time.\nClick on the Trace Details tab above the chart to investigate further. The details page displays specific functions that are being called and how long they took to execute. By drilling down in the tree to the child functions, it is possible to find the root cause of the impaired performance.\nScroll down to find the SELECT query on calls took 1 second to load.\u00c2\u00a0\nClick on the database icon next to the action to reveal the SQL query called by Sugar.\nTo view all SQL queries at once, click on the SQL Statements tab.\nSummary\nFor critical business applications like CRM, an APM tool can you help keep your system running fast so\u00c2\u00a0end users\u00c2\u00a0stay productive and your organization sees a maximum return on investment. An integrated APM will monitor, analyze, and visualize the response times of your application to identify bottlenecks \u00c2\u00a0so that your team can proactively address them.\u00c2\u00a0\nTo learn more about using New Relic for PHP, please visit the New Relic\u00c2\u00a0documentation website.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Performance_Tuning/Integrating_Sugar_With_New_Relic_APM_for_Performance_Management/index.html"}
{"id": "354b8af582e6-0", "text": "PHP Profiling\nOverview\nAs of the 6.6.2 release, Sugar introduced the ability to profile via XHProf, which is an easy-to-use, hierarchical profiler for PHP. This allows developers to better manage and understand customer performance issues introduced by their customizations. This tool enables quick and accurate identification of the sources of performance sinks within the code by generating profiling logs. Profiling gives you the ability to see the call stack for the entire page load with timing details around function and method calls as well as statistics on call frequency.\nAssuming XHProf is installed and enabled in your PHP configuration (which you can learn how to do in the PHP Manual), you can enable profiling in Sugar by adding the following parameters to the ./config_override.php file:\n$sugar_config['xhprof_config']['enable'] = true;\n$sugar_config['xhprof_config']['log_to'] = '{instance server path}/cache/xhprof';\n// x where x is a number and 1/x requests are profiled. So to sample all requests set it to 1\n$sugar_config['xhprof_config']['sample_rate'] = 1;\n// array of function names to ignore from the profile (pass into xhprof_enable)\n$sugar_config['xhprof_config']['ignored_functions'] = array();\n// flags for xhprof\n$sugar_config['xhprof_config']['flags'] = XHPROF_FLAGS_CPU + XHPROF_FLAGS_MEMORY;\nPlease note that with the above 'log_to' parameter, you would need to create the \u00c2\u00a0./cache/xhprof/ directory in your instance directory with proper permissions and ownership for the Apache user. You can also opt to leave the \u00c2\u00a0xhprof_config.log_to\u00c2\u00a0parameter empty and set the logging path via the \u00c2\u00a0xhprof.output_dir parameter in the \u00c2\u00a0php.ini file.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Performance_Tuning/PHP_Profiling/index.html"}
{"id": "354b8af582e6-1", "text": "Once the above parameters are set, XHProf profiling will log all output to the indicated directory and allow you to research any performance related issues encountered in the process of developing and maintaining the application.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Performance_Tuning/PHP_Profiling/index.html"}
{"id": "3c8aec8355c9-0", "text": "Caching\nOverview\nMuch of Sugar's\u00c2\u00a0user interface is built dynamically using a combination of templates, metadata and language files. A file caching mechanism improves the performance of the system by reducing the number of static metadata and language files that need to be resolved at runtime. This cache directory stores the compiled files for JavaScript files, Handlebars templates, and language files.\nIn a stock instance, the cache is located in the ./cache/\u00c2\u00a0directory. If you would like to move this directory to a new location, you can update the config parameter cache_dir in config.php or config_override.php to meet your needs. It is not advisable to move the cache\u00c2\u00a0to another network server\u00c2\u00a0as it may impact system performance.\nDeveloper Mode\nTo prevent caching while developing, a developer may opt to turn on Developer Mode by navigating to Admin > System Settings > Advanced > Developer Mode. This will disable caching so that developers can test code-level customizations without the need to manually rebuild the cache, which is especially helpful when developing templates, metadata, or language files. The system automatically refreshes the file cache. Make sure to deactivate Developer Mode after completing customizations because this mode degrades system performance.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Caching/index.html"}
{"id": "0e08463a4399-0", "text": "Web Accessibility\nOverview\nLearn about the\u00c2\u00a0Sugar Accessibility Plugin for Sidecar.\nIntroduction\nMaking your application accessible -- per the standards defined by the W3C's WAI specifications -- is a hard thing to do and even harder to maintain. The goal of the Sugar Accessibility Plugin for Sidecar is to automatically apply rules to your rendered HTML, so that you don't have to be concerned with all of the intricacies of accessibility.\nWith respect to programmatically applying accessibility rules, you can generally assume that the rules fall into one of three categories:\nRules that are dependent on the context of the element's use and cannot be applied programmatically because the context is never clear.\nRules that can be applied programmatically, but only when the context is clear.\nRules that can always be applied programmatically.\nWe plan to continue to develop this plugin to address more and more accessibility concerns in an abstract way, with the intention of completely covering the latter two cases. In the meantime, the plugin handles two very specific cases: and (2) One from the third category.\nHow It Works\nThe plugin listens to the render event for all View.Component objects that are created. Anytime a component is rendered, the plugin runs its own plugins (hereinafter referred to as \"helpers\") on the component. Each of these helpers is responsible for determining if any modifications are necessary in order for the component's HTML to meet accessibility standards and then carrying out those changes in the DOM. This behavior is done automatically as a part of the sidecar framework, so you do not need to do anything to start using it.\nSometimes, a component that you write will modify the HTML after it has been rendered. The plugin has no means of becoming aware of these changes to the HTML and you will have to tell it to look for rules to apply. One example is found inView.Fields.Base.ActionmenuField.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Web_Accessibility/index.html"}
{"id": "0e08463a4399-1", "text": "When the user selects all records in a list view, an alert is flashed indicating that all visible records are now selected. Within this alert, a link can be clicked to select all records, even those that are not currently visible. A new onclick event listener is registered for this link. And because this link is added to the DOM after the component is rendered, the author of the component must make sure that the new HTML meets accessibility requirements. Here is how that is done:\nvar $el = $('a#select-all');\n$el.on('click', function() {...});\napp.accessiblity.run($el, 'click');\nThis will only run the click helper. If you want to run all helpers, then call app.accessiblity.run($el) (without the second parameter). But be aware that some helpers only support View.Component objects, while others support eitherView.Component objects or jQuery DOM elements. So running all helpers on a jQuery DOM element may fail, or at least fail to apply some accessibility rules as expected.\nWhen the logger is configured for debug mode, messages are logged indicating which helpers are being run and which helpers could not be run when intended.\nPlugins\nA plugin (or helper) is a module that applies an accessibility rule to a View.Component (or jQuery DOM element). At runtime, these helpers can be found in app.accessibility.helpers and implement a run method. The run method takes aView.Component (or jQuery DOM element) and then checks its HTML to determine if anything needs to be done in order to make the HTML compliant with accessibility standards related to the rule or task with which the helper is concerned. If any changes are necessary, the helper then modifies the HTML to comply.\nClick\nThe click helper is responsible for making an element compliant with accessibility standards when click events are bound to said element. Since this helper only deals with onclick events, it only inspects elements within the component that include onclick event listeners.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Web_Accessibility/index.html"}
{"id": "0e08463a4399-2", "text": "If the tag name cannot be determined for an element being inspected, then there is no way of knowing whether or not the element is accessible. Thus, the element is assumed to be compliant.\nInherently focusable elements are those elements that require no intervention. These elements include:\nbutton\ninput\nselect\ntextarea\nConditionally focusable elements are those elements that require intervention under certain circumstances. In the case of<a> and <area> tags, these elements are compliant as long as they contain an href attribute. These elements include:\na\narea\nAll other elements are not inherently focusable and require a tabindex attribute of -1 if a tabindex attribute does not already exist. This helper adds tabindex=\"-1\" to any elements within the component that are not compliant.\nWhen the logger is configured for debug mode, messages are logged...\nIn the event that no onclick events were found within the component. Thus, no action is taken.\nIn the event that an element being inspected has no tag name.\nTo report the type of element being made compliant.\nTo report the type of element that is already found to be compliant.\nLabel\nThe label helper adds an aria-label to the form element found within the component. This helper only inspects elements that can be found via the component's fieldTag selector and is consdered a \"best effort\" approach.\nThis helper will only work on View.Field components since it is extremely unlikely for the fieldTag selector forView.Layout or View.View components to match form elements.\nA form element is considered to be compliant if the aria-label attribute is already present or if its tag is not one that requires a label. These elements include:\nbutton\ninput\nselect\ntextarea", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Web_Accessibility/index.html"}
{"id": "0e08463a4399-3", "text": "button\ninput\nselect\ntextarea\nThis helper adds aria-label=\"{label}\" to the element that needs to be made compliant. View.Field.label is the label that is assigned to the attribute. The component must be a View.Component. Plain jQuery DOM elements are not sufficient since they do not include alabel property.\nAPI\nSUGAR.accessibility.init()\nInitializes the accessibility module to execute all accessibility helpers on components as they are rendered. This is called by the application during bootstrapping.\nSUGAR.accessibility.run()\nLoads the accessibility helpers that are to be run and executes them on the component.\nArguments\nName\nType\nRequired\nDescription\ncomponent\nView.Component/jQuery\ntrue\nThe element to test for accessibility compliance.\nhelper\nString/Array\nfalse\nOne or more names of specified helpers to run. All registered helpers will be run if undefined.\nReturns\nVoid\nSUGAR.accessibility.whichHelpers()\nGet the helpers registered on a specific element.\nName\nType\nRequired\nDescription\nhelper\nString/Array\ntrue\nOne or more names of specified helpers to run.\nReturns\nArray - The accessibility helpers that were requested. Filters out any named helpers that are not registered. All registered helpers are returned if no helper names are provided as a parameter.\nSUGAR.accessibility.getElementTag()\nGenerates a human-readable string for identifying an element. For example, \u00c2\u00a0a[name=\"link\"][class=\"btn btn-link\"][href=\"http://www.sugarcrm.com/\"]. Primarily used for logging purposes, this method is useful for debugging.\nArguments\nName\nType\nRequired\nDescription\n$el\njQuery\ntrue\nThe element for which the tag should be generated.\nReturns\nString - A string representing an element's tag, with all attributes. The element's selector, if one exists, is returned when a representation cannot be reasonably generated.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Web_Accessibility/index.html"}
{"id": "0e08463a4399-4", "text": "Last modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Web_Accessibility/index.html"}
{"id": "b7889ecccad7-0", "text": "Languages\nOverview\nSugar as an application platform is internationalized and localizable. Data is stored and presented in the UTF-8 codepage, allowing for all character sets to be used. Sugar provides a language-pack framework that allows developers to build support for any language in the display of user interface labels. Each language pack has its own set of display strings which is the basis of language localization. You can add or modify languages using the information in this guide.Please scroll to the bottom of this page for additional language topics.\nLanguage Keys\nSugar differentiates languages with unique language keys. These keys prefix the files that correspond with particular languages. For example, the default language for the application is English (US), which is represented by the language key en_us. Any file that contains data specific to the English (US) language begins with the characters en_us. Language label keys that are not recognized will default to the English (US) version.\nThe following table displays the list of current languages and their corresponding keys:\nLanguage\nLanguage Key\nAlbanian (Shqip)\nsq_AL\nArabic (\u00d8\u00a7\u00d9\u0084\u00d8\u00b9\u00d8\u00b1\u00d8\u00a8\u00d9\u008a\u00d8\u00a9)\nar_SA\nBulgarian (\u00d0\u0091\u00d1\u008a\u00d0\u00bb\u00d0\u00b3\u00d0\u00b0\u00d1\u0080\u00d1\u0081\u00d0\u00ba\u00d0\u00b8)\nbg_BG\nCatalan (Catal\u00c3\u00a0)\nca_ES\nChinese (\u00e7\u00ae\u0080\u00e4\u00bd\u0093\u00e4\u00b8\u00ad\u00e6\u0096\u0087)\nzh_CN\nCroatian (Hrvatski)\nhr_HR\nCzech (\u00c4\u008cesky)\ncs_CZ\nDanish (Dansk)\nda_DK\nDutch (Nederlands)\nnl_NL\nEnglish (UK)\nen_UK\nEnglish (US)\nen_us\nEstonian (Eesti)\net_EE", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/index.html"}
{"id": "b7889ecccad7-1", "text": "English (US)\nen_us\nEstonian (Eesti)\net_EE\nFinnish (Suomi)\nfi_FI\nFrench (Fran\u00c3\u00a7ais)\nfr_FR\nGerman (Deutsch)\nde_DE\nGreek (\u00ce\u0095\u00ce\u00bb\u00ce\u00bb\u00ce\u00b7\u00ce\u00bd\u00ce\u00b9\u00ce\u00ba\u00ce\u00ac)\nel_EL\nHebrew (\u00d7\u00a2\u00d7\u0091\u00d7\u00a8\u00d7\u0099\u00d7\u00aa)\nhe_IL\nHungarian (Magyar)\nhu_HU\nItalian (Italiano)\nit_it\nJapanese (\u00e6\u0097\u00a5\u00e6\u009c\u00ac\u00e8\u00aa\u009e)\nja_JP\nKorean (\u00ed\u0095\u009c\u00ea\u00b5\u00ad\u00ec\u0096\u00b4)\nko_KR\nLatvian (Latvie\u00c5\u00a1u)\nlv_LV\nLithuanian (Lietuvi\u00c5\u00b3)\nlt_LT\nNorwegian (Bokm\u00c3\u00a5l)\nnb_NO\nPolish (Polski)\npl_PL\nPortuguese (Portugu\u00c3\u00aas)\npt_PT\nPortuguese Brazilian (Portugu\u00c3\u00aas Brasileiro)\npt_BR\nRomanian (Rom\u00c3\u00a2n\u00c4\u0083)\nro_RO\nRussian (\u00d0\u00a0\u00d1\u0083\u00d1\u0081\u00d1\u0081\u00d0\u00ba\u00d0\u00b8\u00d0\u00b9)\nru_RU\nSerbian (\u00d0\u00a1\u00d1\u0080\u00d0\u00bf\u00d1\u0081\u00d0\u00ba\u00d0\u00b8)\nsr_RS\nSlovak (Sloven\u00c4\u008dina)\nsk_SK\nSpanish (Espa\u00c3\u00b1ol)\nes_ES\nSpanish (Latin America) (Espa\u00c3\u00b1ol (Latinoam\u00c3\u00a9rica))\nes_LA\nSwedish (Svenska)\nsv_SE\nThai (\u00e0\u00b9\u0084\u00e0\u00b8\u0097\u00e0\u00b8\u00a2)\nth_TH", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/index.html"}
{"id": "b7889ecccad7-2", "text": "Thai (\u00e0\u00b9\u0084\u00e0\u00b8\u0097\u00e0\u00b8\u00a2)\nth_TH\nTraditional Chinese (\u00e7\u00b9\u0081\u00e9\u00ab\u0094\u00e4\u00b8\u00ad\u00e6\u0096\u0087)\nzh_TW\nTurkish (T\u00c3\u00bcrk\u00c3\u00a7e)\ntr_TR\nUkrainian (\u00d0\u00a3\u00d0\u00ba\u00d1\u0080\u00d0\u00b0\u00d1\u0097\u00d0\u00bd\u00d1\u0081\u00d1\u008c\u00d0\u00ba\u00d0\u00b0)\nuk_UA\n\u00c2\u00a0\nChange Log\nThe following table documents historical changes to Sugar's available languages.\nVersion\nChange\n7.8.0.0\nAdded Thai language pack.\n7.8.0.0\nAdded Croatian language pack.\n7.7.0.0\nAdded Traditional Chinese language pack.\n7.6.0.0\nAdded Ukrainian language pack.\n7.6.0.0\nAdded Arabic language pack.\n7.2.0\nAdded Finnish language pack.\n7.2.0\nAdded Spanish (Latin America) language pack.\n6.6.0\nAdded Albanian language pack.\n6.6.0\nAdded Slovak language pack.\n6.6.0\nAdded Korean language pack.\n6.6.0\nAdded Greek language pack.\n6.5.1\nAdded Latvian language pack.\n6.4.0\nAdded Serbian language pack.\n6.4.0\nAdded Portuguese Brazilian language pack.\n6.4.0\nAdded English (UK) language pack.\n6.4.0\nAdded Catalan language pack.\n6.2.0\nAdded Polish language pack.\n6.2.0\nAdded Hebrew language pack.\n6.2.0\nAdded Estonian language pack.\n6.2.0\nAdded Czech language pack.\n6.1.2\nAdded Turkish language pack.\n6.1.2", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/index.html"}
{"id": "b7889ecccad7-3", "text": "6.1.2\nAdded Turkish language pack.\n6.1.2\nAdded Swedish language pack.\n6.1.2\nAdded Norwegian language pack.\n6.1.2\nAdded Lithuanian language pack.\n6.1.0\nAdded Chinese language pack.\n6.1.0\nAdded Russian language pack.\n6.1.0\nAdded Romanian language pack.\n6.1.0\nAdded Portuguese language pack.\n6.1.0\nAdded Dutch language pack.\n6.1.0\nAdded Japanese language pack.\n6.1.0\nAdded Italian language pack.\n6.1.0\nAdded Hungarian language pack.\n6.1.0\nAdded French language pack.\n6.1.0\nAdded Spanish language pack.\n6.1.0\nAdded German language pack.\n6.1.0\nAdded Danish language pack.\n6.1.0\nAdded Bulgarian language pack.\nTopicsApplication Labels and ListsSugar, which is fully internationalized and localizable, differentiates languages with unique language keys. These keys prefix the files that correspond with particular languages. For example, the default language for the application is English (US), which is represented by the language key en_us. Any file that contains data specific to the English (US) language begins with the characters en_us. Language label keys that are not recognized will default to the English (US) version.Module Labelsrequire_once 'include/utils.php';Managing ListsThere are three ways to manage lists in Sugar: by using Studio in the application, by directly modifying the list's language strings, and via the code-level Dropdown Helper. This page explains all three methods.Language PacksLanguage packs are module-loadable packages that add support for new, localized languages to Sugar.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/index.html"}
{"id": "708d09b959f1-0", "text": "Language Packs\nOverview\nLanguage packs are module-loadable packages that add support for new, localized languages to Sugar.\nCreating a Language Pack\nTo create a language pack, choose a unique language key. This key is specific to your language definitions and should be unique from other language keys in the same instance to avoid conflicts. It is also important that your language key follows the\u00c2\u00a0xx_xx format. For demonstrative purposes, we will create a Lorem Ipsum language pack with the language key Lo_Ip.\nApplication and Module Strings\nIn the module and application language definitions, there is\u00c2\u00a0a combination of $app_list_strings, $mod_strings, and $mod_process_order_strings\u00c2\u00a0variables. Your custom language needs\u00c2\u00a0to have a definition created\u00c2\u00a0to reflect each language key in a standard definition.\u00c2\u00a0To do this, duplicate an existing language\u00c2\u00a0and simply change the language values within the document\u00c2\u00a0and\u00c2\u00a0replace the language key in the name of the file with your new key. Be\u00c2\u00a0sure\u00c2\u00a0to only change the\u00c2\u00a0array values\u00c2\u00a0and leave the array keys as they are inside of each file.\nNote:\u00c2\u00a0Should you miss an index, it will default to English.\u00c2\u00a0\nThe\u00c2\u00a0first step is to identify all of the application and module language\u00c2\u00a0files.\u00c2\u00a0While\u00c2\u00a0language files may vary from version to version due to new features, the stock language paths are generally as follows:\n./include/language/xx_xx.lang.php\n./include/SugarObjects/implements/assignable/language/xx_xx.lang.php\n./include/SugarObjects/implements/email_address/language/xx_xx.lang.php\n./include/SugarObjects/implements/team_security/language/xx_xx.lang.php\n./include/SugarObjects/templates/basic/language/xx_xx.lang.php\n./include/SugarObjects/templates/company/language/xx_xx.lang.php", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/Language_Packs/index.html"}
{"id": "708d09b959f1-1", "text": "./include/SugarObjects/templates/company/language/xx_xx.lang.php\n./include/SugarObjects/templates/company/language/application/xx_xx.lang.php\n./include/SugarObjects/templates/file/language/xx_xx.lang.php\n./include/SugarObjects/templates/file/language/application/xx_xx.lang.php\n./include/SugarObjects/templates/issue/language/xx_xx.lang.php\n./include/SugarObjects/templates/issue/language/application/xx_xx.lang.php\n./include/SugarObjects/templates/person/language/xx_xx.lang.php\n./include/SugarObjects/templates/sale/language/xx_xx.lang.php\n./include/SugarObjects/templates/sale/language/application/xx_xx.lang.php\n./install/language/xx_xx.lang.php\n./modules/Accounts/language/xx_xx.lang.php\n./modules/ACL/language/xx_xx.lang.php\n./modules/ACLActions/language/xx_xx.lang.php\n./modules/ACLFields/language/xx_xx.lang.php\n./modules/ACLRoles/language/xx_xx.lang.php\n./modules/Activities/language/xx_xx.lang.php\n./modules/ActivityStream/Activities/language/xx_xx.lang.php\n./modules/Administration/language/xx_xx.lang.php\n./modules/Audit/language/xx_xx.lang.php\n./modules/Bugs/language/xx_xx.lang.php\n./modules/Calendar/language/xx_xx.lang.php\n./modules/Calls/language/xx_xx.lang.php\n./modules/CampaignLog/language/xx_xx.lang.php\n./modules/Campaigns/language/xx_xx.lang.php\n./modules/CampaignTrackers/language/xx_xx.lang.php\n./modules/Cases/language/xx_xx.lang.php\n./modules/Charts/language/xx_xx.lang.php\n./modules/Configurator/language/xx_xx.lang.php\n./modules/Connectors/language/xx_xx.lang.php\n./modules/Contacts/language/xx_xx.lang.php\n./modules/Contracts/language/xx_xx.lang.php\n./modules/ContractTypes/language/xx_xx.lang.php", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/Language_Packs/index.html"}
{"id": "708d09b959f1-2", "text": "./modules/ContractTypes/language/xx_xx.lang.php\n./modules/Currencies/language/xx_xx.lang.php\n./modules/CustomQueries/language/xx_xx.lang.php\n./modules/DataSets/language/xx_xx.lang.php\n./modules/DocumentRevisions/language/xx_xx.lang.php\n./modules/Documents/language/xx_xx.lang.php\n./modules/DynamicFields/language/xx_xx.lang.php\n./modules/EAPM/language/xx_xx.lang.php\n./modules/EmailAddresses/language/xx_xx.lang.php\n./modules/EmailMan/language/xx_xx.lang.php\n./modules/EmailMarketing/language/xx_xx.lang.php\n./modules/Emails/language/xx_xx.lang.php\n./modules/EmailTemplates/language/xx_xx.lang.php\n./modules/Employees/language/xx_xx.lang.php\n./modules/ExpressionEngine/language/xx_xx.lang.php\n./modules/Expressions/language/xx_xx.lang.php\n./modules/Feedbacks/language/xx_xx.lang.php\n./modules/Filters/language/xx_xx.lang.php\n./modules/ForecastManagerWorksheets/language/xx_xx.lang.php\n./modules/Forecasts/language/xx_xx.lang.php\n./modules/ForecastWorksheets/language/xx_xx.lang.php\n./modules/Groups/language/xx_xx.lang.php\n./modules/Help/language/xx_xx.lang.php\n./modules/History/language/xx_xx.lang.php\n./modules/Holidays/language/xx_xx.lang.php\n./modules/Home/language/xx_xx.lang.php\n./modules/Import/language/xx_xx.lang.php\n./modules/InboundEmail/language/xx_xx.lang.php\n./modules/KBDocuments/language/xx_xx.lang.php\n./modules/KBTags/language/xx_xx.lang.php\n./modules/LabelEditor/language/xx_xx.lang.php\n./modules/Leads/language/xx_xx.lang.php\n./modules/MailMerge/language/xx_xx.lang.php", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/Language_Packs/index.html"}
{"id": "708d09b959f1-3", "text": "./modules/MailMerge/language/xx_xx.lang.php\n./modules/Manufacturers/language/xx_xx.lang.php\n./modules/Meetings/language/xx_xx.lang.php\n./modules/MergeRecords/language/xx_xx.lang.php\n./modules/ModuleBuilder/language/xx_xx.lang.php\n./modules/Notes/language/xx_xx.lang.php\n./modules/Notifications/language/xx_xx.lang.php\n./modules/OAuthKeys/language/xx_xx.lang.php\n./modules/OAuthTokens/language/xx_xx.lang.php\n./modules/Opportunities/language/xx_xx.lang.php\n./modules/OptimisticLock/language/xx_xx.lang.php\n./modules/PdfManager/language/xx_xx.lang.php\n./modules/pmse_Business_Rules/language/xx_xx.lang.php\n./modules/pmse_Emails_Templates/language/xx_xx.lang.php\n./modules/pmse_Inbox/language/xx_xx.lang.php\n./modules/pmse_Project/language/xx_xx.lang.php\n./modules/ProductBundleNotes/language/xx_xx.lang.php\n./modules/ProductBundles/language/xx_xx.lang.php\n./modules/ProductCategories/language/xx_xx.lang.php\n./modules/Products/language/xx_xx.lang.php\n./modules/ProductTemplates/language/xx_xx.lang.php\n./modules/ProductTypes/language/xx_xx.lang.php\n./modules/Project/language/xx_xx.lang.php\n./modules/ProjectTask/language/xx_xx.lang.php\n./modules/ProspectLists/language/xx_xx.lang.php\n./modules/Prospects/language/xx_xx.lang.php\n./modules/Quotas/language/xx_xx.lang.php\n./modules/Quotes/language/xx_xx.lang.php\n./modules/Relationships/language/xx_xx.lang.php\n./modules/Releases/language/xx_xx.lang.php\n./modules/ReportMaker/language/xx_xx.lang.php\n./modules/Reports/language/xx_xx.lang.php\n./modules/RevenueLineItems/language/xx_xx.lang.php", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/Language_Packs/index.html"}
{"id": "708d09b959f1-4", "text": "./modules/RevenueLineItems/language/xx_xx.lang.php\n./modules/Roles/language/xx_xx.lang.php\n./modules/SavedSearch/language/xx_xx.lang.php\n./modules/Schedulers/language/xx_xx.lang.php\n./modules/SchedulersJobs/language/xx_xx.lang.php\n./modules/Shippers/language/xx_xx.lang.php\n./modules/SNIP/language/xx_xx.lang.php\n./modules/Studio/language/xx_xx.lang.php\n./modules/Styleguide/language/xx_xx.lang.php\n./modules/SugarFavorites/language/xx_xx.lang.php\n./modules/Sync/language/xx_xx.lang.php\n./modules/Tasks/language/xx_xx.lang.php\n./modules/TaxRates/language/xx_xx.lang.php\n./modules/TeamNotices/language/xx_xx.lang.php\n./modules/Teams/language/xx_xx.lang.php\n./modules/TimePeriods/language/xx_xx.lang.php\n./modules/Trackers/language/xx_xx.lang.php\n./modules/UpgradeWizard/language/xx_xx.lang.php\n./modules/Users/language/xx_xx.lang.php\n./modules/UserSignatures/language/xx_xx.lang.php\n./modules/WebLogicHooks/language/xx_xx.lang.php\n./modules/WorkFlow/language/xx_xx.lang.php\n./modules/WorkFlowActions/language/xx_xx.lang.php\n./modules/WorkFlowActionShells/language/xx_xx.lang.php\n./modules/WorkFlowAlerts/language/xx_xx.lang.php\n./modules/WorkFlowAlertShells/language/xx_xx.lang.php\n./modules/WorkFlowTriggerShells/language/xx_xx.lang.php\nDashlet Strings", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/Language_Packs/index.html"}
{"id": "708d09b959f1-5", "text": "./modules/WorkFlowTriggerShells/language/xx_xx.lang.php\nDashlet Strings\nDashlet strings are mostly specific to BWC dashboards. Within each dashlet language definition\u00c2\u00a0is a\u00c2\u00a0$dashletStrings\u00c2\u00a0variable. Create a definition to mimic\u00c2\u00a0each dashlet file\u00c2\u00a0to reflect the\u00c2\u00a0new language. To do this,\u00c2\u00a0duplicate an existing language of your choice\u00c2\u00a0and change the language key in the path.\u00c2\u00a0Be sure to only change the\u00c2\u00a0array values\u00c2\u00a0and leave the array keys as they are inside of each file.\nThe dashlet paths are listed below:\n./modules/Calendar/Dashlets/CalendarDashlet/CalendarDashlet.xx_xx.lang.php\n./modules/Charts/Dashlets/CampaignROIChartDashlet/CampaignROIChartDashlet.xx_xx.lang.php\n./modules/Charts/Dashlets/MyModulesUsedChartDashlet/MyModulesUsedChartDashlet.xx_xx.lang.php\n./modules/Charts/Dashlets/MyOpportunitiesGaugeDashlet/MyOpportunitiesGaugeDashlet.xx_xx.lang.php\n./modules/Charts/Dashlets/MyPipelineBySalesStageDashlet/MyPipelineBySalesStageDashlet.xx_xx.lang.php\n./modules/Charts/Dashlets/MyTeamModulesUsedChartDashlet/MyTeamModulesUsedChartDashlet.xx_xx.lang.php\n./modules/Charts/Dashlets/OpportunitiesByLeadSourceByOutcomeDashlet/OpportunitiesByLeadSourceByOutcomeDashlet.xx_xx.lang.php\n./modules/Charts/Dashlets/OpportunitiesByLeadSourceDashlet/OpportunitiesByLeadSourceDashlet.xx_xx.lang.php\n./modules/Charts/Dashlets/OutcomeByMonthDashlet/OutcomeByMonthDashlet.xx_xx.lang.php", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/Language_Packs/index.html"}
{"id": "708d09b959f1-6", "text": "./modules/Charts/Dashlets/PipelineBySalesStageDashlet/PipelineBySalesStageDashlet.xx_xx.lang.php\n./modules/Home/Dashlets/ChartsDashlet/ChartsDashlet.xx_xx.lang.php\n./modules/Home/Dashlets/InvadersDashlet/InvadersDashlet.xx_xx.lang.php\n./modules/Home/Dashlets/JotPadDashlet/JotPadDashlet.xx_xx.lang.php\n./modules/Home/Dashlets/RSSDashlet/RSSDashlet.xx_xx.lang.php\n./modules/SugarFavorites/Dashlets/SugarFavoritesDashlet/SugarFavoritesDashlet.xx_xx.lang.php\n./modules/TeamNotices/Dashlets/TeamNoticesDashlet/TeamNoticesDashlet.xx_xx.lang.php\n./modules/Trackers/Dashlets/TrackerDashlet/TrackerDashlet.xx_xx.lang.php\nTemplates\nSugar also contains templates that are used when emailing users. Duplicate an existing language template\u00c2\u00a0and change the language text as needed. This time, you will need to leave the language keys exactly as they are in the file.\nThe template paths are listed below:\n./include/language/xx_xx.notify_template.html\nConfiguration\nOnce you have your language definitions ready, you will need to tell Sugar a new language should be listed for users. For development purposes, you can add\u00c2\u00a0$sugar_config['languages']['Lo_Ip'] = 'Lorem Ipsum'; to your config_override.php. It is important to note that this language configuration will automatically be set for you during the installation of a module loadable language package.\u00c2\u00a0\nModule Loadable Packages", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/Language_Packs/index.html"}
{"id": "708d09b959f1-7", "text": "Module Loadable Packages\nOnce you have the new\u00c2\u00a0language files ready, create an installer package so the files can be installed to a new instance. To do this, create an empty directory and move the files into it, mimicking the folder structures shown above. Once that is completed, create a manifest.php in the root of the\u00c2\u00a0new directory with a $manifest['type'] of \"langpack\". An example manifest file is shown below this section. For more information on building manifests, please visit the introduction to the manifest\u00c2\u00a0page.\nNote: Sugar Sell Essentials customers do not have the ability to upload custom file packages to Sugar using Module Loader.\nExample Manifest File\n<?php\n$manifest = array (\n  'acceptable_sugar_versions' => \n  array (\n    'regex_matches' => \n    array (\n      '13.0.*',\n    ),\n  ),\n  'acceptable_sugar_flavors' => \n  array (\n    'PRO',\n    'ENT',\n    'ULT',\n  ),\n  'readme' => '',\n  'key' => 1454474352,\n  'author' => 'SugarCRM',\n  'description' => 'Installs an example Lorem Ipsum language pack',\n  'icon' => '',\n  'is_uninstallable' => true,\n  'name' => 'Lorem Ipsum Language Pack',\n  'published_date' => '2018-02-03 00:00:00',\n  'type' => 'langpack',\n  'version' => 1454474352,\n  'remove_tables' => '',\n);\n?>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/Language_Packs/index.html"}
{"id": "708d09b959f1-8", "text": "'remove_tables' => '',\n);\n?>\nOnce your manifest is completed, you\u00c2\u00a0will need to zip up the contents of your new folder. An example of a language pack installer can be downloaded\u00c2\u00a0here. When your language pack is ready, it can be installed through the module loader. The installation\u00c2\u00a0will automatically add your new language to the $sugar_config['languages'] array in your config.php. After\u00c2\u00a0installation. it is highly recommended to navigate to the Sugar Administration page, click on \"Repairs\", and execute the following repair tools:\nQuick Repair and Rebuild\nRebuild Javascript Languages\nThe new language should now be available for use in your Sugar instance. If you do not see the language listed, please clear your browser cache and refresh the page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/Language_Packs/index.html"}
{"id": "87f0f710a46c-0", "text": "Application Labels and Lists\nOverview\n\u00c2\u00a0\nSugar, which is fully internationalized and localizable, differentiates languages with unique language keys. These keys prefix the files that correspond with particular languages. For example, the default language for the application is English (US), which is represented by the language key en_us. Any file that contains data specific to the English (US) language begins with the characters en_us. Language label keys that are not recognized will\u00c2\u00a0default to the English (US) version.\nFor more information on language keys, please refer to the Languages page.\nApplication Labels and Lists\n$app_list_strings and $app_strings\nThe $app_list_strings\u00c2\u00a0array contains the various dropdown lists for the system\u00c2\u00a0while $app_strings contains the system application labels. The initial set of definitions can be found in ./include/language/<language key>.lang.php. As you work within the system and deploy modules and lists through Studio, any changes to these lists\u00c2\u00a0will be reflected in the language's extension\u00c2\u00a0directory: ./custom/Extension/application/Ext/Language/<language key>.<list name>.php.\nCustomizing Application Labels and Lists\nIf you are developing a customization and want to be able to create or edit existing label or list values, you will need to work within the extension application directory. To do this, create\u00c2\u00a0./custom/Extension/application/Ext/Language/<language key>.<unique name>.php.\nThe file should\u00c2\u00a0contain your override values with each label index set individually. An example of this is:\n<?php\n$app_strings['LBL_KEY'] = 'My Display Label';\n$app_list_strings['LIST_NAME']['Key_Value'] = 'My Display Value';", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/Application_Labels_and_Lists/index.html"}
{"id": "87f0f710a46c-1", "text": "$app_list_strings['LIST_NAME']['Key_Value'] = 'My Display Value';\nOnce the file is created with your adjustments, navigate to Admin > Repair > Quick Rebuild & Repair. This will compile all of the Extension files from ./custom/Extension/application/Ext/Language/ to ./custom/application/Ext/Language/<language key>.lang.ext.php.\nHierarchy Diagram\nRetrieving Labels\nThere are two ways to retrieve a label. The first is to use the translate()\u00c2\u00a0function found in ./include/utils.php. This function will retrieve the label for the current user's language and can also be used to retrieve labels from $mod_strings, $app_strings, or app_list_strings.\nAn example of this is:\nrequire_once 'include/utils.php';\n$label = translate('LBL_KEY');\nAlternatively, you can also use the global variable $app_strings as follows:\nglobal $app_strings;\n$label = '';\nif (isset($app_strings['LBL_KEY']))\n{\n    $label = $app_strings['LBL_KEY'];\n}\nNote: If a label key is not found for the user's preferred language, the system will default to \"en_us\" and pull the English (US) version of the label for display.\u00c2\u00a0\nRetrieving Lists\nThere are two ways to retrieve a label. The first is to use the translate() function found in include/utils.php. This function will retrieve the label for the current user's language.\nAn example of this is:\nrequire_once 'include/utils.php';\n$list = translate('LIST_NAME');\n//You can also retrieve a specific list value this way\n$displayValue = translate('LIST_NAME', '', 'Key_Value');\nAlternatively, you can also use the global variable $app_list_strings as follows:\nglobal $app_list_strings;\n$list = array();\nif (isset($app_list_strings['LIST_NAME']))\n{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/Application_Labels_and_Lists/index.html"}
{"id": "87f0f710a46c-2", "text": "$list = array();\nif (isset($app_list_strings['LIST_NAME']))\n{\n    $list = $app_list_strings['LIST_NAME'];\n}\nNote: If a list\u00c2\u00a0key is not found for the user's preferred language, the system will default to \"en_us\" and pull the English (US) version of the list for display.\nAccessing Application Strings in Sidecar\nAll language-pack strings are accessible within the Sidecar framework.\n$app_strings\nTo access $app_strings in Sidecar, use app.lang.getAppString:\napp.lang.getAppString('LBL_MODULE');\nTo access\u00c2\u00a0$app_strings in your browser's console, use SUGAR.App.lang.getAppString:\nSUGAR.App.lang.getAppString('LBL_MODULE');\nFor more information, please refer to the app.lang.getAppString section of the Languages page.\n$app_list_strings\nTo access $app_list_strings in Sidecar, use app.lang.getAppListStrings:\napp.lang.getAppListStrings('sales_stage_dom');\nTo access\u00c2\u00a0$app_list_strings in your browser's console, use SUGAR.App.lang.getAppListStrings:\nSUGAR.App.lang.getAppListStrings('sales_stage_dom');\nFor more information, please refer to the app.lang.getAppListStrings section of the Languages page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/Application_Labels_and_Lists/index.html"}
{"id": "46dc624b708f-0", "text": "Module Labels\nrequire_once 'include/utils.php';\n$label = translate('LBL_KEY', 'Accounts');\nOverview\nSugar, which is fully internationalized and localizable, differentiates languages with unique language keys. These keys prefix the files that correspond to particular languages. For example, the default language for the application is English (US), which is represented by the language key en_us. Any file that contains data specific to the English (US) language begins with the characters en_us. Language label keys that are not recognized will\u00c2\u00a0default to the English (US) version.\nFor more information on language keys, please refer to the Languages page.\nModule Labels\n$mod_strings\nThe module language strings are stored in $mod_strings. This section explains how the $mod_strings are compiled. All modules, whether out-of-box or custom, will have an initial set of language files in ./modules/<module>/language/<language key>.lang.php.\nAs you work with the system and modify labels through Studio, changes to the labels are reflected in the corresponding module's custom extension directory: ./custom/Extension/modules/<module>/Ext/Language/<language key>.lang.php.\nCustomizing Labels\nIf you are developing a customization and want to be able to create new or override existing label values, you will need to work within the extension modules directory. To do this, create ./custom/Extension/modules/<module>/Ext/Language/<language key>.<unique_name>.php.\nThe file should contain your override values with each label index set individually. An example of this is:\n<?php\n$mod_strings['LBL_KEY'] = 'My Display Label';", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/Module_Labels/index.html"}
{"id": "46dc624b708f-1", "text": "<?php\n$mod_strings['LBL_KEY'] = 'My Display Label';\nOnce the file is created with your adjustments, navigate to Admin > Repair > Quick Rebuild & Repair. This will compile all of the Extension files from ./custom/Extension/modules/<module>/Ext/Language/ to ./custom/modules/<module>/Ext/Language/<language key>.lang.ext.php.\nLabel Cache\nThe file locations discussed above are compiled into the cache directory, ./cache/modules/<module>/language/<language key>.lang.php\nThe cached results of these files make up each module's $mod_strings definition.\nHierarchy Diagram\nRetrieving Labels\nThere are two ways to retrieve a label. The first is to use the translate() function found in include/utils.php. This function will retrieve the label for the current user's language and can also be used to retrieve labels from $mod_strings, $app_strings, or app_list_strings.\nAn example of this is:\nrequire_once 'include/utils.php';\n$label = translate('LBL_KEY', 'Accounts');\nAlternatively, you can use the global variable $mod_strings as follows:\nglobal $mod_strings;\n$label = '';\nif (isset($mod_strings['LBL_KEY']))\n{\n    $label = $mod_strings['LBL_KEY'];\n}\nAccessing Module Strings in Sidecar\nAll language-pack strings are accessible within the Sidecar framework.\n$mod_strings\nTo access the $mod_strings in Sidecar, use app.lang.get():\napp.lang.get('LBL_NAME', 'Accounts');\nTo access the $mod_strings in your browser's console, use SUGAR.App.lang.get():\nSUGAR.App.lang.get('LBL_NAME', 'Accounts');\nFor more information, please refer to the app.lang.get section of the Languages page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/Module_Labels/index.html"}
{"id": "1ee326afe021-0", "text": "Managing Lists\nOverview\nThere are three ways to manage lists in Sugar: by using Studio in the application, by directly modifying the list's language strings, and via the code-level Dropdown Helper. This page explains all three methods.\nManaging Lists With Studio\nIf you know the name of the list you would like to edit, you can access the application's dropdown editor by navigating to Admin > Dropdown Editor. Alternatively, navigate to a field that uses the list (Admin > Studio > {Module} > Fields > {field_name}) and click \"Edit\" under the Dropdown List field:\nFor information on using the dropdown editor, please refer to the Developer Tools documentation in the Administration Guide.\nDirectly Modifying Lists\nThere are two ways to directly modify the language strings. The first way is to modify the custom language file, located at ./custom/include/language/<language key>.lang.php.\nIf you are developing a customization to be distributed and you want to be able to create new or override existing list values, you will need to work within the extension application directory. To do this you will create the following file: ./custom/Extension/application/Ext/Language/<language key>.<unique name>.php.\nThe file will contain your override values. Please note that within this file you will set each label index individually. An example of this is:\n<?php\n$app_list_strings['LIST_NAME']['Key_Value'] = 'My Display Value';\nOnce the file is created with your adjustments, navigate to Admin > Repair > Quick Rebuild & Repair. This will compile all of the Extension files from ./custom/Extension/application/Ext/Language/ to ./custom/application/Ext/Language/<language key>.lang.ext.php.\nManaging Lists With Dropdown Helper\nYou can use the dropdown helper to manage lists at the code level. This example demonstrates how to add and update values for a specific dropdown list:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/Managing_Lists/index.html"}
{"id": "1ee326afe021-1", "text": "require_once 'modules/Studio/DropDowns/DropDownHelper.php';\n$dropdownHelper = new DropDownHelper();\n$parameters = array();\n$parameters['dropdown_name'] = 'example_list';\n$listValues = array(\n    'Key_Value_1' => 'Display Value 1',\n    'Key_Value_2' => 'Display Value 2',\n    'Key_Value_3' => 'Display Value 3'\n);\n$count = 0;\nforeach ($listValues as $key=>$value) {\n    $parameters['slot_'. $count] = $count;\n    $parameters['key_'. $count] = $key;\n    $parameters['value_'. $count] = $value;\n    //set 'use_push' to true to update/add values while keeping old values\n    $parameters['use_push'] = true;\n    $count++;\n}\n$dropdownHelper->saveDropDown($parameters);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Languages/Managing_Lists/index.html"}
{"id": "5ecada6bccb5-0", "text": "Module Loader\nModule Loader is used when installing\u00c2\u00a0customizations, plugins,language\u00c2\u00a0packs, and\u00c2\u00a0hotfixes, and other customizations into a Sugar instance in the form of a Module Loadable Package. This documentation covers the basics and best practices for creating module loadable packages for a Sugar installation.\nNote: Sugar Sell Essentials customers do not have the ability to upload custom file packages to Sugar using Module Loader.\nTopicsIntroduction to the ManifestModule loadable packages rely on a manifest.php file to define the basic properties and installation steps for the package. This documentation explains the various components that make up the manifest file.Module Loader RestrictionsSugarCRM's hosting objective is to maintain the integrity of the standard Sugar functionality when we upgrade a customer instance and limit any negative impact our upgrade has on the customer's modifications. All instances hosted on Sugar's cloud service have package scanner enabled by default. This setting is not configurable and all packages must pass the package scan for installation on Sugar's cloud environment. This includes passing all health checks.Module Loader Restriction AlternativesThis article provides workarounds for commonly used functions that are denylisted by Sugar for Sugar's cloud environment.Sugar Exchange Package GuidelinesSugar Module Loadable Package development guidelines for apps listed on Sugar Exchange.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/index.html"}
{"id": "2b6d150c4a73-0", "text": "Introduction to the Manifest\nOverview\nModule loadable packages rely on a manifest.php file to define the basic properties and installation steps for the package. This documentation\u00c2\u00a0explains the various components that make up the manifest file.\nNote: Sugar Sell Essentials customers do not have the ability to upload custom file packages to Sugar using Module Loader.\nManifest Definitions\nInside of the manifest.php file, there is a $manifest variable that defines the basic properties of the module loadable package. The various manifest properties are outlined below:\nName\nType\nDisplayed in Module Loader\nDescription\nkey\nString\nNo\nA unique identifier for the package$manifest['key'] = '32837';\nname\nString\nYes\nThe name of the package$manifest['name'] = 'Example Package';\ndescription\nString\nYes\nThe description of the package$manifest['description'] = 'Example Package Description';\nbuilt_in_version\nString\nNo\nThe version of Sugar that the package was designed for$manifest['built_in_version'] = '13.0.0';\nNote: Some packages designed for 6.x versions of Sugar are not compatible with 13.0 and should not be installed.\nversion\nString\nYes\nThe version of the package, i.e. \"1.0.0\" $manifest['version'] = '1.0.0';\nNote:\u00c2\u00a0The version string should be formatting according to\u00c2\u00a0 the\u00c2\u00a0Semantic Versioning 2.0\u00c2\u00a0standard.\nacceptable_sugar_versions\nArray\nNo\nThe Sugar versions that a package can be installed to$manifest['acceptable_sugar_versions'] = array(\n    'exact_matches' => array(\n        '13.0.0',\n    ),\n    //or\n    'regex_matches' => array(\n        '13.0.*',\n    ),\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Introduction_to_the_Manifest/index.html"}
{"id": "2b6d150c4a73-1", "text": "'13.0.*',\n    ),\n);\nNote: You can define exact versions and/or use a regex formula to define a range. Exact versions will be specified using the exact_matches index and will contain an array of exact version strings (i.e. '13.0.0'). Regex formulas will be specified using the regex_matches index and will contain an array of regular expressions designed to match a group of versions (i.e. '13.0.*').\nacceptable_sugar_flavors\nArray\nNo\nThe Sugar products that the package can be installed to$manifest['acceptable_sugar_flavors'] = array(\n    'PRO',\n    'ENT',\n    'ULT'\n); \nauthor\nString\nNo\nThe author of the package (i.e. \"SugarCRM\")$manifest['author'] = 'SugarCRM';\nreadme\nString\nNo\nThe optional path to a readme document to be displayed to the user during installation $manifest['readme'] = 'README.txt';\nicon\nString\nNo\nThe optional path (within the package ZIP file) to an icon image to be displayed during installation (e.g. ./patch_directory/icon.gif and ./patch_directory/images/theme.gif)$manifest['icon'] = '';\nis_uninstallable\nBoolean\nNo\nWhether or not the package can be uninstalledAcceptable values:\n'true' will allow a Sugar administrator to uninstall the package\n'false' will disable the uninstall feature\n$manifest['is_uninstallable'] = true;\npublished_date\nString\nNo\nThe date the package was published$manifest['published_date'] = '2018-04-09 00:00:00';\nremove_tables\nString\nNo", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Introduction_to_the_Manifest/index.html"}
{"id": "2b6d150c4a73-2", "text": "remove_tables\nString\nNo\nWhether or not tables generated by the $installdefs['beans'] index should be removed from an installed module (acceptable values: empty or 'prompt')$manifest['remove_tables'] = 'prompt';\ntype\nString\nNo\nAcceptable 'type' values:module : Use this type if you are installing a module or developing a plugin that should install via the Module Loader.\nlangpack : Use this type to install a language pack via the Module Loader. Any languages installed will automatically be added to the available languages on the Sugar login screen. For an example of a module loadable language pack, refer to the Language Framework page.\ntheme : Use this type to install a Sugar theme via the Upgrade Wizard. Themes are only supported in Sugar 6.x, and will be added to the \"Theme\" drop-down on the Sugar Login screen.\npatch : Use this type to install a patch via the Upgrade Wizard.\ndependencies\nArray\nNo\nRequired dependency packages:\n$manifest['dependencies'] = array(\n    array(\n        'id_name' => 'PackageName',\n        'version' => '1.0.0'\n    )\n);\nuninstall_before_upgrade\nBoolean\nNo\nThis will allow Module Loader to ensure all traces of previously installed package versions (including packages that have been upgraded multiple times) have been removed.\n$manifest['uninstall_before_upgrade'] = true;\nManifest Example\nAn example of a manifest is shown below:\n$manifest = array(\n  'key' => 1397052912,\n  'name' => 'My manifest',\n  'description' => 'My description',\n  'author' => 'SugarCRM',\n  'version' => '1.0.0',\n  'is_uninstallable' => true,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Introduction_to_the_Manifest/index.html"}
{"id": "2b6d150c4a73-3", "text": "'is_uninstallable' => true,\n  'published_date' => '04/07/2023 14:15:12',\n  'type' => 'module',\n  'acceptable_sugar_versions' => \n  array(\n    'exact_matches' => array(\n        '13.0.0'\n    ),\n    //or\n    'regex_matches' => array(\n        '13.0.*' //any 13.0 release\n    ),\n  ),\n  'acceptable_sugar_flavors' => \n  array(\n    'PRO', \n    'ENT', \n    'ULT'\n  ),\n  'readme' => '',\n  'icon' => '',\n  'remove_tables' => '',\n  'uninstall_before_upgrade' => false,\n);\nInstallation Definitions\nThe following section outlines the indexes specified in the $installdefs array contained in the ./manifest.php file. The $installdefs array indexes are used by the Module Loader to determine the actual installation steps that need to be taken to install the package.\n$installdef Actions\nName\nType\nDescription\naction_file_map\nArray\u00c2\u00a0\nActionFileMap\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\naction_remap\n\u00c2\u00a0Array\nActionReMap\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\naction_view_map\n\u00c2\u00a0Array\nActionViewMap\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\nadministration\n\u00c2\u00a0Array\nAdministration\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\nappscheduledefs\n\u00c2\u00a0Array", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Introduction_to_the_Manifest/index.html"}
{"id": "2b6d150c4a73-4", "text": "appscheduledefs\n\u00c2\u00a0Array\nApplication ScheduledTasks\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\nbeans\n\u00c2\u00a0Array\nModules\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\nconnectors\nArray\nAn array containing Connector definitions as outlined in the Connector documentation.\n$installdefs['connectors'] = array (\n     array (\n         'connector' => '<basepath>/example/source',\n         'formatter' => '<basepath>/example/formatter',\n         'name' => 'ext_rest_example',\n     ),\n);\ncopy\nArray\nAn array detailing the files and folders to be copied to SugarRequired parameters for each file in the array:\nfrom (string) : The location of the file in the module loadable package$installdefs['copy'][0]['from'] = '<basepath>/Files/custom/modules/Accounts/accounts_save.php';\nto (string) : The destination directory relative to the Sugar root$installdefs['copy'][0]['to'] = 'custom/modules/Accounts/accounts_save.php';\nExample:\n$installdefs['copy'] = array(\n    array(\n        'from' => '<basepath>/Files/custom/modules/Accounts/accounts_save.php',\n        'to' => 'custom/modules/Accounts/accounts_save.php',\n    ),\n);\ncsp\nArray\nCSP directives needed for proper operation of the package should be represented as an associative arraywhere keys are directive names and values are corresponding trusted sources.Example:\n  $installdefs = array(\n          ...\n          'csp' => [\n             'default-src' => '*.trusted.com example.com',\n             'img-src' => 'http: https:'\n             ...\n         ]\n         ...\n     );", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Introduction_to_the_Manifest/index.html"}
{"id": "2b6d150c4a73-5", "text": "...\n         ]\n         ...\n     );\nThis parameter takes a space-delimited string of domains - just like the admin module. Setting the value of the default-src via MLP is an append operation. The values you put into the csp parameter of your manifest will be added to the CSP list in the admin module. Note that uninstall DOES NOT remove a value.\ncustom_fields\nArray\nAn array of custom fields to be installed for the new moduleRequired sub-directives for each custom field formatted as:\n$installdefs['custom_fields'][0]['<attribute>'] = <value>;\nname (String) : The internal name of the custom fieldNote: The suffix \"_c\" is appended to all custom field names (e.g. fieldname_c).\nlabel (String) : The display label for the custom field\ntype (String) : The type of custom field (e.g. varchar, text, textarea, double, float, int, date, bool, enum, relate)\nmax_size (Integer) : The custom field's maximum character storage size\nrequire_option (String) : Defines whether fields are 'required' or 'optional'\ndefault_value (String) : The default value for the custom field\next1 (String) : Used to specify a drop-down name for enum and multienum type fields\next2 (String) : Not used\next3 (String) : Not used\naudited (Boolean) : Denotes whether or not the custom field should be audited\nmodule (String) : The module where the custom field will be added\nExample:\n$installdefs['custom_fields'] = array((\n    array((\n        'name' => 'text_c',\n        'label' => 'LBL_TEXT_C',\n        'type' => 'varchar',\n        'max_size' => 255,\n        'require_option' => 'optional',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Introduction_to_the_Manifest/index.html"}
{"id": "2b6d150c4a73-6", "text": "'max_size' => 255,\n        'require_option' => 'optional',\n        'default_value' => '',\n        'ext1' => '',\n        'ext2' => '',\n        'ext3' => '',\n        'audited' => true,\n        'module' => 'Accounts',\n    ),\n);\nconsole\nArray\nConsole\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\ndashlets\nArray\nAn array containing the Dashlet definition.\nRequired parameters for each file in the array:\nname\u00c2\u00a0(string) : The name of the dashlet. Used for the folder name where the Dashlet files will be stored in Sugar file system.\nfrom\u00c2\u00a0(string) : The location of the dashlet files in the module loadable package.\n$installdefs['dashlets'] = array(\n\tarray(               \n\t\t'name' => 'MyDashlet',\n\t\t'from' => '<basepath>/MyDashlet'\n\t)\n);\ndependencies\n\u00c2\u00a0Array\nDependencies\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\nentrypoints\n\u00c2\u00a0Array\nEntryPointRegistry\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\nextensions\n\u00c2\u00a0Array\nExtensions\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\nfile_access\n\u00c2\u00a0Array\nFileAccessControlMap\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\nhookdefs\n\u00c2\u00a0Array\nLogicHooks\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\nid\nString", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Introduction_to_the_Manifest/index.html"}
{"id": "2b6d150c4a73-7", "text": "id\nString\nA unique id for the installdef definition$installdefs['id'] = 'unique_name';\nimage_dir\nString\nThe directory that contains the icons for the module$installdefs['image_dir'] = '<basepath>/icons';\njsgroups\n\u00c2\u00a0Array\nJSGroupings\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\nlanguage\n\u00c2\u00a0Array\nLanguage\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\nlayoutdefs\n\u00c2\u00a0Array\nLayoutdefs\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\nlayoutfields\nArray\nAn array of custom fields to be added to the edit and detail views of the target modules' existing layouts\nlogic_hooks\n\u00c2\u00a0Array\n\u00c2\u00a0An array containing full logic Hook definitions, as outlined in the LogicHook documentation.\n$installdefs['logic_hooks'] = array(\n      array(\n          'module' => 'Accounts',\n          'hook' => 'before_save',\n          'order' => 99,\n          'description' => 'Example Logic Hook - Logs account name',\n          'file' => 'custom/modules/Accounts/accounts_save.php',\n          'class' => 'Accounts_Save',\n          'function' => 'before_save',\n      ),\n);\nLogicHooks defined for install using the $installdefs['logic_hooks'] index, will be added to the module or application folder in the custom directory, in the logic_hooks.php file. Examples:\n./custom/modules/Accounts/logic_hooks.php\n./custom/application/logic_hooks.php\nNote: You will still need to utilize a $installdefs['copy'] index\u00c2\u00a0to move the LogicHook class file into the system.\nplatforms\nArray", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Introduction_to_the_Manifest/index.html"}
{"id": "2b6d150c4a73-8", "text": "platforms\nArray\nPlatforms is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\npre_execute\nArray\nExecutes logic from a file (or set of files) before a package is installedExample:$installdefs['pre_execute'] = array( \n    '<basepath>/pre_execute.php',\n);\nWhere the content of <basepath>/pre_execute.php is:\n<?php\n//pre_execute logic\necho 'pre_execute script<br>';\npost_execute\nArray\nExecutes logic from a file (or set of files) after a package is installedExample:$installdefs['post_execute'] = array(\n    '<basepath>/post_execute.php',\n);\nWhere the content of <basepath>/post_execute.php is:<?php\n//post_execute logic\necho 'post_execute script<br>';\npre_uninstall\nArray\nExecutes logic from a file (or set of files) before a package is uninstalledExample:$installdefs['pre_uninstall'] = array(\n    '<basepath>/pre_uninstall.php',\n);\nWhere the content of <basepath>/pre_uninstall.php is:<?php\n//pre_uninstall logic\necho 'pre_uninstall script<br>';\npost_uninstall\nArray\nExecutes logic from a file (or set of files) after a package is uninstalled Example:$installdefs['post_uninstall'] = array(\n    '<basepath>/post_uninstall.php'\n);\nWhere the content of <basepath>/post_uninstall.php is:<?php\n//post_uninstall logic\necho 'post_uninstall script<br>'; \nrelationships\nArray\nAn array of relationship files used to link the new modules to existing modulesNote: A metadata path must be defined using meta_data (string):\n$installdefs['relationships'][0]['meta_data'] =", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Introduction_to_the_Manifest/index.html"}
{"id": "2b6d150c4a73-9", "text": "$installdefs['relationships'][0]['meta_data'] = \n'<basepath>/SugarModules/relationships/relationships/my_module_accountsMetaData.php';\nWhere the content of my_module_accountsMetaData.php is:<?php\n$dictionary['my_module_accounts'] = array (\n    'true_relationship_type' => 'many-to-many',\n    'relationships' =>\n        array((\n            'my_module_accounts' =>\n                array((\n                    'lhs_module' => 'my_Module',\n                    'lhs_table' => 'my_module',\n                    'lhs_key' => 'id',\n                    'rhs_module' => 'Accounts',\n                    'rhs_table' => 'accounts',\n                    'rhs_key' => 'id',\n                    'relationship_type' => 'many-to-many',\n                    'join_table' => 'my_module_accounts_c',\n                    'join_key_lhs' => 'my_module_accountsmy_module_ida',\n                    'join_key_rhs' => 'my_module_accountsaccounts_idb',\n                ),\n        ),\n    'table' => 'my_module_accounts_c',\n    'fields' =>\n        array((\n            0 =>\n                array((\n                    'name' => 'id',\n                    'type' => 'varchar',\n                    'len' => 36,\n                ),\n            1 =>\n                array((\n                    'name' => 'date_modified',\n                    'type' => 'datetime',\n                ),\n            2 =>\n                array((\n                    'name' => 'deleted',\n                    'type' => 'bool',\n                    'len' => '1',\n                    'default' => '0',\n                    'required' => true,\n                ),\n            3 =>\n                array((\n                    'name' => 'my_module_accountsmy_module_ida',\n                    'type' => 'varchar',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Introduction_to_the_Manifest/index.html"}
{"id": "2b6d150c4a73-10", "text": "'type' => 'varchar',\n                    'len' => 36,\n                ),\n            4 =>\n                array((\n                    'name' => 'my_module_accountsaccounts_idb',\n                    'type' => 'varchar',\n                    'len' => 36,\n                ),\n        ),\n    'indices' =>\n        array((\n            0 =>\n                array((\n                    'name' => 'my_module_accountsspk',\n                    'type' => 'primary',\n                    'fields' =>\n                        array((\n                            0 => 'id',\n                        ),\n                ),\n            1 =>\n                array((\n                    'name' => 'my_module_accounts_alt',\n                    'type' => 'alternate_key',\n                    'fields' =>\n                        array((\n                            0 => 'my_module_accountsmy_module_ida',\n                            1 => 'my_module_accountsaccounts_idb',\n                        ),\n                ),\n        ),\n);\nscheduledefs\n\u00c2\u00a0Array\nScheduledTasks\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\nsidecar\n\u00c2\u00a0Array\nSidecar\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\ntinymce\n\u00c2\u00a0Array\nTinyMCE\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\nuser_page\n\u00c2\u00a0Array\nUserPage\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\nutils\n\u00c2\u00a0Array\nUtils\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\nvardefs\n\u00c2\u00a0Array", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Introduction_to_the_Manifest/index.html"}
{"id": "2b6d150c4a73-11", "text": "vardefs\n\u00c2\u00a0Array\nVardefs\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\nwireless_modules\n\u00c2\u00a0Array\nWirelessModuleRegistery\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\nwireless_subpanels\n\u00c2\u00a0Array\nWirelessLayoutDefs\u00c2\u00a0is part of the Extension Framework. More detail can be found in the\u00c2\u00a0Extension Framework documentation.\nNote: Anything printed to the screen in the pre_execute, post_execute, pre_uninstall, or post_uninstall scripts will be displayed when clicking on the Display Log link.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Introduction_to_the_Manifest/index.html"}
{"id": "dd08eb070943-0", "text": "Module Loader Restrictions\nOverview\nSugarCRM's hosting objective is to maintain the integrity of the standard Sugar functionality when we upgrade a customer instance\u00c2\u00a0and limit any negative impact our upgrade has on the customer's modifications. All instances hosted on Sugar's cloud service have package scanner enabled by default. This setting is not configurable and all packages must pass the package scan for installation on Sugar's cloud environment. This includes passing all health checks.\nNote: Sugar Sell Essentials customers do not have the ability to upload custom file packages to Sugar using Module Loader.\nAccess Controls\nThe Module Loader includes a Module Scanner, which grants system administrators the control they need to determine the precise set of actions that they are willing to offer in their hosting environment. This feature is available in all Sugar products. Anyone who is hosting Sugar products can take advantage of this feature, as well.\nEnabling Package Scan\nScanning is disabled in default installations of Sugar\u00c2\u00a0and can be enabled through a configuration setting. This setting is added to ./config.php or ./config_override.php, and is not available to Administrator users to modify through the Sugar interface. Please note that this setting can only be managed on an on-site deployment and cannot be disabled for Sugar's cloud environment.\nTo enable Package Scan and its associated scans, add this setting to ./config_override.php:\n$sugar_config['moduleInstaller']['packageScan'] = true;\nThere are two categories of access control in the Package Scan:\nFile Scan\nModule Loader Actions\nEnabling File Scan\nBy enabling Package Scan, File Scan will be performed on all files in the package uploaded through Module Loader. File Scan will be performed when a Sugar administrator attempts to install the package. Please note that these settings can only be managed on an on-site deployment. These settings are not permitted to be modified when hosted on Sugar's cloud service.\nFile Scan performs three checks:\nFile extensions must be in the approved list of valid extension types.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Module_Loader_Restrictions/index.html"}
{"id": "dd08eb070943-1", "text": "File extensions must be in the approved list of valid extension types.\nFiles must\u00c2\u00a0not contain any\u00c2\u00a0suspicious classes.\nFiles must not contain any suspicious function calls.\nPlease refer to the next three sections which outline the default requirements for the File Scan checks.\u00c2\u00a0\nValid Extension Types\nFile extensions must be in the approved list of valid extension types. The following extension types are valid by default:\ncss\ngif\nhbs\nhtm\nhtml\njpg\njs\nmd5\npdf\nphp\npng\ntpl\ntxt\nxml\nDenylisted Classes\nFiles must not contain any of the following classes that are considered suspicious by File Scan.\u00c2\u00a0\nAll variable classes (i.e., $class())\u00c2\u00a0are prohibited by default.\nThe following classes are denylisted by default:\nlua\npclzip\nreflection\nreflectionclass\nreflectionexception\nreflectionextension\nreflectionfunction\nreflectionfunctionabstract\nreflectionmethod\nreflectionobject\nreflectionparameter\nreflectionproperty\nreflectionzendextension\nreflector\nsplfileinfo\nsplfileobject\nziparchive\nDenylisted Function Calls\nFiles must\u00c2\u00a0not contain any of the following function calls that are considered suspicious by File Scan.\nVariable functions (i.e., $func()) are prohibited by default.\nBackticks (`) are prohibited by File Scan.\nThe following PHP functions are denylisted by default:\naddfunction\naddserver\narray_diff_uassoc\narray_diff_ukey\narray_filter\narray_intersect_uassoc\narray_intersect_ukey\narray_map\narray_reduce\narray_udiff\narray_udiff_assoc\narray_udiff_uassoc\narray_uintersect\narray_uintersect_assoc\narray_uintersect_uassoc\narray_walk\narray_walk_recursive\ncall_user_func\ncall_user_func\ncall_user_func_array\ncall_user_func_array\nchdir\nchgrp\nchmod\nchroot\nchwown\nclearstatcache\nconstruct\nconsume", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Module_Loader_Restrictions/index.html"}
{"id": "dd08eb070943-2", "text": "chgrp\nchmod\nchroot\nchwown\nclearstatcache\nconstruct\nconsume\nconsumerhandler\ncopy\ncopy_recursive\ncreate_cache_directory\ncreate_custom_directory\ncreate_function\ncurl_copy_handle\ncurl_exec\ncurl_file_create\ncurl_init\ncurl_multi_add_handle\ncurl_multi_exec\ncurl_multi_getcontent\ncurl_multi_info_read\ncurl_multi_init\ncurl_multi_remove_handle\ncurl_multi_select\ncurl_multi_setopt\ncurl_setopt_array\ncurl_setopt\ncurl_share_init\ncurl_share_setopt\ncurl_share_strerror\ndir\ndisk_free_space\ndisk_total_space\ndiskfreespace\neio_busy\neio_chmod\neio_chown\neio_close\neio_custom\neio_dup2\neio_fallocate\neio_fchmod\neio_fchown\neio_fdatasync\neio_fstat\neio_fstatvfs\neio_fsync\neio_ftruncate\neio_futime\neio_grp\neio_link\neio_lstat\neio_mkdir\neio_mknod\neio_nop\neio_open\neio_read\neio_readahead\neio_readdir\neio_readlink\neio_realpath\neio_rename\neio_rmdir\neio_sendfile\neio_stat\neio_statvfs\neio_symlink\neio_sync\neio_sync_file_range\neio_syncfs\neio_truncate\neio_unlink\neio_utime\neio_write\nerror_log\nescapeshellarg\nescapeshellcmd\neval\nexec\nfclose\nfdf_enum_values\nfeof\nfflush\nfgetc\nfgetcsv\nfgets\nfgetss\nfile\nfile_exists\nfile_get_contents\nfile_put_contents\nfileatime\nfilectime\nfilegroup\nfileinode\nfilemtime\nfileowner\nfileperms\nfilesize\nfiletype", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Module_Loader_Restrictions/index.html"}
{"id": "dd08eb070943-3", "text": "filegroup\nfileinode\nfilemtime\nfileowner\nfileperms\nfilesize\nfiletype\nflock\nfnmatch\nfopen\nforward_static_call\nforward_static_call_array\nfpassthru\nfputcsv\nfputs\nfread\nfscanf\nfseek\nfstat\nftell\nftruncate\nfwrite\nget\ngetbykey\ngetdelayed\ngetdelayedbykey\ngetfunctionvalue\ngetimagesize\nglob\nheader_register_callback\nibase_set_event_handler\nini_set\nis_callable\nis_dir\nis_executable\nis_file\nis_link\nis_readable\nis_uploaded_file\nis_writable\nis_writeable\niterator_apply\nlchgrp\nlchown\nldap_set_rebind_proc\nlibxml_set_external_entity_loader\nlink\nlinkinfo\nlstat\nmailparse_msg_extract_part\nmailparse_msg_extract_part_file\nmailparse_msg_extract_whole_part_file\nmk_temp_dir\nmkdir\nmkdir_recursive\nmove_uploaded_file\nnewt_entry_set_filter\nnewt_set_suspend_callback\nob_start\nopen\nopendir\nparse_ini_file\nparse_ini_string\npassthru\npassthru\npathinfo\npclose\npcntl_signal\npopen\npreg_replace_callback\nproc_close\nproc_get_status\nproc_nice\nproc_open\nreaddir\nreadfile\nreadline_callback_handler_install\nreadline_completion_function\nreadlink\nrealpath\nrealpath_cache_get\nrealpath_cache_size\nregister_shutdown_function\nregister_tick_function\nrename\nrewind\nrmdir\nrmdir_recursive\nsession_set_save_handler\nset_error_handler\nset_exception_handler\nset_file_buffer\nset_local_infile_handler\nset_time_limit\nsetclientcallback\nsetcompletecallback\nsetdatacallback\nsetexceptioncallback\nsetfailcallback\nsetserverparams\nsetstatuscallback\nsetwarningcallback\nsetworkloadcallback\nshell_exec\nsimplexml_load_file", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Module_Loader_Restrictions/index.html"}
{"id": "dd08eb070943-4", "text": "setwarningcallback\nsetworkloadcallback\nshell_exec\nsimplexml_load_file\nsimplexml_load_string\nsocket_accept\nsocket_addrinfo_bind\nsocket_addrinfo_connect\nsocket_addrinfo_explain\nsocket_addrinfo_lookup\nsocket_bind\nsocket_clear_error\nsocket_close\nsocket_cmsg_space\nsocket_connect\nsocket_create_listen\nsocket_create_pair\nsocket_create\nsocket_export_stream\nsocket_get_option\nsocket_getopt\nsocket_getpeername\nsocket_getsockname\nsocket_import_stream\nsocket_last_error\nsocket_listen\nsocket_read\nsocket_recv\nsocket_recvfrom\nsocket_recvmsg\nsocket_select\nsocket_send\nsocket_sendmsg\nsocket_sendto\nsocket_set_block\nsocket_set_nonblock\nsocket_set_option\nsocket_setopt\nsocket_shutdown\nsocket_write\nfsockopen\nspl_autoload_register\nsqlite_create_aggregate\nsqlite_create_function\nsqlitecreateaggregate\nsqlitecreatefunction\nstat\nstream_bucket_append\nstream_bucket_make_writeable\nstream_bucket_new\nstream_bucket_prepend\nstream_context_create\nstream_context_get_default\nstream_context_get_options\nstream_context_get_params\nstream_context_set_default\nstream_context_set_option\nstream_context_set_params\nstream_copy_to_stream\nstream_filter_append\nstream_filter_prepend\nstream_filter_register\nstream_filter_remove\nstream_get_contents\nstream_get_filters\nstream_get_line\nstream_get_meta_data\nstream_get_transports\nstream_get_wrappers\nstream_is_local\nstream_isatty\nstream_notification_callback\nstream_register_wrapper\nstream_resolve_include_path\nstream_select\nstream_set_blocking\nstream_set_chunk_size\nstream_set_read_buffer\nstream_set_timeout\nstream_set_write_buffer\nstream_socket_accept\nstream_socket_client\nstream_socket_enable_crypto\nstream_socket_get_name\nstream_socket_pair\nstream_socket_recvfrom\nstream_socket_sendto\nstream_socket_server\nstream_socket_shutdown\nstream_supports_lock\nstream_wrapper_register\nstream_wrapper_restore\nstream_wrapper_unregister\nsugar_chgrp", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Module_Loader_Restrictions/index.html"}
{"id": "dd08eb070943-5", "text": "stream_wrapper_register\nstream_wrapper_restore\nstream_wrapper_unregister\nsugar_chgrp\nsugar_chmod\nsugar_chown\nsugar_file_put_contents\nsugar_file_put_contents_atomic\nsugar_fopen\nsugar_mkdir\nsugar_rename\nsugar_touch\nsybase_set_message_handler\nsymlink\nsystem\ntempnam\ntimestampnoncehandler\ntmpfile\ntokenhandler\ntouch\nuasort\nuksort\numask\nunlink\nunzip\nunzip_file\nusort\nwrite_array_to_file\nwrite_array_to_file_as_key_value_pair\nwrite_encoded_file\nxml_set_character_data_handler\nxml_set_default_handler\nxml_set_element_handler\nxml_set_end_namespace_decl_handler\nxml_set_external_entity_ref_handler\nxml_set_notation_decl_handler\nxml_set_processing_instruction_handler\nxml_set_start_namespace_decl_handler\nxml_set_unparsed_entity_decl_handler\nThe following class functions are denylisted by default:\nAll variable functions (i.e., $func()) are prohibited by default.\u00c2\u00a0\nSugarLogger::setLevel\nSugarAutoLoader::put\nSugarAutoLoader::unlink\nHealth Check\nPackages must pass all health checks in order to pass through the package scanner. For more information on troubleshooting Health Check output, see the collection of help articles in\u00c2\u00a0Troubleshooting Health Check Output.\nDisabling File Scan\nNote: Disabling File Scan is prohibited\u00c2\u00a0for instances on Sugar's cloud service.\nTo disable File Scan, add the following configuration setting to config_override.php:\n$sugar_config['moduleInstaller']['disableFileScan'] = false;\nExtending the List of Valid Extension Types\nNote: Modifying the valid extensions list\u00c2\u00a0is prohibited\u00c2\u00a0for instances on Sugar's cloud service.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Module_Loader_Restrictions/index.html"}
{"id": "dd08eb070943-6", "text": "To add more file extensions to the approved list of valid extension types, add the file extensions to the validExt array. The example below adds a .log file extension and .htaccess to the valid extension type list in config_override.php:\n$sugar_config['moduleInstaller']['validExt'] = array(\n    'log', \n    'htaccess'\n);\nDenylisting Additional Function Calls\nNote: Denylist modifications are prohibited\u00c2\u00a0for instances on Sugar's cloud service.\nTo add additional function calls to the denylist, add the function calls to the blackList array. The example below blocks the strlen() and strtolower() functions from being included in the package:\n$sugar_config['moduleInstaller']['blackList'] = array(\n    'strlen', \n    'strtolower'\n);\nOverriding Denylisted Function Calls\nNote: Denylist modifications are prohibited\u00c2\u00a0for instances on Sugar's cloud service.\nTo override the denylist and allow a specific function to be included in packages, add the function call to the blackListExempt array. The example below removes the restriction for the file_put_contents() function, allowing it to be included in the package:\n$sugar_config['moduleInstaller']['blackListExempt'] = array(\n    'file_put_contents'\n);\nDisabling Restricted Copy\nTo ensure upgrade-safe customizations, System Administrators must\u00c2\u00a0restrict the copy action to prevent modifying the existing Sugar source code files. New files may be added anywhere (to allow new modules to be added), but core Sugar source code files must not be overwritten. This is enabled by default when you enable Package Scan.\nNote: Disabling Restricted Copy is prohibited for instances on Sugar's cloud service.\nTo disable Restricted Copy, use this configuration setting:\n$sugar_config['moduleInstaller']['disableRestrictedCopy'] = true;\nModule Loader Actions", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Module_Loader_Restrictions/index.html"}
{"id": "dd08eb070943-7", "text": "$sugar_config['moduleInstaller']['disableRestrictedCopy'] = true;\nModule Loader Actions\nModule loader actions, defined in ./ModuleInstall/ModuleScanner.php, are identifiers that map to the installation definitions used in the $installdefs of a manifest.\nAction\n$installdef\u00c2\u00a0Actions\nDescription\ninstall_administration\nadministration\nInstalls an administration section into the Admin page\ninstall_connectors\nconnectors\nInstalls SugarCloud Connectors\ninstall_copy\ncopy\nInstalls\u00c2\u00a0files or directories\ninstall_dashlets\ndashlets\nInstalls dashlets into the Sugar application\ninstall_images\nimage_dir\nInstall images into the custom directory\ninstall_languages\nlanguage\nInstalls language files\ninstall_layoutdefs\nlayoutdefs\nInstalls\u00c2\u00a0layouts\ninstall_layoutfields\nlayoutfields\nInstalls custom fields\ninstall_logichooks\nlogic_hooks\nInstalls logic hooks\ninstall_relationships\nrelationships\nInstalls relationships\ninstall_userpage\nuser_page\nInstalls\u00c2\u00a0a section to the User record page\ninstall_vardefs\nvardefs\nInstalls\u00c2\u00a0vardefs\npost_execute\npost_execute\nCalled after a package is installed\npre_execute\npre_execute\nCalled before a package is installed\nDisabling Module Loader Actions\nCertain Module Loader actions may be considered less desirable than others by a System Administrator. A System Administrator may want to allow some Module Loader actions, but disable specific actions that could impact the upgrade-safe integrity of the Sugar instance.\nNote: Disabling Module Loader actions\u00c2\u00a0is prohibited\u00c2\u00a0for instances on Sugar's cloud service.\nBy default, all Module Loader actions are allowed. Enabling Package Scan does not affect the Module Loader actions. To disable specific Module Loader actions, add the action to the disableActions array. The example below restricts the pre_execute and post_execute actions:\n$sugar_config['moduleInstaller']['disableActions'] = array(\n    'pre_execute',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Module_Loader_Restrictions/index.html"}
{"id": "dd08eb070943-8", "text": "'pre_execute', \n    'post_execute'\n);\nDisabling Upgrade Wizard\nIf you are hosting Sugar and wish to lock down the upgrade wizard, you can set disable_uw_upload to 'true' in the config_override. This is intended for hosting providers to prevent unwanted upgrades.\n$sugar_config['disable_uw_upload'] = true;\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Module_Loader_Restrictions/index.html"}
{"id": "0a316758f61e-0", "text": "Module Loader Restriction Alternatives\nOverview\nThis article provides workarounds for commonly used functions that are denylisted by Sugar for\u00c2\u00a0Sugar's cloud environment.\nDenylisted Functions\n$variable()\nVariable functions are\u00c2\u00a0sometimes used when trying to dynamically call a function. This is commonly used to retrieve a new bean object.\nRestricted use:\n$module = \"Account\";\n$id = \"6468238c-da75-fd9a-406b-50199fe6b5f8\";\n//creating a new bean\n$focus = new $module()\n//retrieving a specific record\n$focus->retrieve($id);\nAs of 6.3.0, we have implemented newBean and getBean which can be found in the BeanFactory. Below is the recommended approach to create or fetch a bean:\n$module = \"Accounts\";\n$id = \"6468238c-da75-fd9a-406b-50199fe6b5f8\";\n//creating a new bean\n$focus = BeanFactory::newBean($module);\n//or creating a new bean and retrieving a specific record\n$focus = BeanFactory::getBean($module, $id);\narray_filter()\nThe array_filter filters elements of an array using a callback function. It\u00c2\u00a0is restricted from use on Sugar's cloud service due to its ability to call other\u00c2\u00a0restricted functions.\nRestricted use:\n/**\n * Returns whether the input integer is odd\n * @param $var\n * @return int\n */\nfunction odd($var) {\n    return($var & 1);\n}\n$myArray = array(\n    \"a\"=>1,\n    \"b\"=>2,\n    \"c\"=>3,\n    \"d\"=>4,\n    \"e\"=>5\n);\n$filteredArray = array_filter($myArray, \"odd\");", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Module_Loader_Restriction_Alternatives/index.html"}
{"id": "0a316758f61e-1", "text": ");\n$filteredArray = array_filter($myArray, \"odd\");\nAn alternative to using array_filter\u00c2\u00a0is to use a foreach loop.\n$filteredArray = array();\n$myArray = array(\n    \"a\"=>1,\n    \"b\"=>2,\n    \"c\"=>3,\n    \"d\"=>4,\n    \"e\"=>5\n);\nforeach ($myArray as $key => $value) {\n    // check whether the input integer is odd\n    if($value & 1) {\n        $filteredArray[$key] = $value; \n    }\n}\ncopy()\nThe copy\u00c2\u00a0method is sometimes used by developers when duplicating files in the uploads directory.\nRestricted use:\n$result = copy($oldFile, $newFile);\n\u00c2\u00a0An alternative to using copy\u00c2\u00a0is the\u00c2\u00a0duplicate_file\u00c2\u00a0method found in the\u00c2\u00a0UploadFile\u00c2\u00a0class.\nrequire_once 'include/upload_file.php';\n$uploadFile = new UploadFile();\n$result = $uploadFile->duplicate_file($oldFileId, $newFileId);\nfile_exists()\nThe file_exists method is used by developers to determine if a file exists.\nRestricted use:\nif(file_exists($file_path)) {\n    require_once($file);\n}\nAn alternative to using file_exists is the\u00c2\u00a0fileExists\u00c2\u00a0method found in the SugarAutoLoader\u00c2\u00a0class.\n$file = 'include/utils.php';\nif (SugarAutoloader::fileExists($file)) {\n    require_once($file);\n}\nfile_get_contents()\nThe file_get_contents method is used to retrieve the contents of a file.\nRestricted use:\n$file_contents = file_get_contents('file.txt');", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Module_Loader_Restriction_Alternatives/index.html"}
{"id": "0a316758f61e-2", "text": "Restricted use:\n$file_contents = file_get_contents('file.txt');\nAn alternative to using file_get_contents and sugar_file_get_contents is the\u00c2\u00a0get_file_contents\u00c2\u00a0method found in the UploadFile class.\nrequire_once('include/upload_file.php');\n$uploadFile = new UploadFile();\n//get the file location\n$uploadFile->temp_file_location = UploadFile::get_upload_path($file_id);\n$file_contents = $uploadFile->get_file_contents();\nfwrite()\nThe fwrite method is a function used to write content to a file. As there isn't currently a direct alternative for this function, you may find one of the following a good solution to what you are trying to achieve.\nAdding/Removing Logic Hooks\nWhen working with logic hooks, it is very common for a developer to need to modify\u00c2\u00a0./custom/modules/<module>/logic_hooks.php. When creating module loadable packages, developers will sometimes use\u00c2\u00a0fwrite to modify this file upon installation to include their additional hooks. As of Sugar 6.3,\u00c2\u00a0Logic Hook Extensions\u00c2\u00a0were implemented to allow a developer to append custom hooks.\u00c2\u00a0If you would prefer to edit the logic_hooks.php file, you will need to\u00c2\u00a0use the\u00c2\u00a0check_logic_hook_file\u00c2\u00a0method as described below:\n//Adding a logic hook\nrequire_once(\"include/utils.php\");\n$my_hook = Array(\n    999,\n    'Example Logic Hook',\n    'custom/modules/<module>/my_hook.php',\n    'my_hook_class',\n    'my_hook_function'\n);\ncheck_logic_hook_file(\"Accounts\", \"before_save\", $my_hook);\nRemoving a logic hook can be done by using remove_logic_hook:\n//Removing a logic hook\nrequire_once(\"include/utils.php\");\n$my_hook = Array(\n    999,\n    'Example Logic Hook',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Module_Loader_Restriction_Alternatives/index.html"}
{"id": "0a316758f61e-3", "text": "$my_hook = Array(\n    999,\n    'Example Logic Hook',\n    'custom/modules/<module>/my_hook.php',\n    'my_hook_class',\n    'my_hook_function'\n);\nremove_logic_hook(\"Accounts\", \"before_save\", $my_hook);\ngetimagesize()\nThe getimagesize\u00c2\u00a0method is\u00c2\u00a0used to retrieve information about an image file.\nRestricted use:\n$img_size = getimagesize($path);\nIf you are looking to verify an image is .png or .jpeg, you can use the\u00c2\u00a0verify_uploaded_image\u00c2\u00a0method:\nrequire_once('include/utils.php');\nif (verify_uploaded_image($path)) {\n    //logic\n}\nIf you are looking to get the mime type of an image, you can use the\u00c2\u00a0get_file_mime_type\u00c2\u00a0method:\n$mime_type = get_file_mime_type($path);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Module_Loader_Restriction_Alternatives/index.html"}
{"id": "5d909ea5236d-0", "text": "Sugar Exchange Package Guidelines\nOverview\nThe Sugar\u00c2\u00ae platform is open and flexible. Developers can customize any feature or integrate any system with Sugar using a Sugar Module Loadable Package. This flexibility requires guidelines so that SugarExchange customers can rest assured\u00c2\u00a0that all package offerings adhere to consistent quality standards and will not interfere with existing customizations or prevent software upgrades.\nThis guide outlines the minimum standards we expect from any Sugar Developer writing code for the Sugar platform. From the development of Sugar packages to security, user interface, encapsulation, and performance considerations, SugarCRM takes the safety and integrity of the Sugar application and its community very seriously. Compliance with these guidelines is a requirement for any package installed into Sugar's cloud service. Failure to follow these guidelines is grounds for having your package removed from Sugar's cloud service and de-listed from SugarExchange.\nSugarCRM reserves the right to change these guidelines at any time. Please send any questions or feedback on these guidelines to developers@sugarcrm.com.\nBest Practices\nThese best practice guidelines have been curated\u00c2\u00a0based on years of collective experience working with Sugar Packages that get used by Sugar customers every day.\nUse a consistent coding style\nFor all PHP code, the style standard that SugarCRM uses is PSR-2. For JavaScript code, we use the applicable PSR-2 conventions as well. For JavaScript code, we emphasize readability which means we make use of utilities like Underscore.js and avoid nested callbacks. All functions, methods, classes in our code are required to have PHPDoc and JSDoc. While not all the code in the Sugar code base currently complies with these standards, we do enforce it as the standard on new code. Using a consistent code style increases the readability and maintainability of application code for those that come after you.\nInvest in unit testing during development", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Sugar_Exchange_Package_Guidelines/index.html"}
{"id": "5d909ea5236d-1", "text": "Invest in unit testing during development\nFor all JavaScript and PHP code, we strongly recommend the creation of unit tests. For PHP, we use PHPUnit and have developed a framework (to be shared) for testing Sugar server-side code using this framework. For JavaScript code, we use Jasmine and have also developed a framework (to be shared) there to bootstrap Sidecar metadata so that Jasmine tests can run without dependency on a Sugar server.\nWe recommend running unit tests frequently during the development process. We suggest developers run tests before each commit and as part of an automated continuous integration process. Running tests often means you catch failures sooner which makes them easier and cheaper to fix.\nUse Sugar REST APIs\nThe easiest way to integrate with a Sugar instance is not to install anything into Sugar at all. For Sugar 7, we have a full client REST API that is used to drive our web interface, our mobile client, and our plug-ins. If you can do it from our user interface, you can use our REST API separately to do it as well. If the REST API doesn't do everything you need it to do, it is very easily extensible. You can easily write code that adds your custom API endpoints in a minimally invasive way.\nUse Module Builder when possible\nMany integrations can be accomplished with the help of Module Builder and the Sugar REST API. Module Builder allows you to\u00c2\u00a0quickly\u00c2\u00a0design new modules for Sugar that match concepts that you want to add to a Sugar instance. These custom modules can then be installed and populated via the REST API, making it a powerful integration mechanism that doesn't require writing a line of Sugar code. Using custom modules will prevent conflicts with other customizations, as well. For more information, please refer to the Module Builder documentation.\nUse Extension framework and Dashlets for Sugar code customizations", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Sugar_Exchange_Package_Guidelines/index.html"}
{"id": "5d909ea5236d-2", "text": "Use Extension framework and Dashlets for Sugar code customizations\nThe Extension framework is the way to add server-side changes to a Sugar instance in a loosely coupled way. Dashlets are the best way to add new, custom user interface components to a Sugar instance that gives users maximum flexibility in how they use your app. These mechanisms also avoid conflicts with other customizations since Extensions are additive and do not replace core files.\nSecurity Guidelines\nProtecting and controlling access to CRM data is of paramount importance. It is important that Sugar Packages are good stewards of CRM data and access control.\nUse TLS/SSL for web services calls\nJust as we don't recommend running Sugar in production without TLS/SSL, all web-services calls that are initiated from a Sugar Package should also use SSL. The concern is the exposure of user credentials, OAuth/session tokens, or sensitive CRM data via plaintext transmission that would otherwise be handled\u00c2\u00a0securely.\nDo not hardcode sensitive information\nYou also should not hardcode any credentials, API keys, tokens, etc, within a Sugar Package. Sugar Packages and Sugar application code is never encrypted so there is always a risk that an attacker could discover these things and abuse them. Usernames and passwords, OAuth tokens, and similar credentials for accessing 3rd party systems should be stored in the database (for example, on the config table). The Sugar platform also provides encryption utilities that allow\u00c2\u00a0information to be stored in an encrypted form. These settings could then be changeable by the Administrator via the Administration panel or some other end-user input.\nUser Interface Guidelines\nSugar packages can be used to add new user interface components or front-end customizations to Sugar. It is important to consider the impact that these changes have on the user experience and the look and feel of the Sugar application.\nUse the Sugar 7 Styleguide", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Sugar_Exchange_Package_Guidelines/index.html"}
{"id": "5d909ea5236d-3", "text": "Use the Sugar 7 Styleguide\nIn Sugar 7, we have doubled down on our emphasis on creating the best possible user experience. While other applications may use different usage patterns than the ones used in Sugar 7, it is important to think about how new functionality or integrations that you build in Sugar 7 fits within the overall Sugar 7 user experience. Users do not tolerate an inconsistent experience within a given tool - it makes it harder to learn to use, which lowers adoption of Sugar as well as your application.\nWe want to make it easier for you to build applications within Sugar that use a consistent theme and user experience patterns, so we have included a styleguide for the Sugar application. You can find a link to the styleguide\u00c2\u00a0from the Sugar Administration page. There you can find all the information you need to leverage Sugar 7's styling including our CSS framework.\nDon't use incompatible UI frameworks or external CSS libraries\nMixing outside user interface frameworks into the Sugar application via a Sugar Package can easily break many different parts of the application. Please only include as much CSS as you need and make sure that it is properly formed so that it doesn't affect other parts of the Sugar application. At the very least, using different frameworks or themes within your application will create a disjointed experience for the end user. While your package may be installed into Sugar, the user experience will not be seamless.\nEncapsulation Guidelines\nAn important aspect of the quality of a Sugar Package is how well encapsulated and loosely coupled it is. A well encapsulated and loosely coupled package will encounter the fewest issues during upgrades, fewer breakages due to core code changes or due to interactions with other installed packages, as well minimizing bugs or problems that end users encounter.\nUse Extensions framework and Custom Modules as much as possible", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Sugar_Exchange_Package_Guidelines/index.html"}
{"id": "5d909ea5236d-4", "text": "Use Extensions framework and Custom Modules as much as possible\nA well-encapsulated package prefers the use of Custom Modules over customizing and repurposing existing Sugar Modules. A loosely coupled package uses Extensions framework for customizing and connecting with the core Sugar application. Only override the behavior of core Sugar application files as a last resort.\nAvoid customizations to core Sugar application files\nDevelopers are strongly discouraged from overriding core Sugar Modules or Sugar framework code. In many cases, a cleaner approach for accomplishing the same goal exists. For example, using a logic hook to extend the behavior of a SugarBean instead of overriding the SugarBean itself. Every core customization is a barrier to successful upgrades that creates recurring development costs over time. This is exacerbated in heavily customized Sugar instances as other customizations may exist on these files. Anytime there is a conflict then manual intervention by a Sugar Developer is required which is not only inconvenient but costly for everyone involved. If you do make core Sugar customizations then keeping track of such changes is very important to get in front of potential conflicts with other packages and upgrades.\nUse Package Scanner to ensure your Sugar Package is ready for SugarCloud\nSugar Packages should be designed with Sugar's cloud service in mind, as many Sugar customers choose this hosting option over hosting on-site or through a Sugar partner. Code that gets loaded into Sugar's cloud service must pass the Package Scanner utility and must not adversely impact the SugarCRM infrastructure. This stipulation is outlined in the\u00c2\u00a0SugarCloud Policy Guide. Package Scanner can be enabled on any Sugar instance via the Sugar Administration panel which allows this to be tested easily. You should also educate yourself in some alternatives to\u00c2\u00a0denylisted functions.\nPerformance Guidelines", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Sugar_Exchange_Package_Guidelines/index.html"}
{"id": "5d909ea5236d-5", "text": "Performance Guidelines\nSugar is primarily a database application however with the introduction of Sugar 7, more and more business logic is executed within the user's web browser. It is best to avoid pre-optimization and use tools to properly identify the root causes of performance issues that users could encounter.\nSugar 7 has instrumentation built into it for New Relic APM,\u00c2\u00a0which can monitor browser and server performance simultaneously, as well as XHprof for Sugar PHP profiling. Slow query logging can also be enabled via the Sugar Administration panel under System Settings. For more information, refer to the System documentation. The Sugar Engineering team typically uses Chrome DevTools for JavaScript profiling.\nIndex for large frequently used queries\nThe most common performance bottleneck for Sugar is the database. Using slow query logging makes it possible to identify bottlenecks and correct them. One way to address query bottlenecks is to extend vardefs to add indices during package install to improve the performance of those queries.\nAdd scheduled jobs to prune large database tables\nIf your Package adds database tables that can tend to grow very large over time, it is a best practice to include scheduled jobs in your package that can be used to prune the size of this database over time. For Sugar, these background tasks can be created and managed using the Job Queue framework. At the very least, you'll want to create a Custom Job that Sugar Administrators can then run as needed. This will allow the package to remain in tip-top shape for your users over time. Especially if they are running on Sugar's cloud service because direct access to the underlying SQL database to do manual tuning and cleanup is not permitted.\nEnsure your application does not block user interface during long running processes", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Sugar_Exchange_Package_Guidelines/index.html"}
{"id": "5d909ea5236d-6", "text": "Ensure your application does not block user interface during long running processes\nIf your application prevents the user from getting feedback or using the interface while it is running a long process, this will impact the perceived performance of the application. Users typically expect some UI feedback within half a second. If you have transactions that will take longer than that, it is best to use the Job Queue framework to defer them for later or move them into a scheduled Custom Job.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Module_Loader/Sugar_Exchange_Package_Guidelines/index.html"}
{"id": "8a9c81cd568f-0", "text": "TinyMCE\nOverview\nThis article demonstrates how to work with the TinyMCE rich-editor field and customize its settings.\u00c2\u00a0\nTinyMCE Field Type (htmleditable_tinymce)\nSugar provides a rich-text editor field using TinyMCE. This editor is used available when customizing templates and composing emails. As Sugar does not provide a way to create and use these field in Studio, we will demonstrate how to convert a text area field into a TinyMCE editor in the following sections.\nConverting a Text Area to a TinyMCE Editor\nAs an example, we will use the Accounts' description field. The description fields type is by default text area. First of all, you will need to change the type of the field to htmleditable_tinymce using the\u00c2\u00a0displayParams\u00c2\u00a0vardef\u00c2\u00a0key.\n$dictionary['Account']['fields']['description']['displayParams']['type'] = 'htmleditable_tinymce';\nAdditionally, having a rich-text editor will require you to have a longer database field to store the HTML content. You will need to change the dbType to longtext and its length to 4294967295.\n$dictionary['Account']['fields']['description']['dbType'] = 'longtext';\n$dictionary['Account']['fields']['description']['len'] = '4294967295';\nAfter making these changes, the vardef definition will look as follows:\n./custom/Extension/modules/Accounts/Ext/Vardefs/tinymce_description.php\n<?php\n$dictionary['Account']['fields']['description']['displayParams']['type'] = 'htmleditable_tinymce';\n$dictionary['Account']['fields']['description']['dbType'] = 'longtext';\n$dictionary['Account']['fields']['description']['len'] = '4294967295';\nLast, you will need to navigate Admin > Repairs and Perform Quick Repair and Rebuild.\u00c2", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/TinyMCE/index.html"}
{"id": "8a9c81cd568f-1", "text": "Configuring the TinyMCE Editor\nConfiguring the TinyMCE editors can be done using the\u00c2\u00a0tinyConfig vardef key. The\u00c2\u00a0tinyConfig key maps to the TinyMCE configuration options. For example, if you would add a plugin into TinyMCE editor, you would modify the\u00c2\u00a0tinyConfig.plugins\u00c2\u00a0vardef key. An example of a vardef definition that will change the accounts description field to a custom TinyMCE Editor and modify its default TinyMCE settings is shown below.\n./custom/Extension/modules/Accounts/Ext/Vardefs/tinymce_description.php\n<?php\n$dictionary['Account']['fields']['description']['displayParams']['type'] = 'htmleditable_tinymce';\n$dictionary['Account']['fields']['description']['dbType'] = 'longtext';\n$dictionary['Account']['fields']['description']['len'] = '4294967295';\n$dictionary['Account']['fields']['description']['tinyConfig'] = array(\n    'plugins' => 'paste,autoresize,visualblocks,textcolor,table,emoticons,autolink',\n    'table_default_attributes' => array(\n        'border' => '1',\n    ),\n    'target_list' => array(\n        array(\n            'title' => 'New page',\n            'value' => '_blank',\n        ),\n    ),\n    'default_link_target' => '_blank',\n    'extended_valid_elements' => \"a[href|target|data-mce-href]\",\n    'codesample_languages' => array(\n        array('text' => 'HTML/XML', 'value' => 'markup'),\n        array('text' => 'JavaScript', 'value' => 'javascript'),\n        array('text' => 'CSS', 'value' => 'css'),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/TinyMCE/index.html"}
{"id": "8a9c81cd568f-2", "text": "array('text' => 'CSS', 'value' => 'css'),\n        array('text' => 'PHP', 'value' => 'php'),\n    ),\n    'toolbar1' => 'formatselect | bold italic underline strikethrough | bullist numlist | forecolor backcolor ',\n    'toolbar2' => 'table tabledelete emoticons codesample | tableprops tablerowprops tablecellprops | tableinsertrowbefore tableinsertrowafter tabledeleterow | tableinsertcolbefore tableinsertcolafter tabledeletecol | visualblocks removeformat',\n);\nSince you are making changes in the vardef, you will need to navigate Admin > Repairs and run Quick Repair and Rebuild. Once you perform Quick Repair and Rebuild, the description of the Account records will have TinyMCE Editor that allows you to write rich-text content.\nPlugins\nSugar is using TinyMCE v4. Most of the settings that you can define in tinyConfig are exist in TinyMCE documentation. However, it is important to know that plugins are limited with plugins that are provided by Sugar. These plugins can be found in ./include/javascript/tinymce4/plugins.\nConfiguring the TinyMCE Editors used in BWC Modules\nIf you are looking for a solution with older TinyMCE that Sugar uses. You can try to create an override file and modify default settings. There are two different overrides that can be applied to buttons and default settings.\nOverriding Buttons\nThe first override file is for the toolbar buttons. To do this, you must create ./custom/include/tinyButtonConfig.php. Within this file, you will be able to override the button layout for the TinyMCE editor.\nThere are 3 different layouts you can change:\ndefault : Used when creating an email template\nemail_compose : Used when composing an email from the full form under the Emails module", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/TinyMCE/index.html"}
{"id": "8a9c81cd568f-3", "text": "email_compose : Used when composing an email from the full form under the Emails module\nemail_compose_light : Used when doing a quick compose from a listview or subpanel\nExample File\n./custom/include/tinyButtonConfig.php\n<?php\n    //create email template\n    $buttonConfigs['default'] = array(\n        'buttonConfig' => \"code,help,separator,bold,italic,underline,strikethrough,separator,justifyleft,justifycenter,justifyright,justifyfull,separator,forecolor,backcolor,separator,styleselect,formatselect,fontselect,fontsizeselect,\",\n        'buttonConfig2' => \"cut,copy,paste,pastetext,pasteword,selectall,separator,search,replace,separator,bullist,numlist,separator,outdent,indent,separator,ltr,rtl,separator,undo,redo,separator, link,unlink,anchor,image,separator,sub,sup,separator,charmap,visualaid\",\n        'buttonConfig3' => \"tablecontrols,separator,advhr,hr,removeformat,separator,insertdate,inserttime,separator,preview\"\n    );\n    //Standard email compose\n    $buttonConfigs['email_compose'] = array(\n        'buttonConfig' => \"code,help,separator,bold,italic,underline,strikethrough,separator,bullist,numlist,separator,justifyleft,justifycenter,justifyright,justifyfull,separator,forecolor,backcolor,separator,styleselect,formatselect,fontselect,fontsizeselect,\",\n        'buttonConfig2' => \"\", //empty\n        'buttonConfig3' => \"\" //empty\n    );\n    //Quick email compose\n    $buttonConfigs['email_compose_light'] = array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/TinyMCE/index.html"}
{"id": "8a9c81cd568f-4", "text": "//Quick email compose\n    $buttonConfigs['email_compose_light'] = array(\n        'buttonConfig' => \"code,help,separator,bold,italic,underline,strikethrough,separator,bullist,numlist,separator,justifyleft,justifycenter,justifyright,justifyfull,separator,forecolor,backcolor,separator,styleselect,formatselect,fontselect,fontsizeselect,\",\n        'buttonConfig2' => \"\", //empty\n        'buttonConfig3' => \"\" //empty\n    );\nOverriding Default Settings\nThe second override file is for basic TinyMCE functionality. To do this, you must create ./custom/include/tinyMCEDefaultConfig.php. TinyMCE has quite a few settings that can be altered, so the best reference for configuration settings can be found in the TinyMCE Configuration Documentation.\nExample File\n./custom/include/tinyMCEDefaultConfig.php\n<?php\n    $defaultConfig = array(\n        'convert_urls' => false,\n        'valid_children' => '+body[style]',\n        'height' => 300,\n        'width'    => '100%',\n        'theme'    => 'advanced',\n        'theme_advanced_toolbar_align' => \"left\",\n        'theme_advanced_toolbar_location' => \"top\",\n        'theme_advanced_buttons1' => \"\",\n        'theme_advanced_buttons2' => \"\",\n        'theme_advanced_buttons3' => \"\",\n        'strict_loading_mode' => true,\n        'mode'    => 'exact',\n        'language' => 'en',\n        'plugins' => 'advhr,insertdatetime,table,preview,paste,searchreplace,directionality',\n        'elements' => '',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/TinyMCE/index.html"}
{"id": "8a9c81cd568f-5", "text": "'elements' => '',\n        'extended_valid_elements' => 'style[dir|lang|media|title|type],hr[class|width|size|noshade],@[class|style]',\n        'content_css' => 'include/javascript/tiny_mce/themes/advanced/skins/default/content.css',\n    );\nCreating Plugins\nAnother alternative to customizing the TinyMCE is to create a plugin. Your plugins will be stored in ./include/javascript/tiny_mce/plugins/. You can find more information on creating plugins on the\u00c2\u00a0TinyMCE website.\nthe use and customization of TinyMCE.\nTopicsModifying the TinyMCE EditorThis article is a brief overview on how to modify the default settings for the TinyMCE editor by creating an override file. There are two different overrides that can be applied to buttons and default settings.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/TinyMCE/index.html"}
{"id": "e77a1c55f0b0-0", "text": "Modifying the TinyMCE Editor\nOverview\nThis article is a brief overview on how to modify the default settings for the TinyMCE editor\u00c2\u00a0by creating an override file. There are two different overrides that can be applied to buttons and default settings.\nOverriding Buttons\nThe first override file is for the toolbar buttons. To do this, you must create ./custom/include/tinyButtonConfig.php. Within this file, you will be able to override the button layout for the TinyMCE editor.\nThere are 3 different layouts you can change:\ndefault : Used when creating an email template\nemail_compose : Used when composing an email from the full form under the Emails module\nemail_compose_light : Used when doing a quick compose from a listview or subpanel\nExample File\n./custom/include/tinyButtonConfig.php\n<?php\n    //create email template\n    $buttonConfigs['default'] = array(\n        'buttonConfig' => \"code,help,separator,bold,italic,underline,strikethrough,separator,justifyleft,justifycenter,justifyright,justifyfull,separator,forecolor,backcolor,separator,styleselect,formatselect,fontselect,fontsizeselect,\",\n        'buttonConfig2' => \"cut,copy,paste,pastetext,pasteword,selectall,separator,search,replace,separator,bullist,numlist,separator,outdent,indent,separator,ltr,rtl,separator,undo,redo,separator, link,unlink,anchor,image,separator,sub,sup,separator,charmap,visualaid\",\n        'buttonConfig3' => \"tablecontrols,separator,advhr,hr,removeformat,separator,insertdate,inserttime,separator,preview\"\n    );\n    //Standard email compose\n    $buttonConfigs['email_compose'] = array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/TinyMCE/Modifying_the_TinyMCE_Editor/index.html"}
{"id": "e77a1c55f0b0-1", "text": "//Standard email compose\n    $buttonConfigs['email_compose'] = array(\n        'buttonConfig' => \"code,help,separator,bold,italic,underline,strikethrough,separator,bullist,numlist,separator,justifyleft,justifycenter,justifyright,justifyfull,separator,forecolor,backcolor,separator,styleselect,formatselect,fontselect,fontsizeselect,\",\n        'buttonConfig2' => \"\", //empty\n        'buttonConfig3' => \"\" //empty\n    );\n    //Quick email compose\n    $buttonConfigs['email_compose_light'] = array(\n        'buttonConfig' => \"code,help,separator,bold,italic,underline,strikethrough,separator,bullist,numlist,separator,justifyleft,justifycenter,justifyright,justifyfull,separator,forecolor,backcolor,separator,styleselect,formatselect,fontselect,fontsizeselect,\",\n        'buttonConfig2' => \"\", //empty\n        'buttonConfig3' => \"\" //empty\n    );\nOverriding Default Settings\nThe second override file is for basic TinyMCE functionality. To do this, you must create ./custom/include/tinyMCEDefaultConfig.php. TinyMCE has quite a few settings that can be altered, so the best reference for configuration settings can be found in the TinyMCE Configuration Documentation.\nExample File\n./custom/include/tinyMCEDefaultConfig.php\n<?php\n    $defaultConfig = array(\n        'convert_urls' => false,\n        'valid_children' => '+body[style]',\n        'height' => 300,\n        'width'    => '100%',\n        'theme'    => 'advanced',\n        'theme_advanced_toolbar_align' => \"left\",\n        'theme_advanced_toolbar_location' => \"top\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/TinyMCE/Modifying_the_TinyMCE_Editor/index.html"}
{"id": "e77a1c55f0b0-2", "text": "'theme_advanced_toolbar_location' => \"top\",\n        'theme_advanced_buttons1' => \"\",\n        'theme_advanced_buttons2' => \"\",\n        'theme_advanced_buttons3' => \"\",\n        'strict_loading_mode' => true,\n        'mode'    => 'exact',\n        'language' => 'en',\n        'plugins' => 'advhr,insertdatetime,table,preview,paste,searchreplace,directionality',\n        'elements' => '',\n        'extended_valid_elements' => 'style[dir|lang|media|title|type],hr[class|width|size|noshade],@[class|style]',\n        'content_css' => 'include/javascript/tiny_mce/themes/advanced/skins/default/content.css',\n    );\nCreating Plugins\nAnother alternative to customizing the TinyMCE is to create a plugin. Your plugins will be stored in ./include/javascript/tiny_mce/plugins/. You can find more information on creating plugins on the\u00c2\u00a0TinyMCE website.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/TinyMCE/Modifying_the_TinyMCE_Editor/index.html"}
{"id": "482d8aa23692-0", "text": "Logic Hooks\nOverview\nThe Logic Hook framework allows you to\u00c2\u00a0append actions to system\u00c2\u00a0events such as when creating, editing, and deleting records.\nHook Definitions\nA logic hook definition file defines the various actions to execute when an event is triggered. It is important to note that there are various ways to implement a logic hook. The following sections describe the different ways to implement a logic hook and when to use each.\nMethodologies\nLogic hook definitions can\u00c2\u00a0pertain\u00c2\u00a0to\u00c2\u00a0a\u00c2\u00a0specific module or to the entire application. Either way, you must decide if the logic hook definition will be implemented as an extension of or directly to the module or application. The following sections explain the difference between these methodologies.\nModule Extension Hooks\nModule extension hooks are located in ./custom/Extension/modules/<module>/Ext/LogicHooks/\u00c2\u00a0and allow a developer\u00c2\u00a0to define\u00c2\u00a0hook actions that will be executed for the specified\u00c2\u00a0events in a given module.\u00c2\u00a0Extensions are best used when creating customizations that may be installed in various environments. They help prevent conflicting edits that occur when\u00c2\u00a0modifying ./custom/modules/<module>/logic_hooks.php. More information can be found in the\u00c2\u00a0Logic Hooks\u00c2\u00a0extension section.\nModule Hooks\nModule hooks are located in\u00c2\u00a0./custom/modules/<module>/logic_hooks.php\u00c2\u00a0and allow a developer\u00c2\u00a0to define\u00c2\u00a0hook actions that will be executed for the specified events in a given module. This path can be used for private development, however, it is not recommended for use\u00c2\u00a0with\u00c2\u00a0distributed modules and plugins. For distributed code, please refer to using module extensions.\nApplication Extension Hooks", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/index.html"}
{"id": "482d8aa23692-1", "text": "Application Extension Hooks\nApplication extension hooks are located in ./custom/Extension/application/Ext/LogicHooks/\u00c2\u00a0and allow a developer to define\u00c2\u00a0hook actions that will be executed for all specified application-level events\u00c2\u00a0using the extension framework. More information can be found in the\u00c2\u00a0Logic Hooks\u00c2\u00a0extension section.\nApplication Hooks\nApplication\u00c2\u00a0hooks are located in\u00c2\u00a0./custom/modules/logic_hooks.php\u00c2\u00a0and allow a developer\u00c2\u00a0to define\u00c2\u00a0hook actions that will be executed for the specified\u00c2\u00a0events in all modules. This path can be used for private development, however, it is not recommended for use\u00c2\u00a0with\u00c2\u00a0distributed modules and plugins. For distributed code, please refer to using\u00c2\u00a0application extensions.\nDefinition Properties\nAll logic hooks must have a\u00c2\u00a0$hook_version and $hook_array\u00c2\u00a0variable defined. The following sections cover each required variable.\nhook_version\nAll logic hook definitions will define a $hook_version. This determines the version of the logic hook framework. Currently, the only supported hook version is 1.\n$hook_version = 1;\nhook_array\nThe logic hook definition will also contain a $hook_array. This defines the specific action to execute. The hook array will be defined as follows:\nName\nType\nDescription\nevent_name\nString\nThe name of the event to append the action to\nprocess_index\nInteger\nThe order of action execution\ndescription\nString\nA short description of\u00c2\u00a0the hook action\nfile_path\nString\nThe path to the logic hook file\u00c2\u00a0in the ./custom/ directory, or null if using namespaces\nclass_name\nString\nThe name of the logic hook action class including any namespaces\nmethod_name\nString\nThe name of the logic hook action method\nYour definition should resemble the code block below:\n<?php\n    $hook_version = 1;", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/index.html"}
{"id": "482d8aa23692-2", "text": "<?php\n    $hook_version = 1;\n    $hook_array['<event_name>'][] = array(\n        <process_index>, //Integer\n        '<description>', //String\n        '<file_path>', //String or null if using namespaces\n        '<class_name>', //String\n        '<method_name>', //String\n    );\nHook Method\nThe hook action class can be located anywhere you choose. We\u00c2\u00a0recommended grouping the hooks with the module they are associated with in the ./custom/ directory. You can create a hook action method either with a namespace or without.\nNamespaced Hooks\nAs of 7.7, developers can create namespaced logic hooks. When using namespaces, the file path in ./custom/\u00c2\u00a0will be automatically built out when using the corresponding namespace. The filename defining the class must match the class name exactly to allow the autoloader to find the class definition.\nNamespace\nFile Path\nSugarcrm\\Sugarcrm\\custom\n./custom/\nSugarcrm\\Sugarcrm\\custom\n./custom/src/\nSugarcrm\\Sugarcrm\\custom\\any\\path\n./custom/any/path/\nSugarcrm\\Sugarcrm\\custom\\any\\path\n./custom/src/any/path/\n./custom/Extension/modules/Accounts/Ext/LogicHooks/<file>.php\n<?php\n    $hook_array['before_save'][] = array(\n        1,\n        'Hook description',\n        null,\n        'Sugarcrm\\\\Sugarcrm\\\\custom\\\\modules\\\\Accounts\\\\className',\n        'methodName'\n    );\n?>\n./custom/modules/Accounts/className.php\n<?php\nnamespace Sugarcrm\\Sugarcrm\\custom\\modules\\Accounts;\n    class className\n    {\n        function methodName($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/index.html"}
{"id": "482d8aa23692-3", "text": "{\n            //logic\n        }\n    }\n?>\nThe logic hook method signature may contain different arguments depending on the hook event you have selected.\nHooks without Namespaces\n./custom/Extension/modules/Accounts/Ext/LogicHooks/<file>.php\n<?php\n    $hook_array['before_save'][] = array(\n        1,\n        'Hook description',\n        'custom/modules/Accounts/customLogicHook.php',\n        'className',\n        'methodName'\n    );\n?>\n./custom/modules/Accounts/customLogicHook.php\n<?php\n    class className\n    {\n        function methodName($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\nThe logic hook method signature may contain different arguments depending on the hook event you have selected.\nConsiderations\nWhen using logic hooks, keep in mind the following best practices:\nAs of PHP 5.3, objects are automatically passed by reference. When creating logic hook signatures, do not\u00c2\u00a0append the ampersand (&) to the $bean variable. Doing this will cause unexpected behavior.\nThere is no hook that fires specifically for the ListView, DetailView or EditView events. Instead,\u00c2\u00a0use either the process_record\u00c2\u00a0or after_retrieve logic hooks.\nIn order to compare new values with previous values, use fetched_row to determine whether a change has occurred: if ($bean->fetched_row['{field}'] != $bean->{field})\n{\n    //logic\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/index.html"}
{"id": "482d8aa23692-4", "text": "{\n    //logic\n}\nMake sure that the permissions on the\u00c2\u00a0logic_hooks.php file and the class file that it references are readable by the web server. Otherwise, Sugar will not read the files and your business logic extensions will not work. For example, *nix developers who are extending the Tasks logic should use the following command for the logic_hooks file and the same command for the class file that will be called:\nchmod +r ./custom/modules/Tasks/logic_hooks.php\nMake sure that the entire ./custom/ directory is writable by the web server or else the logic hooks code will not work properly.\nTopicsApplication HooksApplication hooks execute logic when working with the global application.Module HooksModule hooks execute logic when working with Sugar modules (e.g. Accounts, Cases, etc.).User HooksUser hooks execute logic around user actions such as logging in and logging out.Job Queue HooksJob Queue hooks execute logic when working with the Job Queue module.SNIP HooksSNIP hooks execute logic when working with the SNIP email-archiving service.API HooksAPI hooks execute logic when working with the REST API and routing.Web Logic HooksWeb logic hooks let administrators post record and event information to a specified URL when certain sugar events take place.Logic Hook Release NotesThis page documents historical changes to Sugar's logic hook libraries.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/index.html"}
{"id": "9072833d365d-0", "text": "Logic Hook Release Notes\nThis page documents\u00c2\u00a0historical changes to Sugar's logic hook libraries.\n10.2.0\nThe following parameter was added in the 10.2.0 release:\nafter_save arguments.stateChanges\n7.0.0RC1\nWeb Logic Hooks were introduced in this release.\nThe following hooks were also added in the 7.0.0RC1 release:\nafter_routing\nbefore_api_call\nbefore_filter\nbefore_respond\nbefore_routing\nThe following parameters were added in the 7.0.0RC1 release:\nafter_save arguments.isUpdate\nafter_save arguments.dataChanges\nbefore_save arguments.isUpdate\n6.6.0\nThe after_load_user hook was added in the 6.6.0 release.\n6.5.0RC1\nThe following hooks were added in the 6.5.0RC1 release:\nafter_email_import\nbefore_email_import\njob_failure\njob_failure_retry\n6.4.5\nThe following hooks were added in the 6.4.5 release:\nbefore_relationship_add\nbefore_relationship_delete\n6.4.4\nThe handle_exception hook was added in the 6.4.4 release.\n6.4.3\nThe after_entry_point hook was added in the 6.4.3 release.\n6.0.0RC1\nThe following hooks were added in the 6.0.0RC1 release:\nafter_relationship_add\nafter_relationship_delete\n5.0.0a\nThe following hooks were added in the 5.0.0a release:\nafter_login\nafter_logout\nafter_ui_footer\nafter_ui_frame\nbefore_logout\nlogin_failed\nprocess_record\nserver_round_trip\n4.5.0c\nThe after_save hook was added in the 4.5.0c release.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Logic_Hook_Release_Notes/index.html"}
{"id": "9072833d365d-1", "text": "The after_save hook was added in the 4.5.0c release.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Logic_Hook_Release_Notes/index.html"}
{"id": "b0380b913f29-0", "text": "SNIP Hooks\nSNIP hooks execute logic when working with\u00c2\u00a0the SNIP email-archiving service.\nTopicsafter_email_importThe after_email_import hook executes after a SNIP email has been imported.before_email_importThe before_email_import hook executes before a SNIP email has been imported.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/SNIP_Hooks/index.html"}
{"id": "cd98285b2ef0-0", "text": "before_email_import\nOverview\nThe before_email_import hook executes before a SNIP email has been imported.\nDefinition\nfunction before_email_import($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe Email object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event (typically empty)\nConsiderations\nThis is a global logic hook where the logic hook reference must be placed in ./custom/modules/logic_hooks.php.\nChange Log\nVersion\nNote\n6.5.0RC1\nAdded before_email_import hook\nExample\n./custom/modules/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['before_email_import'] = Array();\n    $hook_array['before_email_import'][] = Array(\n        //Processing index. For sorting the array.\n        1, \n        //Label. A string value to identify the hook.\n        'before_email_import example', \n        //The PHP file where your class is located.\n        'custom/modules/SNIP/logic_hooks_class.php', \n        //The class the method is in.\n        'logic_hooks_class', \n        //The method to call.\n        'before_email_import_method' \n    );\n?>\n./custom/modules/SNIP/logic_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class logic_hooks_class\n    {\n        function before_email_import_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/SNIP_Hooks/before_email_import/index.html"}
{"id": "3476f30e105c-0", "text": "after_email_import\nOverview\nThe after_email_import hook executes after a SNIP email has been imported.\nDefinition\nfunction after_email_import($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe Email object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event (typically empty)\nConsiderations\nThis is a global logic hook where the logic hook reference must be placed in ./custom/modules/logic_hooks.php.\nChange Log\nVersion\nNote\n6.5.0RC1\nAdded after_email_import hook\nExample\n./custom/modules/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['after_email_import'] = Array();\n    $hook_array['after_email_import'][] = Array(\n        //Processing index. For sorting the array.\n        1, \n        //Label. A string value to identify the hook.\n        'after_email_import example', \n        //The PHP file where your class is located.\n        'custom/modules/SNIP/logic_hooks_class.php', \n        //The class the method is in.\n        'logic_hooks_class', \n        //The method to call.\n        'after_email_import_method' \n    );\n?>\n./custom/modules/SNIP/logic_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class logic_hooks_class\n    {\n        function after_email_import_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/SNIP_Hooks/after_email_import/index.html"}
{"id": "558f1151461b-0", "text": "Job Queue Hooks\nJob Queue hooks execute logic when working with the Job Queue module.\nTopicsjob_failureThe job_failure hook executes when a job's final failure occurs.job_failure_retryThe job_failure_retry hook executes each time a job fails before its final failure. If you only want action on the final failure, use the job_failure logic hook.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Job_Queue_Hooks/index.html"}
{"id": "924e093af85e-0", "text": "job_failure_retry\nOverview\nThe job_failure_retry hook executes each time a job fails before its final failure. If you only want action on the final failure, use the\u00c2\u00a0job_failure logic hook.\nDefinition\nfunction job_failure_retry($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe SchedulersJob object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event (typically empty)\nChange Log\nVersion\nNote\n6.5.0RC1\nAdded job_failure_retry hook\nExample\n./custom/modules/SchedulersJobs/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['job_failure_retry'] = Array();\n    $hook_array['job_failure_retry'][] = Array(\n        //Processing index. For sorting the array.\n        1, \n        //Label. A string value to identify the hook.\n        'job_failure_retry example', \n        //The PHP file where your class is located.\n        'custom/modules/SchedulersJobs/logic_hooks_class.php', \n        //The class the method is in.\n        'logic_hooks_class', \n        //The method to call.\n        'job_failure_retry_method' \n    );\n?>\n./custom/modules/SchedulersJobs/logic_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class logic_hooks_class\n    {\n        function job_failure_retry_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Job_Queue_Hooks/job_failure_retry/index.html"}
{"id": "9b551dc178e7-0", "text": "job_failure\nOverview\nThe job_failure hook executes when a job's final failure occurs.\nDefinition\nfunction job_failure($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe SchedulersJob object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event (typically empty)\nChange Log\nVersion\nNote\n6.5.0RC1\nAdded job_failure hook\nExample\n./custom/modules/SchedulersJobs/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['job_failure'] = Array();\n    $hook_array['job_failure'][] = Array(\n        //Processing index. For sorting the array.\n        1, \n        //Label. A string value to identify the hook.\n        'job_failure example', \n        //The PHP file where your class is located.\n        'custom/modules/SchedulersJobs/logic_hooks_class.php', \n        //The class the method is in.\n        'logic_hooks_class', \n        //The method to call.\n        'job_failure_method' \n    );\n?>\n./custom/modules/SchedulersJobs/logic_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class logic_hooks_class\n    {\n        function job_failure_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Job_Queue_Hooks/job_failure/index.html"}
{"id": "b5037fb1c991-0", "text": "Web Logic Hooks\nOverview\nWeb logic hooks let administrators post record and event information to a specified URL when certain sugar events take place.\nThe administration panel for web logic hooks can be found by navigating to Admin > Web Logic Hooks in the Sugar application. When a web logic hook is triggered, Sugar creates a record in the job queue.\nNote: You must have the cron set up and running in order to process the job queue for web logic hooks. The POST of the information to the external URL will happen when the cron runs and not when the actual event occurs.\nArguments\nName\nDescription\nURL\nThe URL to post JSON-encoded information\nModule Name\nThe name of the module to which the web logic hook will apply\nTrigger Event\nThe event that will trigger the web logic hookThe following events are applicable to a web logic hook:\nafter_save\nafter_delete\nafter_relationship_add\nafter_relationship_delete\nafter_login\nafter_logout\nafter_login_failed\nRequest Method\nThe request method to use when sending the informationThe following methods may\u00c2\u00a0be used:\nPOST\nGET\nPUT\nDELETE\nExample\nThe following\u00c2\u00a0example shows how to receive the information posted to the web logic hook URL parameter.\nhttp://{url}/receive.php\n<?php\n//get the posted JSON data\n$data = file_get_contents('php://input');\n//decode the data\n$decoded_data = json_decode(trim($data));\n//use the data\n$file = 'receivedData-'.time().'.txt';\nfile_put_contents($file, print_r($decoded_data, true));\n?>\nResult\nreceivedData-1380158171.txt\nstdClass Object\n(\n    [isUpdate] => 1\n    [dataChanges] => Array\n    (\n    )\n    [bean] => Account\n    [data] => stdClass Object\n    (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Web_Logic_Hooks/index.html"}
{"id": "b5037fb1c991-1", "text": "[bean] => Account\n    [data] => stdClass Object\n    (\n        [id] => e0623cdb-ac4b-e7ff-f681-5242e9116892\n        [name] => Super Star Holdings Inc\n        [date_modified] => 2013-09-25T21:16:06-04:00\n        [modified_user_id] => 1\n        [modified_by_name] => admin\n        [created_by] => 1\n        [created_by_name] => Administrator\n        [description] =>\n        [deleted] =>\n        [assigned_user_id] => seed_will_id\n        [assigned_user_name] => Will Westin\n        [team_count] =>\n        [team_name] => Array\n        (\n            [0] => stdClass Object\n                (\n                    [id] => East\n                    [name] => East\n                    [name_2] =>\n                    [primary] => 1\n                )\n            [1] => stdClass Object\n                (\n                    [id] => West\n                    [name] => West\n                    [name_2] =>\n                    [primary] =>\n                )\n        )\n        [linkedin] =>\n        [facebook] =>\n        [twitter] =>\n        [googleplus] =>\n        [account_type] => Customer\n        [industry] => Energy\n        [annual_revenue] =>\n        [phone_fax] =>\n        [billing_address_street] => 111 Silicon Valley Road\n        [billing_address_city] => Los Angeles\n        [billing_address_state] => NY\n        [billing_address_postalcode] => 84028\n        [billing_address_country] => USA\n        [rating] =>\n        [phone_office] => (374) 791-2199\n        [phone_alternate] =>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Web_Logic_Hooks/index.html"}
{"id": "b5037fb1c991-2", "text": "[phone_alternate] =>\n        [website] =>\n        [ownership] =>\n        [employees] =>\n        [ticker_symbol] =>\n        [shipping_address_street] => 111 Silicon Valley Road\n        [shipping_address_city] => Los Angeles\n        [shipping_address_state] => NY\n        [shipping_address_postalcode] => 84028\n        [shipping_address_country] => USA\n        [email] => Array\n        (\n            [0] => stdClass Object\n                (\n                    [email_address] => example@example.tw\n                    [invalid_email] =>\n                    [opt_out] =>\n                    [primary_address] => 1\n                    [reply_to_address] =>\n                )\n            [1] => stdClass Object\n                (\n                    [email_address] => the.example@example.name\n                    [invalid_email] =>\n                    [opt_out] =>\n                    [primary_address] =>\n                    [reply_to_address] =>\n                )\n        )\n        [email1] => example@example.tw\n        [parent_id] =>\n        [sic_code] =>\n        [parent_name] =>\n        [email_opt_out] =>\n        [invalid_email] =>\n        [campaign_id] =>\n        [campaign_name] =>\n    )\n    [event] => after_save\n)\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Web_Logic_Hooks/index.html"}
{"id": "853bb94cc11c-0", "text": "User Hooks\nUser hooks execute logic around\u00c2\u00a0user actions such as logging in and logging out.\nTopicsafter_loginThe after_login hook executes after a user logs into the system.after_logoutThe after_logout hook executes after a user logs out of the system.before_logoutThe before_logout hook executes before a user logs out of the system.login_failedThe login_failed hook executes on a failed login attempt.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/User_Hooks/index.html"}
{"id": "01d350b4e328-0", "text": "after_login\nOverview\nThe after_login hook executes after a user logs into the system.\nDefinition\nfunction after_login($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe bean object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event (typically empty)\nChange Log\nVersion\nNote\n5.0.0a\nAdded after_login hook\nExample\n./custom/modules/Users/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['after_login'] = Array();\n    $hook_array['after_login'][] = Array(\n        //Processing index. For sorting the array.\n        1, \n        //Label. A string value to identify the hook.\n        'after_login example', \n        //The PHP file where your class is located.\n        'custom/modules/Users/logic_hooks_class.php', \n        //The class the method is in.\n        'logic_hooks_class', \n        //The method to call.\n        'after_login_method' \n    );\n?>\n./custom/modules/Users/logic_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class logic_hooks_class\n    {\n        function after_login_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/User_Hooks/after_login/index.html"}
{"id": "b8a5a31eb23c-0", "text": "after_logout\nOverview\nThe after_logout\u00c2\u00a0hook executes after a user logs out of the system.\nDefinition\nfunction after_logout($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe bean object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event (typically empty)\nChange Log\nVersion\nNote\n5.0.0a\nAdded after_logout\u00c2\u00a0hook\nExample\n./custom/modules/Users/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['after_logout'] = Array();\n    $hook_array['after_logout'][] = Array(\n        //Processing index. For sorting the array.\n        1,\n        //Label. A string value to identify the hook.\n        'after_logout example',\n        //The PHP file where your class is located.\n        'custom/modules/Users/logic_hooks_class.php',\n        //The class the method is in.\n        'logic_hooks_class',\n        //The method to call.\n        'after_logout_method'\n    );\n?>\n./custom/modules/Users/logic_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class logic_hooks_class\n    {\n        function after_logout_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/User_Hooks/after_logout/index.html"}
{"id": "746dfacb58a9-0", "text": "login_failed\nOverview\nThe login_failed hook executes on a failed login attempt.\nDefinition\nfunction login_failed($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe bean object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event (typically empty)\nChange Log\nVersion\nNote\n5.0.0a\nAdded login_failed hook\nExample\n./custom/modules/Users/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['login_failed'] = Array();\n    $hook_array['login_failed'][] = Array(\n        //Processing index. For sorting the array.\n        1,\n        //Label. A string value to identify the hook.\n        'login_failed example',\n        //The PHP file where your class is located.\n        'custom/modules/Users/logic_hooks_class.php',\n        //The class the method is in.\n        'logic_hooks_class',\n        //The method to call.\n        'login_failed_method'\n    );\n?>\n./custom/modules/Users/logic_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class logic_hooks_class\n    {\n        function login_failed_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/User_Hooks/login_failed/index.html"}
{"id": "55a185decdb9-0", "text": "before_logout\nOverview\nThe before_logout\u00c2\u00a0hook executes before a user logs out of\u00c2\u00a0the system.\nDefinition\nfunction before_logout($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe bean object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event (typically empty)\nChange Log\nVersion\nNote\n5.0.0a\nAdded before_logout\u00c2\u00a0hook\nExample\n./custom/modules/Users/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['before_logout'] = Array();\n    $hook_array['before_logout'][] = Array(\n        //Processing index. For sorting the array.\n        1,\n        //Label. A string value to identify the hook.\n        'before_logout example',\n        //The PHP file where your class is located.\n        'custom/modules/Users/logic_hooks_class.php',\n        //The class the method is in.\n        'logic_hooks_class',\n        //The method to call.\n        'before_logout_method'\n    );\n?>\n./custom/modules/Users/logic_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class logic_hooks_class\n    {\n        function before_logout_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/User_Hooks/before_logout/index.html"}
{"id": "5bc3ae9eb5d4-0", "text": "API Hooks\nAPI\u00c2\u00a0hooks execute logic when working with the REST API and routing.\nTopicsafter_routingThe after_routing hook executes when the v10+ REST Service has found the route for the request.before_api_callThe before_api_call hook executes when the v10+ REST Service is about to call the API implementation.before_filterThe before_filter hook executes when the v10+ REST Service is about to route the request.before_respondThe before_respond hook executes before the v10+ REST Service call returns data to the user.before_routingThe before_routing hook executes when the v10+ REST Service is about to route the request.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/API_Hooks/index.html"}
{"id": "327f51891971-0", "text": "before_respond\nOverview\nThe before_respond hook executes before the v10+ REST Service call returns data to the user.\nDefinition\nfunction before_respond($event, $response){}\nArguments\nName\nType\nDescription\nevent\nString\nThe name of the logic hook event\nresponse\nObject\nThe RestResponse Object\nConsiderations\nThis is a global logic hook where the logic hook reference must be placed in ./custom/modules/logic_hooks.php.\nIt is not advised to remove or unset any data. Sugar may be using this data and it can adversely affect your instance.\nThis hook should not be used for any type of display output.\nThis hook should be used when you want to add data to all API responses. If you are looking to modify data received from one specific endpoint, It is a much better approach to override that specific endpoint rather than to use this logic hook.\nChange Log\nVersion\nNote\n7.0.0RC1\nAdded before_respond hook\nExample\n./custom/modules/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['before_respond'] = Array();\n    $hook_array['before_respond'][] = Array(\n        //Processing index. For sorting the array.\n        1, \n        //Label. A string value to identify the hook.\n        'after_routing example', \n        //The PHP file where your class is located.\n        'custom/modules/logic_hooks_class.php',\n        //The class the method is in. \n        'logic_hooks_class',\n        //The method to call. \n        'before_respond_method' \n    );\n?>\n./custom/modules/logic_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/API_Hooks/before_respond/index.html"}
{"id": "327f51891971-1", "text": "class logic_hooks_class\n    {\n        function before_respond_method($event, $response)\n        {\n            //logic\n        }\n    }\n?>\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/API_Hooks/before_respond/index.html"}
{"id": "402672a00221-0", "text": "before_api_call\nOverview\nThe before_api_call hook executes when the v10+ REST Service is about to call the API implementation.\nDefinition\nfunction before_api_call($event, $arguments){}\nArguments\nName\nType\nDescription\nevent\nString\nThe name of the logic hook event\narguments\nArray\nAdditional information related to the event\narguments.api\nObject\nThe RestService Object\narguments.request\nObject\nThe RestResponse Object\nConsiderations\nThis is a global logic hook where the logic hook reference must be placed in ./custom/modules/logic_hooks.php.\nThis hook can change the method being called and the parameters.\nThis hook should not be used for any type of display output.\nChange Log\nVersion\nNote\n7.0.0RC1\nAdded before_api_call hook\nExample\n./custom/modules/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['before_api_call'] = Array();\n    $hook_array['before_api_call'][] = Array(\n        //Processing index. For sorting the array.\n        1, \n        //Label. A string value to identify the hook.\n        'before_api_call example', \n        //The PHP file where your class is located.\n        'custom/modules/logic_hooks_class.php',\n        //The class the method is in. \n        'logic_hooks_class',\n        //The method to call. \n        'before_api_call_method' \n    );\n?>\n./custom/modules/logic_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class logic_hooks_class\n    {\n        function before_api_call_method($event, $arguments)\n        {\n            //logic\n        }\n    }\n?>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/API_Hooks/before_api_call/index.html"}
{"id": "402672a00221-1", "text": "{\n            //logic\n        }\n    }\n?>\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/API_Hooks/before_api_call/index.html"}
{"id": "9b10657648f2-0", "text": "after_routing\nOverview\nThe after_routing hook executes when the v10+ REST Service has found the route for the request.\nDefinition\nfunction after_routing($event, $arguments){}\nArguments\nName\nType\nDescription\nevent\nString\nThe name of the logic hook event\narguments\nArray\nAdditional information related to the event\narguments.api\nObject\nThe RestService Object\narguments.request\nObject\nThe RestResponse Object\nConsiderations\nThis is a global logic hook where the logic hook reference must be placed in ./custom/modules/logic_hooks.php.\nThis hook can change request object parameters that influence routing.\nThis hook should not be used for any type of display output.\nChange Log\nVersion\nNote\n7.0.0RC1\nAdded after_routing hook\nExample\n./custom/modules/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['after_routing'] = Array();\n    $hook_array['after_routing'][] = Array(\n        //Processing index. For sorting the array.\n        1, \n        //Label. A string value to identify the hook.\n        'after_routing example', \n        //The PHP file where your class is located.\n        'custom/modules/logic_hooks_class.php',\n        //The class the method is in. \n        'logic_hooks_class',\n        //The method to call. \n        'after_routing_method' \n    );\n?>\n./custom/modules/logic_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class logic_hooks_class\n    {\n        function after_routing_method($event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\u00c2", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/API_Hooks/after_routing/index.html"}
{"id": "9b10657648f2-1", "text": "{\n            //logic\n        }\n    }\n?>\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/API_Hooks/after_routing/index.html"}
{"id": "5110ef9d1958-0", "text": "before_routing\nOverview\nThe before_routing hook executes when the v10+ REST Service is about to route the request.\nDefinition\nfunction before_routing($event, $arguments){}\nArguments\nName\nType\nDescription\nevent\nString\nThe name of the logic hook event\narguments\nArray\nAdditional information related to the event\narguments.api\nObject\nThe RestService Object\narguments.request\nObject\nThe RestResponse Object\nConsiderations\nThis is a global logic hook where the logic hook reference must be placed in ./custom/modules/logic_hooks.php.\nThis hook can change request object parameters that influence routing.\nThis hook should not be used for any type of display output.\nChange Log\nVersion\nNote\n7.0.0RC1\nAdded before_routing hook\nExample\n./custom/modules/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['before_routing'] = Array();\n    $hook_array['before_routing'][] = Array(\n        //Processing index. For sorting the array.\n        1, \n        //Label. A string value to identify the hook.\n        'before_routing example', \n        //The PHP file where your class is located.\n        'custom/modules/logic_hooks_class.php',\n        //The class the method is in. \n        'logic_hooks_class',\n        //The method to call. \n        'before_routing_method' \n    );\n?>\n./custom/modules/logic_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class logic_hooks_class\n    {\n        function before_routing_method($event, $arguments)\n        {\n            //logic\n        }\n    }\n?>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/API_Hooks/before_routing/index.html"}
{"id": "5110ef9d1958-1", "text": "{\n            //logic\n        }\n    }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/API_Hooks/before_routing/index.html"}
{"id": "f68f7c59f286-0", "text": "before_filter\nOverview\nThe before_filter hook executes when the v10+ REST Service is about to route the request.\nDefinition\nfunction before_filter($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nAn empty bean object of the module being queried.\nevent\nString\nThe name of the logic hook event.\narguments\nArray\nAdditional information related to the event.\narguments[0]\nObject\nThe SugarQuery Object\narguments[1]\nArray\nThe query options\nConsiderations\nThis hook can be executed for a specific module in ./custom/modules/<module>/logic_hooks.php or globally in ./custom/modules/logic_hooks.php.\nThis hook can change request object parameters that influence routing.\nThis hook should not be used for any type of display output.\nChange Log\nVersion\nNote\n7.0.0RC1\nAdded before_filter hook\nExample\n./custom/modules/{module}/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['before_filter'] = Array();\n    $hook_array['before_filter'][] = Array(\n        //Processing index. For sorting the array.\n        1, \n        //Label. A string value to identify the hook.\n        'before_filter example', \n        //The PHP file where your class is located.\n        'custom/modules/{module}/logic_hooks_class.php',\n        //The class the method is in. \n        'logic_hooks_class',\n        //The method to call. \n        'before_filter_method' \n    );\n?>\n./custom/modules/{module}/logic_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class logic_hooks_class\n    {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/API_Hooks/before_filter/index.html"}
{"id": "f68f7c59f286-1", "text": "class logic_hooks_class\n    {\n        function before_filter_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/API_Hooks/before_filter/index.html"}
{"id": "3cfbb4d0fb0a-0", "text": "Module Hooks\nModule hooks execute logic when working with Sugar modules (e.g. Accounts, Cases, etc.).\nTopicsafter_deleteThe after_delete hook executes after a record is deleted.after_fetch_queryThe after_fetch_query logic hook executes after a sugar query has been executed.after_relationship_addThe after_relationship_add hook executes after a relationship has been added between two records.after_relationship_deleteThe after_relationship_delete hook executes after a relationship between two records has been deleted.after_restoreThe after_restore hook executes after a record gets undeleted (i.e. the deleted field's value changes from 1 to 0).after_retrieveThe after_retrieve hook executes after a record has been retrieved from the database.after_saveThe after_save hook executes after a record is saved.before_deleteThe before_delete logic hook executes before a record is deleted.before_fetch_queryThe before_fetch_query logic hook executes before a sugar query has been executed.before_relationship_addThe before_relationship_add logic hook executes before a relationship has been added between two records.before_relationship_deleteThe before_relationship_delete logic hook executes before a relationship between two records is deleted.before_restoreThe before_restore logic hook executes before a record gets undeleted (i.e. the deleted field's value changes from 1 to 0).before_saveThe before_save logic hook executes before a record is saved.process_recordThe process_record logic hook executes when the record is being processed as a part of the ListView or subpanel list.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/index.html"}
{"id": "3a444bbad6e4-0", "text": "after_retrieve\nOverview\nThe after_retrieve hook executes after a record has been retrieved from the database.\nDefinition\nfunction after_retrieve($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe bean object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event\narguments.id\nString\nID of the record\narguments.encode\nBoolean\nWhether or not to encode\nConsiderations\nThe after_retrieve hook does not fire when a new record is being created.\nCalling save on the bean in this hook can cause adverse side effects if not handled correctly and should be avoided. (i.e. $bean->save())\nExamples\nCreating a Logic Hook using the Extension Framework\n./custom/Extension/modules/<module>/Ext/LogicHooks/<file>.php\n<?php\n    $hook_array['after_retrieve'][] = Array(\n        //Processing index. For sorting the array.\n        1,\n        //Label. A string value to identify the hook.\n        'after_retrieve example',\n        //The PHP file where your class is located.\n        'custom/modules/<module>/after_retrieve_class.php',\n        //The class the method is in.\n        'after_retrieve_class',\n        //The method to call.\n        'after_retrieve_method'\n    );\n?>\n./custom/modules/{module}/{module}_hook.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class after_retrieve_class\n    {\n        function after_retrieve_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\nCreating a Core Logic Hook", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/after_retrieve/index.html"}
{"id": "3a444bbad6e4-1", "text": "//logic\n        }\n    }\n?>\nCreating a Core Logic Hook\nPrior to Sugar 6.3.x, logic hooks could only be created using the following method. Please note that this approach is still valid but is not recommended when building plugins as it may conflict with existing customizations.\n./custom/modules/<module>/logic_hooks.php\n<?php\n   $hook_version = 1;\n   $hook_array = Array();\n   $hook_array['after_retrieve'] = Array();\n   $hook_array['after_retrieve'][] = Array(\n      //Processing index. For sorting the array.\n      1, \n      //Label. A string value to identify the hook.\n      'after_retrieve example', \n      //The PHP file where your class is located.\n      'custom/modules/<module>/after_retrieve_class.php', \n      //The class the method is in.\n      'after_retrieve_class', \n      //The method to call.\n      'after_retrieve_method' \n   );\n?>\n./custom/modules/<module>/after_retrieve_class.php\n<?php\n   if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n   class after_retrieve_class\n   {\n      function after_retrieve_method($bean, $event, $arguments)\n      {\n         //logic\n      }\n   }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/after_retrieve/index.html"}
{"id": "ebf804abb51d-0", "text": "process_record\nOverview\nThe process_record logic hook executes when the record is being processed as a part of the ListView or subpanel list.\nDefinition\nfunction process_record($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe bean object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event (typically empty)\nConsiderations\nThis can be used to set values in a record's fields prior to display in the ListView or in the subpanel of a DetailView.\nThis event is not fired in the EditView.\nYou should not call save on the referenced bean. The bean is only populated for list fields and will result in a loss of information.\nChange Log\nVersion\nNote\n5.0.0a\nAdded process_record hook\nExamples\nCreating a Logic Hook using the Extension Framework\n./custom/Extension/modules/<module>/Ext/LogicHooks/<file>.php\n<?php\n    $hook_array['process_record'][] = Array(\n        //Processing index. For sorting the array.\n        1,\n        //Label. A string value to identify the hook.\n        'process_record example',\n        //The PHP file where your class is located.\n        'custom/modules/<module>/process_record_class.php',\n        //The class the method is in.\n        'process_record_class',\n        //The method to call.\n        'process_record_method'\n    );\n?>\n./custom/modules/<module>/process_record_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class process_record_class\n    {\n        function process_record_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\nCreating a Core Logic Hook", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/process_record/index.html"}
{"id": "ebf804abb51d-1", "text": "//logic\n        }\n    }\n?>\nCreating a Core Logic Hook\nPrior to Sugar 6.3.x, logic hooks could only be created using the following method. Please note that this approach is still valid but is not recommended when building plugins as it may conflict with existing customizations.\n./custom/modules/<module>/logic_hooks.php\n<?php\n   $hook_version = 1;\n   $hook_array = Array();\n   $hook_array['process_record'] = Array();\n   $hook_array['process_record'][] = Array(\n      //Processing index. For sorting the array.\n      1, \n      //Label. A string value to identify the hook.\n      'process_record example', \n      //The PHP file where your class is located.\n      'custom/modules/<module>/process_record_class.php', \n      //The class the method is in.\n      'process_record_class', \n      //The method to call.\n      'process_record_method' \n   );\n?>\n./custom/modules/<module>/process_record_class.php\n<?php\n   if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n   class process_record_class\n   {\n      function process_record_method($bean, $event, $arguments)\n      {\n         //logic\n      }\n   }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/process_record/index.html"}
{"id": "e7e0a808cd36-0", "text": "after_fetch_query\nOverview\nThe after_fetch_query\u00c2\u00a0logic hook executes after\u00c2\u00a0a sugar query\u00c2\u00a0has been executed.\nDefinition\nfunction after_fetch_query($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe bean object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event\narguments.beans\nArray\nAn array of bean objects resulting from the query\narguments.fields\nArray\nAn array\u00c2\u00a0of selected fields\narguments.rows\nArray\nAn array representation of the selected beans\u00c2\u00a0\nChange Log\nVersion\nNote\n7.7.0.0\nAdded after_fetch_query\u00c2\u00a0logic hook\nExamples\nCreating a Logic Hook using Extension Framework\n./custom/Extension/modules/<module>/Ext/LogicHooks/<file>.php\n<?php\n    $hook_array['after_fetch_query'][] = Array(\n        //Processing index. For sorting the array.\n        1,\n        //Label. A string value to identify the hook.\n        'after_fetch_query example',\n        //The PHP file where your class is located.\n        'custom/modules/<module>/after_fetch_query_class.php',\n        //The class the method is in.\n        'after_fetch_query_class',\n        //The method to call.\n        'after_fetch_query_method'\n    );\n?>\n./custom/modules/<module>/after_fetch_query_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class after_fetch_query_class\n    {\n        function after_fetch_query_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\nCreating a Core Logic Hook", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/after_fetch_query/index.html"}
{"id": "e7e0a808cd36-1", "text": "//logic\n        }\n    }\n?>\nCreating a Core Logic Hook\nPrior to Sugar 6.3.x, logic hooks could only be created using the following method. Please note that this approach is still valid but is not recommended when building plugins as it may conflict with existing customizations.\n./custom/modules/<module>/logic_hooks.php\n<?php\n   $hook_version = 1;\n   $hook_array = Array();\n   $hook_array['after_fetch_query'] = Array();\n   $hook_array['after_fetch_query'][] = Array(\n      //Processing index. For sorting the array.\n      1, \n      //Label. A string value to identify the hook.\n      'after_fetch_query example', \n      //The PHP file where your class is located.\n      'custom/modules/<module>/after_fetch_query_class.php', \n      //The class the method is in.\n      'logic_hooks_class', \n      //The method to call.\n      'after_fetch_query_method' \n   );\n?>\n./custom/modules/<module>/after_fetch_query_class.php\n<?php\n   if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n   class after_fetch_query_class\n   {\n      function after_fetch_query_method($bean, $event, $arguments)\n      {\n         //logic\n      }\n   }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/after_fetch_query/index.html"}
{"id": "08747081b932-0", "text": "after_save\nOverview\nThe after_save hook executes after a record is saved.\nDefinition\nfunction after_save($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe bean object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event (typically empty)\narguments.isUpdate\nBoolean\nWhether or not the record is newly created or not. True is an existing record being saved. False is a new record being created\narguments.dataChanges\nArray\nA list of the fields in the auditable fields on the bean, including the ones that changed and the ones that did not.Note: This argument is deprecated and it is recommended to use arguments.stateChanges instead.\narguments.stateChanges\nArray\nA\u00c2\u00a0list of only the fields in the auditable fields on the bean that changed\nConsiderations\nCalling save on the bean in this hook will cause an infinite loop if not handled correctly. (i.e: $bean->save())\nExamples\nCreating a Logic Hook using the Extension Framework\n./custom/Extension/modules/<module>/Ext/LogicHooks/<file>.php\n<?php\n    $hook_array['after_save'][] = Array(\n        //Processing index. For sorting the array.\n        1,\n        //Label. A string value to identify the hook.\n        'after_save example',\n        //The PHP file where your class is located.\n        'custom/modules/<module>/after_save_class.php',\n        //The class the method is in.\n        'after_save_class',\n        //The method to call.\n        'after_save_method'\n    );\n?>\n./custom/modules/<module>/after_save_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class after_save_class\n    {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/after_save/index.html"}
{"id": "08747081b932-1", "text": "class after_save_class\n    {\n        function after_save_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\nCreating a Core Logic Hook\nPrior to Sugar 6.3.x, logic hooks could only be created using the following method. Please note that this approach is still valid but is not recommended when building plugins as it may conflict with existing customizations.\n./custom/modules/<module>/logic_hooks.php\n<?php\n   $hook_version = 1;\n   $hook_array = Array();\n   $hook_array['after_save'] = Array();\n   $hook_array['after_save'][] = Array(\n      //Processing index. For sorting the array.\n      1, \n      //Label. A string value to identify the hook.\n      'after_save example', \n      //The PHP file where your class is located.\n      'custom/modules/<module>/after_save_class.php', \n      //The class the method is in.\n      'after_save_class', \n      //The method to call.\n      'after_save_method' \n   );\n?>\n./custom/modules/<module>/after_save_class.php\n<?php\n   if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n   class after_save_class\n   {\n      function after_save_method($bean, $event, $arguments)\n      {\n         //logic\n      }\n   }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/after_save/index.html"}
{"id": "f6e44fda226d-0", "text": "after_delete\nOverview\nThe after_delete hook executes after a record is deleted.\nDefinition\nfunction after_delete($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe bean object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event\narguments.id\nString\nID of the deleted record\nExamples\nCreating a Logic Hook using the Extension Framework\n./custom/Extension/modules/<module>/Ext/LogicHooks/<file>.php\n<?php\n    $hook_array['after_delete'][] = Array(\n        //Processing index. For sorting the array.\n        1, \n        //Label. A string value to identify the hook.\n        'after_delete example', \n        //The PHP file where your class is located.\n        'custom/modules/<module>/logic_hooks_class.php', \n        //The class the method is in.\n        'logic_hooks_class', \n        //The method to call.\n        'after_delete_method' \n    );\n?>\n./custom/modules/<module>/logic_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class logic_hooks_class\n    {\n        function after_delete_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\nCreating a Core Logic Hook\nPrior to Sugar 6.3.x, logic hooks could only be created using the following method. Please note that this approach is still valid but is not recommended when building plugins as it may conflict with existing customizations.\n./custom/modules/<module>/logic_hooks.php\n<?php\n   $hook_version = 1;\n   $hook_array = Array();\n   $hook_array['after_delete'] = Array();", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/after_delete/index.html"}
{"id": "f6e44fda226d-1", "text": "$hook_array = Array();\n   $hook_array['after_delete'] = Array();\n   $hook_array['after_delete'][] = Array(\n      //Processing index. For sorting the array.\n      1, \n      //Label. A string value to identify the hook.\n      'after_delete example', \n      //The PHP file where your class is located.\n      'custom/modules/<module>/after_delete_class.php', \n      //The class the method is in.\n      'after_delete_class', \n      //The method to call.\n      'after_delete_method' \n   );\n?>\n./custom/modules/<module>/after_delete_class.php\n<?php\n   if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n   class after_delete_class\n   {\n      function after_delete_method($bean, $event, $arguments)\n      {\n         //logic\n      }\n   }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/after_delete/index.html"}
{"id": "6f8310bec170-0", "text": "after_restore\nOverview\nThe after_restore hook executes after a record gets undeleted (i.e. the deleted field's value changes from 1 to 0).\nDefinition\nfunction after_restore($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe bean object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event (typically empty)\nExamples\nCreating a Logic Hook using the Extension Framework\n./custom/Extension/modules/<module>/Ext/LogicHooks/<file>.php\n<?php\n    $hook_array['after_restore'][] = Array(\n        //Processing index. For sorting the array.\n        1,\n        //Label. A string value to identify the hook.\n        'after_restore example',\n        //The PHP file where your class is located.\n        'custom/modules/<module>/after_restore_class.php',\n        //The class the method is in.\n        'after_restore_class',\n        //The method to call.\n        'after_restore_method'\n    );\n?>\n./custom/modules/<module>/after_restore_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class after_restore_class\n    {\n        function after_restore_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\nCreating a Core Logic Hook\nPrior to Sugar 6.3.x, logic hooks could only be created using the following method. Please note that this approach is still valid but is not recommended when building plugins as it may conflict with existing customizations.\n./custom/modules/<module>/logic_hooks.php\n<?php\n   $hook_version = 1;\n   $hook_array = Array();\n   $hook_array['after_restore'] = Array();", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/after_restore/index.html"}
{"id": "6f8310bec170-1", "text": "$hook_array = Array();\n   $hook_array['after_restore'] = Array();\n   $hook_array['after_restore'][] = Array(\n      //Processing index. For sorting the array.\n      1, \n      //Label. A string value to identify the hook.\n      'after_restore example', \n      //The PHP file where your class is located.\n      'custom/modules/<module>/after_restore_class.php', \n      //The class the method is in.\n      'after_restore_class', \n      //The method to call.\n      'after_restore_method' \n   );\n?>\n./custom/modules/<module>/after_restore_class.php\n<?php\n   if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n   class after_restore_class\n   {\n      function after_restore_method($bean, $event, $arguments)\n      {\n         //logic\n      }\n   }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/after_restore/index.html"}
{"id": "77be405585d4-0", "text": "before_delete\nOverview\nThe before_delete logic hook executes before a record is deleted.\nDefinition\nfunction before_delete($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe bean object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event\narguments.id\nString\nID of the record to delete\nExamples\nCreating a Logic Hook using the Extension Framework\n./custom/Extension/modules/<module>/Ext/LogicHooks/<file>.php\n<?php\n    $hook_array['before_delete'][] = Array(\n        //Processing index. For sorting the array.\n        1,\n        //Label. A string value to identify the hook.\n        'before_delete example',\n        //The PHP file where your class is located.\n        'custom/modules/<module>/before_delete_class.php',\n        //The class the method is in.\n        'before_delete_class',\n        //The method to call.\n        'before_delete_method'\n    );\n?>\n./custom/modules/<module>/before_delete_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class before_delete_class\n    {\n        function before_delete_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\nCreating a Core Logic Hook\nPrior to Sugar 6.3.x, logic hooks could only be created using the following method. Please note that this approach is still valid but is not recommended when building plugins as it may conflict with existing customizations.\n./custom/modules/<module>/logic_hooks.php\n<?php\n   $hook_version = 1;\n   $hook_array = Array();\n   $hook_array['before_delete'] = Array();", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/before_delete/index.html"}
{"id": "77be405585d4-1", "text": "$hook_array = Array();\n   $hook_array['before_delete'] = Array();\n   $hook_array['before_delete'][] = Array(\n      //Processing index. For sorting the array.\n      1, \n      //Label. A string value to identify the hook.\n      'before_delete example', \n      //The PHP file where your class is located.\n      'custom/modules/<module>/before_delete_class.php', \n      //The class the method is in.\n      'before_delete_class', \n      //The method to call.\n      'before_delete_method' \n   );\n?>\n./custom/modules/<module>/before_delete_class.php\n<?php\n   if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n   class before_delete_class\n   {\n      function before_delete_method($bean, $event, $arguments)\n      {\n         //logic\n      }\n   }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/before_delete/index.html"}
{"id": "af25ba96f8af-0", "text": "after_relationship_add\nOverview\nThe after_relationship_add hook executes after a relationship has been added between two records.\nDefinition\nfunction after_relationship_add($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe bean object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event\narguments.id\nString\nModule ID\narguments.module\nString\nModule name\narguments.related_id\nString\nRelated module ID\narguments.related_module\nString\nRelated module name\narguments.link\nString\nLink field name\narguments.relationship\nString\nRelationship name\nConsiderations\nThis hook will be executed for each side of the relationship. An example is that if you add an association between an Account and Contact, the hook will be run for both.\nThe arguments parameter will have additional information regarding the records being modified. The $bean variable will not contain this information.\nChange Log\nVersion\nNote\n6.0.0\nAdded after_relationship_add hook.\nExamples\nCreating a Logic Hook using the Extension Framework\n./custom/Extension/modules/<module>/Ext/LogicHooks/<file>.php\n<?php\n    $hook_array['after_relationship_add'][] = Array(\n        //Processing index. For sorting the array.\n        1,\n        //Label. A string value to identify the hook.\n        'after_relationship_add example',\n        //The PHP file where your class is located.\n        'custom/modules/{module}/after_relationship_add_class.php',\n        //The class the method is in.\n        'after_relationship_add_class',\n        //The method to call.\n        'after_relationship_add_method'\n    );\n?>\n./custom/modules/<module>/after_relationship_add_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/after_relationship_add/index.html"}
{"id": "af25ba96f8af-1", "text": "class after_relationship_add_class\n    {\n        function after_relationship_add_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\nCreating a Core Logic Hook\nPrior to Sugar 6.3.x, logic hooks could only be created using the following method. Please note that this approach is still valid but is not recommended when building plugins as it may conflict with existing customizations.\n./custom/modules/<module>/logic_hooks.php\n<?php\n   $hook_version = 1;\n   $hook_array = Array();\n   $hook_array['after_relationship_add'] = Array();\n   $hook_array['after_relationship_add'][] = Array(\n      //Processing index. For sorting the array.\n      1, \n      //Label. A string value to identify the hook.\n      'after_relationship_add example', \n      //The PHP file where your class is located.\n      'custom/modules/<module>/after_relationship_add_class.php', \n      //The class the method is in.\n      'after_relationship_add_class', \n      //The method to call.\n      'after_relationship_add_method' \n   );\n?>\n./custom/modules/<module>/after_relationship_add_class.php\n<?php\n   if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n   class after_relationship_add_class\n   {\n      function after_relationship_add_method($bean, $event, $arguments)\n      {\n         //logic\n      }\n   }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/after_relationship_add/index.html"}
{"id": "636c1aebed35-0", "text": "before_save\nOverview\nThe before_save logic hook executes before a record is saved.\nDefinition\nfunction before_save($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe bean object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event\narguments.check_notify\nBoolean\nWhether or not to send notifications\narguments.isUpdate\nBoolean\nWhether or not the record is newly created\ntrue = this is an update to an existing record\nfalse = a newly created record\nConsiderations\nFor modules that contain a user-friendly record ID (e.g. the case_number field for the Cases module), the value of that field is not available for a before_save call. This is because this business logic has yet to be executed.\nCalling save on the bean in this hook will cause an infinite loop if not handled correctly. (i.e: $bean->save())\nExamples\nCreating a Logic Hook using Extension Framework\n./custom/Extension/modules/<module>/Ext/LogicHooks/<file>.php\n<?php\n    $hook_array['before_save'][] = Array(\n        //Processing index. For sorting the array.\n        1,\n        //Label. A string value to identify the hook.\n        'before_save example',\n        //The PHP file where your class is located.\n        'custom/modules/<module>/before_save_class.php',\n        //The class the method is in.\n        'before_save_class',\n        //The method to call.\n        'before_save_method'\n    );\n?>\n./custom/modules/<module>/before_save_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class before_save_class\n    {\n        function before_save_method($bean, $event, $arguments)\n        {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/before_save/index.html"}
{"id": "636c1aebed35-1", "text": "function before_save_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\nCreating a Core Logic Hook\nPrior to Sugar 6.3.x, logic hooks could only be created using the following method. Please note that this approach is still valid but is not recommended when building plugins as it may conflict with existing customizations.\n./custom/modules/<module>/logic_hooks.php\n<?php\n   $hook_version = 1;\n   $hook_array = Array();\n   $hook_array['before_save'] = Array();\n   $hook_array['before_save'][] = Array(\n      //Processing index. For sorting the array.\n      1, \n      //Label. A string value to identify the hook.\n      'before_save example', \n      //The PHP file where your class is located.\n      'custom/modules/<module>/before_save_class.php', \n      //The class the method is in.\n      'before_save_class', \n      //The method to call.\n      'before_save_method' \n   );\n?>\n./custom/modules/<module>/before_save_class.php\n<?php\n   if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n   class before_save_class\n   {\n      function before_save_method($bean, $event, $arguments)\n      {\n         //logic\n      }\n   }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/before_save/index.html"}
{"id": "b3761eb392ae-0", "text": "before_relationship_delete\nOverview\nThe before_relationship_delete logic hook executes before a relationship between two records is\u00c2\u00a0deleted.\nDefinition\nfunction before_relationship_delete($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe bean object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event\narguments.id\nString\nModule id\narguments.module\nString\nModule name\narguments.related_id\nString\nRelated module id\narguments.related_module\nString\nRelated module name\narguments.link\nString\nLink field name\narguments.relationship\nString\nRelationship name\nConsiderations\nThis hook will be executed for each side of the relationship. For example, if you delete an association between an account and a contact, the hook will run for both records.\nThe arguments parameter will have additional information regarding the records being modified. The $bean variable will not contain this information.\nChange Log\nVersion\nNote\n6.4.5\nAdded before_relationship_delete hook.\nExamples\nCreating a Logic Hook using the Extension Framework\n./custom/Extension/modules/<module>/Ext/LogicHooks/<file>.php\n<?php\n    $hook_array['before_relationship_delete'][] = Array(\n        //Processing index. For sorting the array.\n        1,\n        //Label. A string value to identify the hook.\n        'before_relationship_delete example',\n        //The PHP file where your class is located.\n        'custom/modules/<module>/before_relationship_delete_class.php',\n        //The class the method is in.\n        'before_relationship_delete_class',\n        //The method to call.\n        'before_relationship_delete_method'\n    );\n?>\n./custom/modules/<module>/before_relationship_delete_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/before_relationship_delete/index.html"}
{"id": "b3761eb392ae-1", "text": "class before_relationship_delete_class\n    {\n        function before_relationship_delete_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/before_relationship_delete/index.html"}
{"id": "0cc34231f65e-0", "text": "before_restore\nOverview\nThe before_restore logic hook executes before a record gets undeleted (i.e. the deleted field's value changes from 1 to 0).\nDefinition\nfunction before_restore($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe bean object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event (typically empty)\nExamples\nCreating a Logic Hook using the Extension Framework\n./custom/Extension/modules/<module>/Ext/LogicHooks/<file>.php\n<?php\n        //Processing index. For sorting the array.\n        1,\n        //Label. A string value to identify the hook.\n        'before_restore example',\n        //The PHP file where your class is located.\n        'custom/modules/<module>/before_restore_class.php',\n        //The class the method is in.\n        'before_restore_class',\n        //The method to call.\n        'before_restore_method'\n    );\n?>\n./custom/modules/<module>/before_restore_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class before_restore_class\n    {\n        function before_restore_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\nCreating a Core Logic Hook\nPrior to Sugar 6.3.x, logic hooks could only be created using the following method. Please note that this approach is still valid but is not recommended when building plugins as it may conflict with existing customizations.\n./custom/modules/<module>/logic_hooks.php\n<?php\n$hook_version = 1;\n$hook_array = Array();\n$hook_array['before_restore'] = Array();\n$hook_array['before_restore'][] = Array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/before_restore/index.html"}
{"id": "0cc34231f65e-1", "text": "$hook_array['before_restore'][] = Array(\n//Processing index. For sorting the array.\n1, \n//Label. A string value to identify the hook.\n'before_restore example', \n//The PHP file where your class is located.\n'custom/modules/<module>/before_restore_class.php', \n//The class the method is in.\n'before_restore_class', \n//The method to call.\n'before_restore_method' \n);\n?>\n./custom/modules/<module>/before_restore_class.php\n<?php\nif (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nclass before_restore_class\n{\nfunction before_restore_method($bean, $event, $arguments)\n{\n//logic\n}\n}\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/before_restore/index.html"}
{"id": "3e7b8180786c-0", "text": "after_relationship_delete\nOverview\nThe after_relationship_delete hook executes after a relationship between two records has been deleted.\nDefinition\nfunction after_relationship_delete($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe bean object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event\narguments.id\nString\nModule ID\narguments.module\nString\nModule name\narguments.related_id\nString\nRelated module ID\narguments.related_module\nString\nRelated module name\narguments.link\nString\nLink field name\narguments.relationship\nString\nRelationship name\nConsiderations\nThis hook will be executed for each side of the relationship. For example, if you delete an association between an account and contact, the hook will run for both.\nThe 'arguments' parameter will have additional information regarding the records being modified. The $bean variable will not contain this information.\nChange Log\nVersion\nNote\n6.0.0\nAdded after_relationship_delete hook\nExamples\nCreating a Logic Hook using the Extension Framework\n./custom/Extension/modules/<module>/Ext/LogicHooks/<file>.php\n<?php\n    $hook_array['after_relationship_delete'][] = Array(\n        //Processing index. For sorting the array.\n        1,\n        //Label. A string value to identify the hook.\n        'after_relationship_delete example',\n        //The PHP file where your class is located.\n        'custom/modules/<module>/after_relationship_delete_class.php',\n        //The class the method is in.\n        'after_relationship_delete_class',\n        //The method to call.\n        'after_relationship_delete_method'\n    );\n?>\n./custom/modules/<module>/after_relationship_delete_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/after_relationship_delete/index.html"}
{"id": "3e7b8180786c-1", "text": "class after_relationship_delete_class\n    {\n        function after_relationship_delete_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\nCreating a Core Logic Hook\nPrior to Sugar 6.3.x, logic hooks could only be created using the following method. Please note that this approach is still valid but is not recommended when building plugins as it may conflict with existing customizations.\n./custom/modules/<module>/logic_hooks.php\n<?php\n   $hook_version = 1;\n   $hook_array = Array();\n   $hook_array['after_relationship_delete'] = Array();\n   $hook_array['after_relationship_delete'][] = Array(\n      //Processing index. For sorting the array.\n      1, \n      //Label. A string value to identify the hook.\n      'after_relationship_delete example', \n      //The PHP file where your class is located.\n      'custom/modules/<module>/after_relationship_delete_class.php', \n      //The class the method is in.\n      'after_relationship_delete_class', \n      //The method to call.\n      'after_relationship_delete_method' \n   );\n?>\n./custom/modules/<module>/after_relationship_delete_class.php\n<?php\n   if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n   class after_relationship_delete_class\n   {\n      function after_relationship_delete_method($bean, $event, $arguments)\n      {\n         //logic\n      }\n   }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/after_relationship_delete/index.html"}
{"id": "47d574635897-0", "text": "before_fetch_query\nOverview\nThe before_fetch_query\u00c2\u00a0logic hook executes\u00c2\u00a0before\u00c2\u00a0a sugar query\u00c2\u00a0has been executed.\nDefinition\nfunction before_fetch_query($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe bean object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event\narguments.query\nObject\nThe query to be executed\narguments.fields\nArray\nAn array\u00c2\u00a0of selected fields\nChange Log\nVersion\nNote\n7.7.0.0\nAdded before_fetch_query\u00c2\u00a0logic hook\nExamples\nCreating a Logic Hook using Extension Framework\n./custom/Extension/modules/<module>/Ext/LogicHooks/<file>.php\n<?php\n    $hook_array['before_fetch_query'][] = Array(\n        //Processing index. For sorting the array.\n        1,\n        //Label. A string value to identify the hook.\n        'before_fetch_query example',\n        //The PHP file where your class is located.\n        'custom/modules/<module>/before_fetch_query_class.php',\n        //The class the method is in.\n        'before_fetch_query_class',\n        //The method to call.\n        'before_fetch_query_method'\n    );\n?>\n./custom/modules/<module>/before_fetch_query_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class before_fetch_query_class\n    {\n        function before_fetch_query_method($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\nCreating a Core Logic Hook", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/before_fetch_query/index.html"}
{"id": "47d574635897-1", "text": "//logic\n        }\n    }\n?>\nCreating a Core Logic Hook\nPrior to Sugar 6.3.x, logic hooks could only be created using the following method. Please note that this approach is still valid but is not recommended when building plugins as it may conflict with existing customizations.\n./custom/modules/<module>/logic_hooks.php\n<?php\n   $hook_version = 1;\n   $hook_array = Array();\n   $hook_array['before_fetch_query'] = Array();\n   $hook_array['before_fetch_query'][] = Array(\n      //Processing index. For sorting the array.\n      1, \n      //Label. A string value to identify the hook.\n      'before_fetch_query example', \n      //The PHP file where your class is located.\n      'custom/modules/<module>/before_fetch_query_class.php', \n      //The class the method is in.\n      'logic_hooks_class', \n      //The method to call.\n      'before_fetch_query_method' \n   );\n?>\n./custom/modules/<module>/before_fetch_query_class.php\n<?php\n   if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n   class before_fetch_query_class\n   {\n      function before_fetch_query_method($bean, $event, $arguments)\n      {\n         //logic\n      }\n   }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/before_fetch_query/index.html"}
{"id": "88822cf2fb69-0", "text": "before_relationship_add\nOverview\nThe before_relationship_add logic hook executes before a relationship has been added between two records.\nDefinition\nfunction before_relationship_add($bean, $event, $arguments){}\nArguments\nName\nType\nDescription\nbean\nObject\nThe bean object\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event\narguments.id\nString\nModule ID\narguments.module\nString\nModule name\narguments.related_id\nString\nRelated module ID\narguments.related_module\nString\nRelated module name\narguments.link\nString\nLink field name\narguments.relationship\nString\nRelationship name\nConsiderations\nThis hook will be executed for each side of the relationship. For example, if you add an association between an account and a contact, the hook will run for both records.\nThe arguments parameter will have additional information regarding the records being modified. The $bean variable will not contain this information.\nChange Log\nVersion\nNote\n6.4.5\nAdded before_relationship_add hook\nExamples\nCreating a Logic Hook using the Extension Framework\n./custom/Extension/modules/<module>/Ext/LogicHooks/<file>.php\n<?php\n    $hook_array['before_relationship_add'][] = Array(\n        //Processing index. For sorting the array.\n        1,\n        //Label. A string value to identify the hook.\n        'before_relationship_add example',\n        //The PHP file where your class is located.\n        'custom/modules/<module>/before_relationship_add_class.php',\n        //The class the method is in.\n        'before_relationship_add_class',\n        //The method to call.\n        'before_relationship_add_method'\n    );\n?>\n./custom/modules/<module>/before_relationship_add_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/before_relationship_add/index.html"}
{"id": "88822cf2fb69-1", "text": "class before_relationship_add_class\n    {\n        function before_relationship_add($bean, $event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Module_Hooks/before_relationship_add/index.html"}
{"id": "bf0a7cd058ac-0", "text": "Application Hooks\nApplication hooks execute logic when working with the global application.\nTopicsafter_entry_pointThe after_entry_point application hook executes at the start of every request.after_load_userThe after_load_user hook executes after the current user is set for the current request. It handles actions that are dependent on the current user, such as setting ACLs or configuring user-dependent parameters.after_session_startThe after_session_start hook executes before the user's session starts, but after the user's visibility rules have been set up and the after_load_user logic hook has executed.after_ui_footerafter_ui_frameThe after_ui_frame hook executes after the frame has been invoked and before the footer has been invoked for modules in backward compatibility mode. This logic hook has been deprecated and will be removed in a future release.entry_point_variables_settingThe entry_point_variables_setting application hook executes at the start of every entry point.handle_exceptionThe handle_exception logic hook executes when an exception is thrown.server_round_tripExecutes at the end of every page.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Application_Hooks/index.html"}
{"id": "a7a67f7565d6-0", "text": "after_load_user\nOverview\nThe after_load_user\u00c2\u00a0hook executes after the current user is set for the current request. It handles actions that are dependent on the current user, such as setting ACLs or configuring user-dependent parameters.\nDefinition\nfunction after_load_user($event, $arguments){}\nArguments\nName\nType\nDescription\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event (typically empty)\nChange Log\nVersion\nNote\n6.6.0\nAdded after_load_user hook\nExample\n./custom/modules/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['after_load_user'] = Array();\n    $hook_array['after_load_user'][] = Array(\n        //Processing index. For sorting the array.\n        1, \n        //Label. A string value to identify the hook.\n        'after_load_user example',\n        //tde PHP file where your class is located.\n        'custom/modules/application_hooks_class.php',\n        //tde class the method is in.\n        'application_hooks_class', \n        //tde method to call.\n        'after_load_user_method' \n    );\n?>\n./custom/modules/application_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class application_hooks_class\n    {\n        function after_load_user_method($event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Application_Hooks/after_load_user/index.html"}
{"id": "d3db6be8bf64-0", "text": "after_ui_frame\nOverview\nThe after_ui_frame hook executes after the frame has been invoked and before the footer has been invoked for modules in backward compatibility mode.\u00c2\u00a0This logic hook has been deprecated and will be removed in a future\u00c2\u00a0release.\u00c2\u00a0\nDefinition\nfunction after_ui_frame($event, $arguments){}\nArguments\nName\nType\nDescription\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event (typically empty)\nConsiderations\nThis hook is only applicable for modules in backward compatibility mode.\nThis hook is executed on most views such as the DetailView, EditView, and Listview.\nApplication hooks do not make use of the $bean argument.\nThis is logic hook can be used as a global reference (./custom/modules/logic_hooks.php) or as a module reference (./custom/modules/<module>/logic_hooks.php).\nChange Log\nVersion\nNote\n7.10.0.0\nDeprecated after_ui_frame hook\n5.0.0a\nAdded after_ui_frame hook\nExample\nModule-Specific Hook\nThis hook can be used at the application level for all modules or limited to specific modules. An example limiting the hook for specific modules is shown below:\n./custom/modules/<module>/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['after_ui_frame'] = Array();\n    $hook_array['after_ui_frame'][] = Array(\n        //Processing index. For sorting the array.\n        1, \n        //Label. A string value to identify the hook.\n        'after_ui_frame example', \n        //The PHP file where your class is located.\n        'custom/modules/{module}/logic_hooks_class.php', \n        //The class the method is in.\n        'logic_hooks_class',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Application_Hooks/after_ui_frame/index.html"}
{"id": "d3db6be8bf64-1", "text": "//The class the method is in.\n        'logic_hooks_class', \n        //The method to call.\n        'after_ui_frame_method' \n    );\n?>\n./custom/modules/<module>/logic_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class logic_hooks_class\n    {\n        function after_ui_frame_method($event, $arguments)\n        {\n            //display logic\n        }\n    }\n?>\nApplication Hook\nThis hook can be used at the application level for all modules or limited to specific modules. An example of executing the hook for all modules is shown below:\n./custom/modules/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['after_ui_frame'] = Array();\n    $hook_array['after_ui_frame'][] = Array(\n        //Processing index. For sorting the array.\n        1, \n        //Label. A string value to identify the hook.\n        'after_ui_frame example', \n        //The PHP file where your class is located.\n        'custom/modules/application_hooks_class.php', \n        //The class the method is in.\n        'application_hooks_class', \n        //The method to call.\n        'after_ui_frame_method' \n    );\n?>\n./custom/modules/application_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class application_hooks_class\n    {\n        function after_ui_frame_method($event, $arguments)\n        {\n            //display logic\n        }\n    }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Application_Hooks/after_ui_frame/index.html"}
{"id": "e38a379160ba-0", "text": "server_round_trip\nOverview\nExecutes at the end of every page.\nDefinition\nfunction server_round_trip($event, $arguments){}\nArguments\nName\nType\nDescription\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event (typically empty)\nConsiderations\nThis is a global logic hook where the logic hook reference must be placed in ./custom/modules/logic_hooks.php.\nIf you are intending to write display logic to the screen, you must first wrap the display logic in an if condition to prevent breaking the Ajax page loads:if (!isset($_REQUEST[\"to_pdf\"]) || $_REQUEST[\"to_pdf\"] == false)\n{\n    //display logic\n}\nThis hook is executed on all page loads.\nApplication hooks do not make use of the $bean argument.\nChange Log\nVersion\nNote\n5.0.0a\nAdded server_round_trip hook.\nExample\n./custom/modules/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['server_round_trip'] = Array();\n    $hook_array['server_round_trip'][] = Array(\n        //Processing index. For sorting the array.\n        1, \n        //Label. A string value to identify the hook.\n        'server_round_trip example', \n        //The PHP file where your class is located.\n        'custom/modules/application_hooks_class.php', \n        //The class the method is in.\n        'application_hooks_class', \n        //The method to call.\n        'server_round_trip_method' \n    );\n?>\n./custom/modules/application_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class application_hooks_class\n    {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Application_Hooks/server_round_trip/index.html"}
{"id": "e38a379160ba-1", "text": "class application_hooks_class\n    {\n        function server_round_trip_method($event, $arguments)\n        {\n            //display logic should check for $_REQUEST[\"to_pdf\"]\n        }\n    }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Application_Hooks/server_round_trip/index.html"}
{"id": "8d72fbd4b300-0", "text": "after_session_start\nOverview\nThe after_session_start\u00c2\u00a0hook executes before the user's session starts, but after the user's visibility rules have been set up and the after_load_user logic hook has executed.\nDefinition\nfunction after_session_start($event, $arguments){}\nArguments\nName\nType\nDescription\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event (typically empty)\nChange Log\nVersion\nNote\n6.4.3\nAdded after_session_start hook\nExample\n./custom/modules/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['after_session_start'] = Array();\n    $hook_array['after_session_start'][] = Array(\n        //Processing index. For sorting the array.\n        1, \n        //Label. A string value to identify the hook.\n        'after_session_start example',\n        //The PHP file where your class is located.\n        'custom/modules/application_hooks_class.php',\n        //The class the method is in.\n        'application_hooks_class', \n        //The method to call.\n        'after_session_start_method' \n    );\n?>\n./custom/modules/application_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class application_hooks_class\n    {\n        function after_session_start_method($event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Application_Hooks/after_session_start/index.html"}
{"id": "e90be05c3e7e-0", "text": "handle_exception\nOverview\nThe handle_exception logic hook executes when an exception is thrown.\nDefinition\nfunction handle_exception($event, $exception){}\nArguments\nName\nType\nDescription\nevent\nString\nThe current event\nexception\nObject\nThe exception object\nConsiderations\nThis hook should not be used for any type of display output.\nYou can retrieve the exception message by using $exception->getMessage(). All exception classes extend the PHP Exceptions class.\nChange Log\nVersion\nNote\n6.4.4\nAdded handle_exception hook\nExample\n./custom/modules/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['handle_exception'] = Array();\n    $hook_array['handle_exception'][] = Array(\n        //Processing index. For sorting the array.\n        1, \n        //Label. A string value to identify the hook.\n        'handle_exception example', \n        //The PHP file where your class is located.\n        'custom/modules/handle_exception_class.php',\n        //The class the method is in. \n        'handle_exception_class',\n        //The method to call. \n        'handle_exception_method' \n    );\n?>\n./custom/modules/handle_exception_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class handle_exception_class\n    {\n        function handle_exception_method($event, $exception)\n        {\n            //logic with $exception->getMessage()\n        }\n    }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Application_Hooks/handle_exception/index.html"}
{"id": "0ca11f4cf755-0", "text": "after_ui_footer\n  \tLast modified:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Application_Hooks/after_ui_footer/index.html"}
{"id": "4883f67075dd-0", "text": "entry_point_variables_setting\nOverview\nThe entry_point_variables_setting\u00c2\u00a0application hook executes at the start of every entry\u00c2\u00a0point.\nDefinition\nfunction entry_point_variables_setting($event, $arguments){}\nArguments\nName\nType\nDescription\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event\u00c2\u00a0(typically\u00c2\u00a0empty)\nConsiderations\nThe entry_point_variables_setting\u00c2\u00a0hook is a global logic hook where the logic hook reference must be placed in ./custom/modules/logic_hooks.php.\nThis hook is executed at the start of every request at the end of ./include/entryPoint.php.\nThis hook\u00c2\u00a0does\u00c2\u00a0not make use of the $bean argument.\nChange Log\nVersion\nNote\n6.4.3\nAdded entry_point_variables_setting hook\nExample\n./custom/modules/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['entry_point_variables_setting'] = Array();\n    $hook_array['entry_point_variables_setting'][] = Array(\n        //Processing index. For sorting the array.\n        1, \n        //Label. A string value to identify the hook.\n        'entry_point_variables_setting example', \n        //The PHP file where your class is located.\n        'custom/modules/application_hooks_class.php',\n        //The class the method is in. \n        'application_hooks_class',\n        //The method to call. \n        'entry_point_variables_setting_method' \n    );\n?>\n./custom/modules/application_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class application_hooks_class\n    {\n        function entry_point_variables_setting_method($event, $arguments)\n        {\n            //logic\n        }", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Application_Hooks/entry_point_variables_setting/index.html"}
{"id": "4883f67075dd-1", "text": "{\n            //logic\n        }\n    }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Application_Hooks/entry_point_variables_setting/index.html"}
{"id": "ea00b1069d6c-0", "text": "after_entry_point\nOverview\nThe after_entry_point\u00c2\u00a0application hook executes at the start of every request.\nDefinition\nfunction after_entry_point($event, $arguments){}\nArguments\nName\nType\nDescription\nevent\nString\nThe current event\narguments\nArray\nAdditional information related to the event\u00c2\u00a0(typically\u00c2\u00a0empty)\nConsiderations\nThe after_entry_point\u00c2\u00a0hook is a global logic hook where the logic hook reference must be placed in ./custom/modules/logic_hooks.php.\nThis hook is executed at the start of every request at the end of ./include/entryPoint.php.\nThis hook should not be used for any type of display output.\nThe after_entry_point\u00c2\u00a0hook is ideally used for logging or loading libraries.\nApplication hooks do not make use of the $bean argument.\nChange Log\nVersion\nNote\n6.4.3\nAdded after_entry_point hook\nExample\n./custom/modules/logic_hooks.php\n<?php\n    $hook_version = 1;\n    $hook_array = Array();\n    $hook_array['after_entry_point'] = Array();\n    $hook_array['after_entry_point'][] = Array(\n        //Processing index. For sorting the array.\n        1, \n        //Label. A string value to identify the hook.\n        'after_entry_point example', \n        //The PHP file where your class is located.\n        'custom/modules/application_hooks_class.php',\n        //The class the method is in. \n        'application_hooks_class',\n        //The method to call. \n        'after_entry_point_method' \n    );\n?>\n./custom/modules/application_hooks_class.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n    class application_hooks_class\n    {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Application_Hooks/after_entry_point/index.html"}
{"id": "ea00b1069d6c-1", "text": "class application_hooks_class\n    {\n        function after_entry_point_method($event, $arguments)\n        {\n            //logic\n        }\n    }\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Logic_Hooks/Application_Hooks/after_entry_point/index.html"}
{"id": "3584aebc8ef8-0", "text": "Entry Points\nOverview\nEntry points, defined in ./include/MVC/Controller/entry_point_registry.php, were\u00c2\u00a0used to ensure that proper security and authentication steps are applied consistently across the entire application. While they are still used in some areas of Sugar, any developers using custom entry points should adjust their customizations to use the latest\u00c2\u00a0REST API endpoints\u00c2\u00a0instead.\nAccessing Entry Points\nAvailable custom entry points can be accessed using a URL pattern as follows:\nhttp://{sugar url}/index.php?entryPoint={entry point name}\nThe entry point name will be the specified index in the $entry_point_registry array. Access to this entry point outside of sugar will be dependent on the auth parameter defined in the $entry_point_registry array as well.\u00c2\u00a0For more information, refer to the Creating Custom Entry Points page.\nTopicsCreating Custom Entry PointsAs of 6.3.x, entry points can be created using the extension framework. The entry point extension directory, located at ./custom/Extension/application/Ext/EntryPointRegistry/, is compiled into ./custom/application/Ext/EntryPointRegistry/entry_point_registry.ext.php after a Quick Repair and Rebuild. Additional information can be found in the extensions EntryPointRegistry section.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Entry_Points/index.html"}
{"id": "7f273e415c85-0", "text": "Creating Custom Entry Points\nOverview\nAs of 6.3.x, entry points can be created using the extension framework. The entry point extension directory, located at ./custom/Extension/application/Ext/EntryPointRegistry/,\u00c2\u00a0is compiled into ./custom/application/Ext/EntryPointRegistry/entry_point_registry.ext.php after a Quick Repair and Rebuild. Additional information can be found in the extensions EntryPointRegistry section.\nCustom Entry Points\nPrior to 6.3.x, an entry point\u00c2\u00a0could be added\u00c2\u00a0by creating the file ./custom/include/MVC/Controller/entry_point_registry.php. This method of creating entry points is still compatible but is not recommended from a best practices standpoint as duplicating ./include/MVC/Controller/entry_point_registry.php to ./custom/include/MVC/Controller/entry_point_registry.php\u00c2\u00a0will prevent any upgrader updates to\u00c2\u00a0./include/MVC/Controller/entry_point_registry.php from being reflected in the system. Entry point registries contain two properties:\nfile - The path to the entry point.\nauth - A Boolean value that determines whether or not the user must be authenticated in order to access the entry point.\n$entry_point_registry['customEntryPoint'] = array(\n    'file' => 'path/to/customEntryPoint.php',\n    'auth' => true\n);\nExample\nThe first step is to create the actual entry point. This is where all of the logic for your entry point will be located. This file can be located anywhere you choose. For my example, I will create:\n./custom/customEntryPoint.php\n<?php\nif(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\necho \"Hello World!\";\nNext, we will need to create our extension in the application extensions. This will be located at: ./custom/Extension/application/Ext/EntryPointRegistry/customEntryPoint.php\n<?php", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Entry_Points/Creating_Custom_Entry_Points/index.html"}
{"id": "7f273e415c85-1", "text": "<?php\n$entry_point_registry['customEntryPoint'] = array(\n    'file' => 'custom/customEntryPoint.php',\n    'auth' => true\n);\nFinally, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then generate the file ./custom/application/Ext/EntryPointRegistry/entry_point_registry.ext.php containing your registry entry. We are now able to access our entry point by navigating to:\nhttp://{sugar url}/index.php?entryPoint=customEntryPoint\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Entry_Points/Creating_Custom_Entry_Points/index.html"}
{"id": "0fec96e0fe0f-0", "text": "Shortcuts\nOverview\nShortcuts is\u00c2\u00a0a framework to add shortcut keys to the application. When shortcut keys are registered, they are registered to a particular shortcut session. Shortcut sessions group shortcut keys, and they can be activated, deactivated, saved, and restored. Global shortcut keys can be registered, but they are not tied to a particular shortcut session. They are rather applied everywhere in the application and can only be applied once.\nThe Shortcut framework is implemented on top of Mousetrap library.\nShortcut Sessions\nIn order to register a shortcut in Sugar, a shortcut session must first be created by adding ShortcutSession plugin to the top-level layout JavaScript controller.\nplugins: ['ShortcutSession']\nThen, the top-level layout needs to list which shortcuts are allowed in the shortcut session. Shortcuts\u00c2\u00a0can be listed in the top-level layout JavaScript controller :\n./custom/clients/layout/my-layout/my-layout.js\nshortcuts: [\n    'Sidebar:Toggle',\n    'Record:Save',\n    'Record:Cancel',\n    'Record:Action:More'\n]\nShortcuts can also be listed in the metadata :\n./custom/clients/layout/my-layout/my-layout.php\n'shortcuts' => array(\n    'Sidebar:Toggle',\n    'Record:Save',\n    'Record:Cancel',\n    'Record:Action:More'\n),\nRegister\nOnce a shortcut session is created, shortcut keys can be registered by adding the following in your JavaScript code :\napp.shortcuts.register('<unique shortcut ID>', '<shortcut keys>', <callback function>, <current component>, <call on focus?>);\nSince shortcut keys should only be registered once in your component, they should be registered inside initialize() or someplace where re-rendering the component would not register more than once.\nShortcut IDs", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Shortcuts/index.html"}
{"id": "0fec96e0fe0f-1", "text": "Shortcut IDs\nShortcut IDs should be unique across the application. They should be namespaced by convention, for example Record:Next, Sidebar:Toggle, List:Edit. If the namespace starts with Global:, it assumes that the shortcut is global.\nGlobal shortcuts\nGlobal shortcuts are shortcut keys that are applied once and are available everywhere in the application.\napp.shortcuts.register(app.shortcuts.GLOBAL + 'Footer:Help', '?', function() {}, this, false);\nShortcut Keys\nThere are only certain keys that are\u00c2\u00a0supported under the Shortcut framework. The following keyboard keys can be used :\u00c2\u00a0\nAll alphanumeric characters and symbols\nshift, ctrl, alt, option, meta, command\nbackspace, tab, enter, return, capslock, esc, escape, space, pageup, pagedown, end, home, ins, del\nleft, up, right, down\nAdditional Features\nIn addition to standard keys, the Shortcut framework also supports some additional features :\nKey combinations\u00c2\u00a0: 'ctrl+s'\nMultiple keys\u00c2\u00a0: ['ctrl+a', 'command+a']\nKey sequences\u00c2\u00a0: 'f a'\nInput Focus\nThe fifth parameter in the register method specifies whether or not the shortcut key should be fired when the user is focused in an input field. It is false by default.\napp.shortcuts.register('Record:Save', ['ctrl+s','command+s'], function() {}, this, true);\nLimitations\nShortcut keys do not work on side panels, like dashboards and previews.\nShortcuts Help\nAnytime a new shortcut is created, a help text should be provided in ./clients/base/layouts/shortcuts/shortcuts.php with a shortcut ID and a language string.\n'List:Favorite' => 'LBL_SHORTCUT_FAVORITE_RECORD',\nShortcuts help is displayed when Shortcuts button is clicked.\nAdvanced Features\nEnable/disable dynamically", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Shortcuts/index.html"}
{"id": "0fec96e0fe0f-2", "text": "Shortcuts help is displayed when Shortcuts button is clicked.\nAdvanced Features\nEnable/disable dynamically\nShortcuts feature can be enabled and disabled dynamically via code by calling app.shortcuts.enable() and app.shortcuts.disable().\nDynamically saving, creating new, and restoring sessions\nA new shortcut session is created when a user visits a top-level layout with ShortcutSession plugin. A new session can be created dynamically:\napp.shortcuts.createSession(<array of shorcut IDs>, <component>);\nBut before creating a new session, the current session should be saved first.\napp.shortcuts.saveSession();\napp.shortcuts.createSession(<array of shorcut IDs>, <component>);\nOnce a new session is created, shortcut keys can be registered to it. When the need for the session is done, the previous shortcut session can be restored.\napp.shortcuts.restoreSession();\nExample\nThe following example will be\u00c2\u00a0to add some custom shortcuts onto a custom layout. For more information on how to create a custom layout, please refer to the Creating Layouts  documentation.\nFirst, on our custom JavaScript controller for our layout, we must enable the ShortcutSession plugin as well as list the shortcuts we will be enabling :\n./custom/clients/base/layouts/my-layout/my-layout.js\n({\n    plugins: ['ShortcutSession'],\n    shortcuts: [\n        'Global:MyLayout:MyCallback',\n    ],\n})\nNext, on the custom view being rendered on our layout, we will register the new shortcuts as well as define a callback method :\u00c2\u00a0\n./custom/clients/base/views/my-view/my-view.js\n...\ninitialize: function(options){\n    this._super('initialize', [options]);\n    // call myCallback method when command + a is pressed\n    app.shortcuts.register(app.shortcuts.GLOBAL + 'MyLayout:MyCallback', 'command+a', this.myCallback, this, false);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Shortcuts/index.html"}
{"id": "0fec96e0fe0f-3", "text": "app.shortcuts.saveSession();\n    app.shortcuts.createSession([\n        'MyLayout:InlineCall'\n    ], this);\n    // call inline code when control + m or command + m is pressed\n    app.shortcuts.register('MyLayout:InlineCall', ['ctrl+m','command+m'], function() {\n\t\tconsole.log(\"Ctrl or Command m has been pressed\");\n    }, this, false);\n},\nmyCallback: function(){\n    console.log(\"MyCallback called from Command a\");\n},\n...\nThe last step will be to create a new label for our shortcut help text and register the help so it displays when \"Shortcuts\" is click in the footer of the page :\n./custom/Extension/application/Ext/Language/en_us.LBL_MYLAYOUT_SHORTCUT_HELP.php\n<?php\n$app_strings['LBL_MYLAYOUT_MYCALLBACK_HELP'] = \"Activates my Callback Method\";\n$app_strings['LBL_MYLAYOUT_MYINLINECALL_HELP'] = \"Activates Inline Code\";\n./custom/Extension/application/Ext/clients/base/layouts/shortcuts/shortcuts.php\n<?php\n$viewdefs['base']['layout']['shortcuts']['help']['Global:MyLayout:MyCallback'] = 'LBL_MYLAYOUT_MYCALLBACK_HELP';\n$viewdefs['base']['layout']['shortcuts']['help']['MyLayout:InlineCall'] = 'LBL_MYLAYOUT_MYINLINECALL_HELP';\nNavigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions and add the new shortcut to the custom layout.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Shortcuts/index.html"}
{"id": "3d98ccab8432-0", "text": "Autoloader\nOverview\nThe autoloader is an API that allows the unified handling of customizations and customizable metadata while reducing the number of filesystem accesses and improving performance.\nSugarAutoLoader\nThe SugarAutoLoader class, located in ./include/utils/autoloader.php, keeps a map of files within the Sugar directory that may be loaded.\nIncluded File Extensions\nThe autoloader will only map files with the following extensions:\nbmp\ncss\ngif\nhbs\nhtml\nico\njpg\njs\nless\noverride\nphp\npng\ntif\ntpl\nxml\n*All other file extensions are excluded from the mapping.\nClass Loading Directories\nThe autoloader will scan and autoload classes in the following directories:\n./clients/base/api/\n./data/duplicatecheck/\n./data/Relationships/\n./data/visibility/\n./include/\n./include/api/\n./include/CalendarEvents/\n./include/SugarSearchEngine/\n./modules/Calendar/\n./modules/Mailer/\nIgnored Directories\nThe following directories in Sugar are ignored by the autoloader mapping:\n./.idea/\n./cache/\n./custom/backup/\n./custom/blowfish/\n./custom/Extension/\n./custom/history/\n./custom/modulebuilder/\n./docs/\n./examples/\n./portal/\n./tests/\n./upload/\n./vendor/bin/\n./vendor/HTMLPurifier/\n./vendor/log4php/\n./vendor/nusoap/\n./vendor/pclzip/\n./vendor/reCaptcha/\n./vendor/ytree/\n\u00c2", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Autoloader/index.html"}
{"id": "3d98ccab8432-1", "text": "./vendor/reCaptcha/\n./vendor/ytree/\n\u00c2\u00a0\nTopicsConfiguration APIMethods to configure loading paths for the AutoLoader API.File Check APIFile check methods for use with the AutoLoader API.File Map Modification APIMethods to modify files in the AutoLoader API. All the functions below return true on success and false on failure.Metadata APIMethods to load metadata for the AutoLoader API.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Autoloader/index.html"}
{"id": "1a87c4d45a0c-0", "text": "File Check API\nOverview\nFile check methods for use with the AutoLoader API.\nexisting(...)\nReturns an array of filenames that exist in the file map. Accepts any number of arguments of which can be filename or array of filenames. If no files exist, empty array is returned. \n$files = SugarAutoloader::existing('include/utils.php', 'include/TimeDate.php');\nexistingCustom(...)\nThis method accepts any number of arguments, each of which can be filename or array of filenames. It will return an array of filenames that exist in the file map, adding also files that exist when custom/ is prepended to them. If the original\n            filename already had custom/ prefix, it is not prepended again. custom/ files are added to the list after the root directory files so that if included in order, they will override the data of the root file. If no files exist, empty array is\n            returned. \n$files = SugarAutoloader::existingCustom('include/utils.php', 'include/TimeDate.php');\nexistingCustomOne(...)\nReturns the last file of the result returned by existingCustom(), or null if none exist. Accepts any number of arguments of which can be filename or array of filenames. Since customized files are placed after the root files, it will return customized file if exists, otherwise root file.\n         \n$files = SugarAutoloader::existingCustomOne('include/utils.php');\nYou should note that the existingCustomOne() method can be used for loading inline PHP files. An example is shown below: \nforeach(SugarAutoLoader::existingCustomOne('custom/myFile.php') as $file)\n{\n    include $file;\n}\nAlternative to including inline PHP files, loading class files should be done using requireWithCustom() .\nfileExists($filename)", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Autoloader/File_Check_API/index.html"}
{"id": "1a87c4d45a0c-1", "text": "fileExists($filename)\nChecks if a file exists in the file map. You should note that \"..\" is not supported by this function and any paths including \"..\" will return false. The path components should be separated by /.\n            You should also note that multiple slashes are compressed and treated as single slash.\n$file = 'include/utils.php';\nif (SugarAutoloader::fileExists($file))\n{\n    require_once($file);\n}\ngetDirFiles($dir, $get_dirs = false, $extension = null)\nRetrieves the list of files existing in the file map under the specified directory. If no files are found, the method will return an empty array. By default, the method will return file paths, however, If $get_dirs is set to true, the method will\n            return only directories. If $extension is set, it would return only files having that specific extension.\n         \n$files = SugarAutoloader::getDirFiles('include');\ngetFilesCustom($dir, $get_dirs = false, $extension = null)\nRetrieves the list of files existing in the file map under the specified directory and under it's custom/ path. If no files are found it will return empty array. By default, the method will return file paths, however, If $get_dirs is set to true,\n            the method will return only directories. If $extension is set, it would return only files having that specific extension.\n         \n$files = SugarAutoloader::getFilesCustom('include');\nlookupFile($paths, $file)\nLooks up a file in the list of given paths, including with and without custom/ prefix, and return the first match found. The custom/ directory is checked before root files. If no file is found, the method will return false. \n$paths = array(\n  'include',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Autoloader/File_Check_API/index.html"}
{"id": "1a87c4d45a0c-2", "text": "$paths = array(\n  'include',\n  'modules',\n);\n$files = SugarAutoloader::lookupFile($paths, 'utils.php');\nrequireWithCustom($file, $both = false)\nIf a custom/ override of the file or the file exist, require_once it and return true, otherwise return false. If $both is set to true, both files are required with the root file being first and custom/ file being second. Unlike other functions,\n            this function will actually include the file. \n$file = SugarAutoloader::requireWithCustom('include/utils.php');\nYou should note that the requireWithCustom() method should be used for loading class files and not inline PHP files. Inline PHP files should be loaded using the existingCustomOne() \n            method.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Autoloader/File_Check_API/index.html"}
{"id": "52b0f92c887f-0", "text": "File Map Modification API\nOverview\nMethods to modify files in the AutoLoader API. All the functions below return true on success and false on failure.\naddToMap($filename, $save = true)\nAdds an existing file to the file map. If $save is true, the new map will be saved to the disk file map, otherwise, it will persist only until the end of the request. This method does not create the file on the filesystem.\nSugarAutoloader::addToMap('custom/myFile.php');\ndelFromMap($filename, $save = true)\nRemoves a file from the file map. If $filename points to a directory, this directory and all files under it are removed from the map. If $save is true, the new map will be saved to the disk file map, otherwise, it will persist only until the end of the request. This method does not delete the file from the filesystem.\nSugarAutoloader::delFromMap('custom/myFile.php');\nput($filename, $data, $save = false)\nSaves data to a file on the filesystem and adds it to the file map. If $save is true, the new map will be saved to the disk file map, otherwise, it will persist only until the end of the request.\n$file = 'custom/myFile.php';\nSugarAutoloader::touch($file, true);\nSugarAutoloader::put($file, '<?php /*file content*/ ?>', true);\ntouch($filename, $save = false)\nCreates the specified file on the filesystem and adds it to the file map. If $save is true, the new map will be saved to the disk file map, otherwise, it will persist only until the end of the request.\nSugarAutoloader::touch('custom/myFile.php', true);\nunlink($filename, $save = false)", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Autoloader/File_Map_Modification_API/index.html"}
{"id": "52b0f92c887f-1", "text": "unlink($filename, $save = false)\nRemoves the specified file from the filesystem and from the\u00c2\u00a0current file map. If $save is true, the new map will be saved to the disk file map, otherwise, it will persist only until the end of the request.\nSugarAutoloader::unlink('custom/myFile.php', true);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Autoloader/File_Map_Modification_API/index.html"}
{"id": "13a51e6a8435-0", "text": "Metadata API\nOverview\nMethods to load metadata for the AutoLoader API.\nMetadata Loading\nFor the specific sets of metadata, such as detailviewdefs, editviewefs, listviewdefs, searchdefs, popupdefs, and searchfields, a special process is used to load the correct metadata file. You should note that the variable name for the defs, e.g. \"detailviewdefs\", is usually the same as variable name, except in the case of \"searchfields\" where it is \"SearchFields\".\nThe process is described below:\nIf ./custom/modules/{$module}/metadata/{$varname}.php exists, it is used as the data file.\nIf ./modules/{$module}/metadata/metafiles.php or ./custom/modules/{$module}/metadata/metafiles.php exists, it is loaded with the custom file being preferred. If the variable name exists in the data specified by the metafile, the corresponding filename is assumed to be the defs file name.\nIf the defs file name or its custom/ override exists, it is used as the data file (custom one is preferred).\nIf no file has been found yet, ./modules/{$module}/metadata/{$varname}.php is checked and if existing, it is used as the data file.\nOtherwise, no metadata file is used.\nloadWithMetafiles($module, $varname)\nReturns the specified metadata file for a specific module. You should note that due to the scope nature of include(), this function does not load the actual metadata file but will return the file name that should be loaded by the caller.\n$metadataPath = SugarAutoloader::loadWithMetafiles('Accounts', 'editviewdefs');\nloadPopupMeta($module, $metadata = null)\nLoads popup metadata for either specified $metadata variable or \"popupdefs\" variable via loadWithMetafiles() and returns it. If no metadata found returns empty array.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Autoloader/Metadata_API/index.html"}
{"id": "13a51e6a8435-1", "text": "$popupMetadata = SugarAutoloader::loadPopupMeta('Accounts');\nloadExtension($extname, $module = \"application\")\nReturns the extension path given the extension name and module. For global extensions, the module should be \"application\" and may be omitted. If the extension has its own module, such as schedulers, it will be used instead of the $module parameter. You should note that due to the scope nature of include(), this function does not load the actual metadata file but return the file name that should be loaded by the caller. If no extension file exists it will return false.\n//The list of extensions can be found in ./ModuleInstall/extensions.php\n$extensionPath = SugarAutoloader::loadExtension('logichooks');\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Autoloader/Metadata_API/index.html"}
{"id": "37ff79c29ad8-0", "text": "Configuration API\nOverview\nMethods to configure loading paths for the AutoLoader API.\naddDirectory($dir)\nAdds a directory to the directory map for loading classes. Directories added should include a trailing \"/\".\nSugarAutoloader::addDirectory('relative/file/path/');\naddPrefixDirectory($prefix, $dir)\nAdds a prefix and directory to the $prefixMap for loading classes by prefix.\nSugarAutoloader::addPrefixDirectory('myPrefix', 'relative/file/path/');\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Autoloader/Configuration_API/index.html"}
{"id": "2bed4a683c7b-0", "text": "Email Addresses\nOverview\nRecommended approaches when working with email addresses in Sugar.\nClient Side\nRecommended approaches when accessing email addresses in Sugar from a client.\nSidecar\nSidecar is the JavaScript UI framework that users interact within their browsers.\nFetching Email Addresses in Sidecar\nIn Sidecar, the email field will return an array of email addresses and their properties for the record. Given the model, you can fetch it using:\nvar emailAddresses = model.get('email');\nNote:\u00c2\u00a0In the past, developers could use\u00c2\u00a0model.get(\"email1\") to fetch the primary email address. While this currently does work,\u00c2\u00a0these legacy email fields are\u00c2\u00a0deprecated\u00c2\u00a0and may be subject to removal in an upcoming Sugar release.\nFetching a Primary Email Address in Sidecar\nTo fetch the primary email address for a bean, you can use app.utils.getPrimaryEmailAddress():\nvar primaryEmailAddress = app.utils.getPrimaryEmailAddress(model);\nFetching an Email Address by Properties in Sidecar\nTo fetch an email address based on properties such as invalid_email, you can use app.utils.getEmailAddress(). This function will return the first email address that matches the options or an empty string if not found. An example is shown below:\nvar emailAddress = app.utils.getEmailAddress(model, {invalid_email: true});\nIf you have complex filtering rules, you can use _.find() to fetch an email address:\nvar emailAddress = _.find(model.get('email'), function(emailAddress){ \n    if (emailAddress.invalid_email == true) {\n        return emailAddress;\n    }\n});\nValidating Email Addresses in Sidecar\nTo validate an email address, you can use app.utils.isValidEmailAddress():\nvar isValid = app.utils.isValidEmailAddress(emailAddress);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Email_Addresses/index.html"}
{"id": "2bed4a683c7b-1", "text": "var isValid = app.utils.isValidEmailAddress(emailAddress);\nNote: This function is more permissive and does not conform exactly to the RFC standards used on the server. As such, the\u00c2\u00a0email address\u00c2\u00a0will be validated again on the\u00c2\u00a0server\u00c2\u00a0when the\u00c2\u00a0record is saved, which could still fail validation.\u00c2\u00a0More information can be found in the email address validation section.\nIterating Email Address in Sidecar\nTo iterate through email addresses on a model, you can use _.each():\n_.each(model.get('email'), function(emailAddress) {\n    console.log(emailAddress.email_address);\n});\nUpdating Email Addresses in Sidecar\nThis section covers how to manipulate the email addresses for a model.\nAdding Email Addresses in Sidecar\nIn Sidecar, you can add email addresses to a model using the custom function below:\nfunction addAddress(model, email) {\n    var existingAddresses = model.get('email') ? app.utils.deepCopy(model.get('email')) : [],\n        dupeAddress = _.find(existingAddresses, function(address){\n            return (address.email_address === email);\n        }),\n        success = false;\n    if (_.isUndefined(dupeAddress)) {\n        existingAddresses.push({\n            email_address: email,\n            primary_address: (existingAddresses.length === 0),\n            opt_out: app.config.newEmailAddressesOptedOut || false\n        });\n        model.set('email', existingAddresses);\n        success = true;\n    }\n    return success;\n}\nRemoving Email Addresses in Sidecar\nIn Sidecar, you can remove email addresses from a model using the custom function below:\nfunction removeAddress(model, email) {\n    var existingAddresses = app.utils.deepCopy(model.get('email'));\n    var index = false;\n    _.find(existingAddresses, function(emailAddress, idx){", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Email_Addresses/index.html"}
{"id": "2bed4a683c7b-2", "text": "_.find(existingAddresses, function(emailAddress, idx){ \n        if (emailAddress.email_address === email) {\n            index = idx;\n            return true;\n        }\n    });\n    var primaryAddressRemoved = false;\n    if (index !== false) {\n        primaryAddressRemoved = !!existingAddresses[index]['primary_address'];\n    }\n    //Reject this index from existing addresses\n    existingAddresses = _.reject(existingAddresses, function (emailInfo, i) { return i == index; });\n    // If a removed address was the primary email, we still need at least one address to be set as the primary email\n    if (primaryAddressRemoved) {\n        //Let's pick the first one\n        var address = _.first(existingAddresses);\n        if (address) {\n            address.primary_address = true;\n        }\n    }\n    model.set('email', existingAddresses);\n    return primaryAddressRemoved;\n}\nServer Side\nRecommended approaches when accessing email addresses in Sugar from the server.\nSugarBean\nThe SugarBean is Sugars PHP core object model.\nFetching Email Addresses Using the SugarBean\nUsing the SugarBean, the $bean->emailAddress->addresses\u00c2\u00a0property will return an array of email addresses and its properties. The\u00c2\u00a0$bean->emailAddress\u00c2\u00a0property makes use of the EmailAddress class which is located in\u00c2\u00a0./modules/EmailAddresses/EmailAddress.php. An example is shown below:\n$emailAddresses = $bean->emailAddress->addresses;\nFetching a Primary Email Address Using the SugarBean\nTo fetch the primary email address for a bean, you can use $bean->emailAddress->getPrimaryAddress():\n$primaryEmailAddress = $bean->emailAddress->getPrimaryAddress($bean);\nAnother alternative is to use the\u00c2\u00a0email_addresses_primary relationship:\n$primaryEmailAddress = false;", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Email_Addresses/index.html"}
{"id": "2bed4a683c7b-3", "text": "$primaryEmailAddress = false;\nif ($this->load_relationship('email_addresses_primary')) {\n    $relatedBeans = $this->email_addresses_primary->getBeans();\n    if (!empty($relatedBeans)) {\n        $primaryEmailAddress = current($relatedBeans);\n    }\n}\nYou may also choose to iterate the email address list with a foreach(). An example function is shown below:\nfunction getPrimaryEmailAddress($bean)\n{\n    foreach ($bean->emailAddress->addresses as $emailAddress) {\n        if ($emailAddress['primary_address'] == true) {\n            return $emailAddress;\n        }\n    }\n    return false;\n}\nFetching an Email Address by Properties Using the SugarBean\nTo fetch an email address based on properties such as invalid_email, you can use a foreach():\n$result = false;\nforeach ($bean->emailAddress->addresses as $emailAddress) {\n    if ($emailAddress['invalid_email']) {\n        $result = $emailAddress;\n        break;\n    }\n}\nValidating Email Addresses Using the SugarBean\nTo validate an email address, you can use $bean->emailAddress->isValidEmail():\n$isValid = $bean->emailAddress->isValidEmail($emailAddress);\nNote: The\u00c2\u00a0EmailAddress::isValidEmail method leverages the PHPMailer library bundled with Sugar, specifically the PHPMailer::validateAddress method, which validates the address\u00c2\u00a0according to the\u00c2\u00a0RFC 5321\u00c2\u00a0and RFC 5322 standards. More information can be found in the email address validation section.\nIterating Email Addresses Using the SugarBean\nTo iterate through email addresses on a bean, you can use foreach():\nforeach ($bean->emailAddress->addresses as $emailAddress) {\n    $GLOBALS['log']->info($emailAddress['email_address']);\n}\nFetching Beans by Email Address Using the SugarBean", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Email_Addresses/index.html"}
{"id": "2bed4a683c7b-4", "text": "}\nFetching Beans by Email Address Using the SugarBean\nTo fetch all beans related to an email address you can use\u00c2\u00a0getBeansByEmailAddress():\n$beans = $bean->emailAddress->getBeansByEmailAddress($emailAddress);\nIf you don't have a bean available, you may choose to create a new EmailAddress object:\n$sea = BeanFactory::newBean('EmailAddresses');\n$sea->getBeansByEmailAddress($emailAddress);\nUpdating Email Addresses Using the SugarBean\nThis section covers how to manipulate the email addresses for a bean.\nAdding Email Addresses Using the SugarBean\nTo add an email address to the bean, you can use\u00c2\u00a0$bean->emailAddress->addAddress():\n$bean->emailAddress->addAddress('address@sugar.crm');\nNote: The addAddress() function has additional parameters that are defaulted for determining if the email address is a primary, reply to, invalid, or opted out email address. You can also specify an id for the email address and whether or not the email address should be validated.\nfunction addAddress($addr, $primary=false, $replyTo=false, $invalid=false, $optOut=false, $email_id = null, $validate = true)\nRemoving Email Addresses Using the SugarBean\nTo remove an email address you can use $bean->emailAddress->removeAddress():\n$bean->emailAddress->removeAddress('address@sugar.crm');\nPDF Templates\nUsing the Sugar PDF templates, you can reference the primary email address of the bean using:\n{$fields.email_addresses_primary.email_address}\nREST API\nSugar comes out of the box with an API that can be called from custom applications utilizing the REST interface. The API can be used to mass create and update records in Sugar with external data. For more information on the REST API in Sugar, please refer to the Web Services documentation.\nCreating Email Addresses Using the REST API", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Email_Addresses/index.html"}
{"id": "2bed4a683c7b-5", "text": "Creating Email Addresses Using the REST API\nWhen creating records in Sugar through the API, modules with relationships to email addresses can utilize the email link field to specify email addresses for a record. Using the email link field, you can specify multiple email addresses to assign to the record. You may specify the following additional information regarding each email address being added:\nProperty\nDescription\ninvalid_email\nSpecify this email address as being invalid\nopt_out\nSpecify this email address as being opted out. More information on opt-outs can be found in the Emails documentation.\nprimary_address\nSpecify this email address as the primary\nUsing the /<module>\u00c2\u00a0POST endpoint, you can send the following JSON payload to create a contact record with multiple email addresses using the email link field: POST URL: http://<site url>/rest/v<version>/Contacts\n{\n   \"first_name\":\"Rob\",\n   \"last_name\":\"Robertson\",\n   \"email\":[\n      {\n         \"email_address\":\"rob.robertson@sugar.crm\",\n         \"primary_address\":\"1\",\n         \"invalid_email\":\"0\",\n         \"opt_out\":\"0\"\n      },\n      {\n         \"email_address\":\"rob@sugar.crm\",\n         \"primary_address\":\"0\",\n         \"invalid_email\":\"0\",\n         \"opt_out\":\"1\"\n      }\n   ]\n}\nFor more information on the /<module>/:record POST endpoint, you can refer to your instance's help documentation found at:\nhttp://<site url>/rest/v<version>/help\nOr you can reference the <module> POST PHP example.\nUpdating Email Addresses Using the REST API", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Email_Addresses/index.html"}
{"id": "2bed4a683c7b-6", "text": "Updating Email Addresses Using the REST API\nWhen updating existing records in Sugar through the API, modules with relationships to email addresses can use the email link field to specify email addresses for a record. Using the email link field, you can specify multiple email addresses to update the record with. You may specify the following additional information regarding each email address being added:\ninvalid_email : Specify this email address as being invalid\nopt_out : Specify this email address as being opted out\nprimary_address : Specify this email address as the primary\nUsing the /<module>/:record PUT endpoint, you can send the following JSON payload to update a contact record with multiple email addresses: PUT URL: http://<site url>/rest/v<version>/Contacts/<record id>\n{\n   \"email\":[\n      {\n         \"email_address\":\"rob.robertson@sugar.crm\",\n         \"primary_address\":\"1\",\n         \"invalid_email\":\"0\",\n         \"opt_out\":\"0\"\n      },\n      {\n         \"email_address\":\"rob@sugar.crm\",\n         \"primary_address\":\"0\",\n         \"invalid_email\":\"0\",\n         \"opt_out\":\"1\"\n      }\n   ]\n}\nFor more information on the /<module>/:record PUT endpoint, you can refer to your instance's help documentation found at:\nhttp://<site url>/rest/v<version>/help\nYou want to reference the <module>/:record PUT PHP example.\nLegacy Email Fields\nThe legacy email fields in Sugar\u00c2\u00a0are\u00c2\u00a0deprecated\u00c2\u00a0and may be subject to removal in an upcoming Sugar release. When using the email1 field, the default functionality is to import the email address specified as the primary address.\nLegacy Email Field\nDescription\nemail1\nThe text value of primary email address. Does not indicate if the email address is valid or opted-out.\nemail2", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Email_Addresses/index.html"}
{"id": "2bed4a683c7b-7", "text": "email2\nThe text value of first non-primary email address. Does not indicate if the email address is valid or opted-out.\nNote: For importing multiple email addresses with properties, you will need to use the email link field.\nCreating Email Addresses Using Direct SQL\nWhen importing records into Sugar directly via the database, it is important that you understand the data structure involved before loading data. Email addresses are not stored directly on the table for the module being imported in but are related via the email_addr_bean_rel table.\nThe table structure for email addresses can be seen from the database via the following SQL statement:\nSELECT\n email_addr_bean_rel.bean_id,\n email_addr_bean_rel.bean_module,\n email_addresses.email_address\nFROM email_addr_bean_rel\nINNER JOIN email_addresses\n ON email_addresses.id = email_addr_bean_rel.email_address_id\n AND email_addr_bean_rel.deleted = 0\nWHERE email_addresses.deleted = 0;\nChecking for Duplicates\nEmail addresses can become duplicated in Sugar from a variety of sources including API calls, imports, and from data entry. There are a few ways to have the system check for duplicate contact records, but not many of those methods work for checking email addresses for duplicates. The following section will demonstrate how to find and clean up duplicate email addresses using SQL.\nThe following SQL query can be used to locate if any email addresses are being used against more than one bean record within Sugar:\nSELECT\n email_addresses.email_address,\n COUNT(*) AS email_address_count\nFROM email_addr_bean_rel\nINNER JOIN email_addresses\n ON email_addresses.id = email_addr_bean_rel.email_address_id\n AND email_addr_bean_rel.deleted = 0\nWHERE email_addresses.deleted = 0\nGROUP BY email_addresses.email_address\nHAVING COUNT(*) > 1;", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Email_Addresses/index.html"}
{"id": "2bed4a683c7b-8", "text": "GROUP BY email_addresses.email_address\nHAVING COUNT(*) > 1;\nNote: If you convert a Lead record to a Contact record, both the Lead and the Contact will be related to the same Email Address and will return as having duplicates in this query. You can add the following line to the WHERE clause to filter the duplicate check down to only one bean type:\nAND email_addr_bean_rel.bean_module = 'Contacts'\nEmail addresses can not only be\u00c2\u00a0duplicated in the system but can occasionally be missing critical data. Each bean record with an email address assigned to it\u00c2\u00a0should have an email address designated the primary. The following query will locate any bean records that have at least one email address, where there is not an email address designated as the primary:\nSELECT\n email_addr_bean_rel.bean_module,\n email_addr_bean_rel.bean_id,\n COUNT(*) AS email_count,\n COUNT(primary_email_addr_bean_rel.id) AS primary_email_count\nFROM email_addr_bean_rel\nLEFT JOIN email_addr_bean_rel primary_email_addr_bean_rel\n ON primary_email_addr_bean_rel.bean_module = email_addr_bean_rel.bean_module\n AND primary_email_addr_bean_rel.bean_id = email_addr_bean_rel.bean_id\n AND primary_email_addr_bean_rel.primary_address = '1'\n AND primary_email_addr_bean_rel.deleted = '0'\nWHERE email_addr_bean_rel.deleted = '0'\nGROUP BY email_addr_bean_rel.bean_module,\n email_addr_bean_rel.bean_id\nHAVING primary_email_count < 1;\nNote: If you are a SugarCloud customer, you can open up a case with Sugar Support to have this query run for you.\nRemoving Duplicates\nIf it is determined you have duplicate email addresses being used in your system, you can use the following query to clean up the records:\nSTART TRANSACTION;\nCREATE", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Email_Addresses/index.html"}
{"id": "2bed4a683c7b-9", "text": "START TRANSACTION;\nCREATE \n TABLE email_addr_bean_rel_tmp\nSELECT\n *\nFROM email_addr_bean_rel\nWHERE deleted = '0'\nGROUP BY email_address_id,\n bean_module,\n bean_id\nORDER BY primary_address DESC;\nTRUNCATE TABLE email_addr_bean_rel;\nINSERT INTO email_addr_bean_rel\n SELECT\n *\n FROM email_addr_bean_rel_tmp;\nSELECT\n COUNT(*) AS repetitions,\n date_modified,\n bean_id,\n bean_module\nFROM email_addr_bean_rel\nWHERE deleted = '0'\nGROUP BY bean_id,\n bean_module,\n email_address_id\nHAVING repetitions > 1;\nCOMMIT;\nNote: If you are a SugarCloud customer, you can open up a case with Sugar Support to have this query run for you.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Email_Addresses/index.html"}
{"id": "032ec26b25b8-0", "text": "Tags\nOverview\nThe tagging feature allows a user to apply as many \"tags\" as they choose on any record they want to categorize. This allows the user to effectively group records together from any source within the application and relate them together. Please note that the tag field and Tags module do not support customization at this time.\nThe Tags Module\nThe Tags module is a very simple module based on the Basic SugarObject template. It is not studio editable, is part of the default module list, and is available to the application upon installation. By default, the Tags module is set up such that only an Administrator can perform any administrative tasks with the Tags module. In other words, a regular user will have a very restrictive set of permissions inside the Tags module, namely: create, export, view, and share. All other actions within the Tags modules must be carried out by an Administrative user.\nThe \"tag\" Field Type\nThe back end utilizes two new field types: the relatecollection field and the tag field. The tag field is a relatecollection type field with a few added enhancements specific to the tagging implementation:\nEnforces uniqueness of a tag when created\nEstablishes the necessary relationship between the Tags module and the module record being tagged\nCollects and formats a tag collection in a way the client understands\nFormat the tag field for consumption by and from the import process\nHandles proper query setting for a search that is filtered by tags\nThe Taggable Implementation\nThe taggable implementation is applied to all SugarObject templates so that it is available on all custom modules created and is also applied to all sidecar enabled modules. Any module that implements a SugarObject template\u00c2\u00a0will be taggable by default. Any module that doesn't implement a SugarObject template can easily apply it using the uses property of the module vardefs:\n$dictionary[$module] = array(\n    ...\n    'uses' => array(\n        'taggable',\n    ),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Tags/index.html"}
{"id": "032ec26b25b8-1", "text": "...\n    'uses' => array(\n        'taggable',\n    ),\n    ...\n);\nThere may be instances where a module should not implement tagging yet implements\u00c2\u00a0the SugarObject template. To remove tagging from a module you can use the module vardefs ignore_templates property:\n$dictionary[$module] = array(\n    ...\n    'ignore_templates' => array(\n        'taggable',\n    ),\n    ...\n);\nThe Tagging Relationship Structure\nThe tagging relationship schema is similar in nature to the email_addresses relationship schema in that it is used to represent a collection of 0-N Tags module records related to a module:\nColumn\nDescription\nid\nThe GUID for the relationship between the tag record and the module record\ntag_id\nThe id of the tag record used in this relationship\nbean_id\nThe id of the module record used in this relationship\nbean_module\nThe module for the record being tagged\ndate_modified\nThe date the relationship was created/modified\ndeleted\nA tinyint(1) boolean value that indicates whether this relationship is deleted\nTagging in Action\nFor adding tags from the UI, please refer to the Tags documentation.\nTagging Records from the API\nTagging a record via the API\u00c2\u00a0is done by sending a\u00c2\u00a0PUT request to the /<module>/<record>\u00c2\u00a0API endpoint with a tag property set to an array of key/value pairs that include a tag id (optional) and a tag name:\n{\n    \"name\": \"Record Name\",\n    \"tag\": [\n        {\"id\": \"Test Tag\", \"name\": \"Test Tag\"},\n        {\"name\": \"Test Tag 2\"},\n        {\"id\": \"1234-56-7890\", \"name\": \"Test Tag 3\"}\n    ]\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Tags/index.html"}
{"id": "032ec26b25b8-2", "text": "]\n}\nAfter the record is created/modified and the tag values are applied, the response will contain the returned collection of tags for that record complete with their ids:\n{\n    \"name\": \"Record Name\",\n    \"tag\": [\n        {\"id\": \"9876-54-3210\", \"name\": \"Test Tag\"},\n        {\"id\": \"4321-56-0987\", \"name\": \"Test Tag 2\"},\n        {\"id\": \"1234-56-7890\", \"name\": \"Test Tag 3\"}\n    ]\n}\nYou can visit\u00c2\u00a0How to Manipulate Tags (CRUD)\u00c2\u00a0for a full example demonstrating\u00c2\u00a0CRUD actions for tags.\nMass Updating Tags on Records Via the API\nMass updating records with tags are as simple as sending a MassUpdate PUT request to /<module>/MassUpdate\u00c2\u00a0with a payload similar to:\n{\n    \"massupdate_params\": {\n        \"uid\": [\"12345-67890\", \"09876-54321\"],\n        \"tag\": [\n            { \"id\": \"23456-78901\", \"name\": \"MyTag1\" },\n            { \"id\": \"34567-89012\", \"name\": \"MyTag2\" }\n        ]\n    }\n}\nThis request will override all existing tags on the named records. To append tags to a record, send the \"tag_type\" request argument set to a value of 1:\n{\n    \"massupdate_params\": {\n        \"uid\": [\"12345-67890\", \"09876-54321\"],\n        \"tag\": [\n            { \"id\": \"23456-78901\", \"name\": \"MyTag1\" },\n            { \"id\": \"34567-89012\", \"name\": \"MyTag2\" }", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Tags/index.html"}
{"id": "032ec26b25b8-3", "text": "],\n        \"tag_type\": \"1\"\n    }\n}\nMore information on this API endpoint can be found in the /<module>/MassUpdate PUT documentation.\nFetching Tags on a Record\nBy default, the tag field is added to all Sidecar module record views. That means when a request is made for a single record through the API, that single record will return the \"tag\" field, which will be a collection of key:value pair objects.\nFor example, when a request is made to the /Accounts/:record GET endpoint, the tags associated with the Accountrecord\u00c2\u00a0 will be returned in the tag field as an array of objects:\n{\n    \"id\": \"<record>\",\n    \"name\": \"Record Name\",\n    \"tag\": [\n        { \"id\": \"9876-54-3210\", \"name\": \"Test Tag\" },\n        { \"id\": \"4321-56-0987\", \"name\": \"Test Tag 2\" },\n        { \"id\": \"1234-56-7890\", \"name\": \"Test Tag 3\" }\n    ]\n}\nFiltering a Record List by Tags\nFiltering a list of records by tags can be done simply by sending a filter request to the ModuleApi endpoint for a module. For example, to filter the Accounts list where the tag field has a tag by the name of \"Tradeshow\", you can send a request to the /Accounts GET\u00c2\u00a0endpoint with the following request arguments:\n{\n    \"view\": \"list\",\n    \"filter\": [\n        {\n            \"tag\": {\n                \"$in\": [\n                    {\n                        \"name\": \"Tradeshow\"\n                    }\n                ]\n            }\n        }\n    ]\n}\nCurrently, the tag field filter definitions support the following filter operators:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Tags/index.html"}
{"id": "032ec26b25b8-4", "text": "]\n}\nCurrently, the tag field filter definitions support the following filter operators:\nIs any of ($in)\nIs not any of ($not_in)\nIs empty ($empty)\nIs not empty ($not_empty)\nFetching a list of Tags from the Tags module\nFetch a list of tag records from the Tags module is done the same way as fetch a list of records from any other module, namely by sending a GET request to the /Tags ModuleApi endpoint.\u00c2\u00a0More information can be found in the /<module> GET documentation.\nManipulating Tags Programmatically\nGetting Tags Related to a Record\nHere is an example that demonstrates how to get all the tags and its ids related to a contact record:\n// Creating a Bean for Contacts\n$bean = BeanFactory::getBean(\"Contacts\");\n// Creating a Bean for Tags\n$tagBean = BeanFactory::newBean('Tags');\n// Get all the tags related to Contacts Bean by givin Contact ID. You can provide more than one Record ID.\n$tags = $tagBean->getRelatedModuleRecords($bean, [\"<CONTACT_RECORD_ID>\"]);\nCreating a New Tag and Adding to a Record\nHere is an example that demonstrates how to add create a tag and add to a contact record.\nIn order to add a new tag first, we will create the tag bean. Then using load_relationship function we will add the newly created tag id to the contacts\u00c2\u00a0\n// Creating new Tag Bean\n$tagBean = BeanFactory::newBean(\"Tags\");\n// Setting its name\n$tagBean->name = \"New Tag\";\n$tagBean->save();\n// Retrieving the Contacts Bean\n$bean = BeanFactory::getBean(\"Contacts\", \"<RECORD_ID>\");\n// Getting tag field and its properties\n$tagField = $bean->getTagField();", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Tags/index.html"}
{"id": "032ec26b25b8-5", "text": "// Getting tag field and its properties\n$tagField = $bean->getTagField();\n$tagFieldProperties = $bean->field_defs[$tagField];\n// Identifying relation link\n$link = $tagFieldProperties['link'];\n// Loading relationship\nif ($bean->load_relationship($link)) {\n    // Adding newly created Tag Bean\n    $bean->$link->add($tagBean->id);\n}\nRemoving Tags from a Record\nHere is an example that demonstrates how to remove a tag from a contact record:\n// Getting the Contacts Bean\n$bean = BeanFactory::getBean(\"Contacts\", \"<RECORD_ID>\");\n// Getting tag field and its properties\n$tagField = $bean->getTagField();\n$tagFieldProperties = $bean->field_defs[$tagField];\n// Identifying relation link\n$link = $tagFieldProperties['link'];\n// Loading relationship\nif($bean->load_relationship($link)){\n    // Removing the Tag ID\n    $bean->$link->delete($bean->id, \"<TAG_RECORD_ID>\");\n}\nSynchronizing Tags by Name With API Helpers\nIf you have multiple tags that you need to add and delete at the same time, then you can use SugarFieldTag->apiSave method. Here is an example that demonstrates how to sync tags by using SugarFieldTag Class\u00c2\u00a0for\u00c2\u00a0a Contact record.\nIt is important to know that since this is a sync; you will need to keep the existing tags if you want them to still exist in the record.\u00c2\u00a0\n// Getting the Contacts Bean\n$bean = BeanFactory::getBean(\"Contacts\", \"<RECORD_ID>\");\n// Getting Tag Field ID\n$tagField = $bean->getTagField();\n// Getting Tag Field Properties\n$tagFieldProperties = $bean->field_defs[$tagField];", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Tags/index.html"}
{"id": "032ec26b25b8-6", "text": "$tagFieldProperties = $bean->field_defs[$tagField];\n// Preparing the latest Tags to be sync with the record\n$tags = [\n    // Note: Already attached tags will be automatically removed from the record\n    // If you want to keep some of the existing tags then you will need to keep them in the array\n    \"tag\" => [\n        // Since this tag is already added, it will be preserved\n        'already added tag' => 'Already Added Tag',\n        // The new tags to add - All other tags that previously existed will be deleted\n        'new tag' => 'New Tag',\n        'new tag2' => 'New Tag2',\n    ],\n];\n// Building SugarFieldTag instance\n$SugarFieldTag = new SugarFieldTag();\n// Passing the arguments to save the Tags\n$SugarFieldTag->apiSave($bean, $tags, $tagField, $tagFieldProperties);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Tags/index.html"}
{"id": "9717bb124f9b-0", "text": "Backward Compatibility\nOverview\nAs of Sugar\u00c2\u00ae 7, modules are built using the Sidecar framework. Any modules that still use the MVC architecture and have not yet migrated to the Sidecar framework are set in what Sugar refers to as \"backward compatibility\" (BWC) mode.\nFor the list of Studio-enabled modules in backward compatibility for your version of Sugar, please refer to the User Interface (Legacy Modules) documentation for your version of Sugar.\nURL Differences\nThere are some important differences between the legacy MVC and Sidecar URLs. When a module is set in backward compatibility, the URL will contain \"/#bwc/\" in the path and use query string parameters to identify the module and action. An example of the Sidecar BWC URL is shown below.\nhttp://{site url}/#bwc/index.php?module=<module>&action=<action>\nYou can see that this differs from the standard route of:\nhttp://{site url}/#<module>/<record id>\nStudio Differences\nThere are some important differences between the legacy MVC modules and Sidecar modules. When a module is in backward compatibility mode, an asterisk is placed next to the modules name in Studio. Modules in backward compatibility will use the legacy MVC metadata layouts, located in ./modules/<module>/metadata/, as follows:\nLayouts\nEdit View\nDetail View\nList View\nSearch\nBasic Search\nAdvanced Search\nThese layouts differ from Sidecar in many ways. The underlying metadata is very different and you should notice that the MVC layouts have a separation between the Edit View and Detail View whereas the Sidercar layouts make use of the Record View. The Sidecar metadata for Sugar is located in ./modules/<module>/clients/base/views/.\nLayouts\nRecord View\nList View\nSearch\nSearch\nTopicsEnabling Backward CompatibilityHow to enable backward compatibility for modules.Converting Legacy Modules To SidecarHow to upgrade a legacy module to be Sidecar enabled.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Backward_Compatibility/index.html"}
{"id": "9717bb124f9b-1", "text": "Last modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Backward_Compatibility/index.html"}
{"id": "e1ca9b298b14-0", "text": "Enabling Backward Compatibility\nOverview\nHow to enable backward compatibility for a module.\nEnabling Backward Compatibility\nBackward Compatibility Mode is not a permanent solution for modules with legacy customizations. If you should need to temporarily get a module working due to legacy customizations, you can follow the steps below to enable the legacy MVC framework.\u00c2\u00a0Please note that switching stock Sugar modules from the Sidecar framework to backward compatibility\u00c2\u00a0mode is not supported and may result in unexpected behaviors in the application.\nEnabling BWC\nTo enable backward compatibility, you must first create a file in ./custom/Extension/application/Ext/Include/ for the module. If the module is custom, there will already be an existing file in this folder pertaining to the module that you can edit.\n./custom/Extension/application/Ext/Include/<file>.php\n<?php\n$bwcModules[] = '<module key>';\nOnce the file is in place, you will need to navigate to Admin > Repair > Quick Repair and Rebuild. The Quick Repair can wait until you have completed the following sections for this customization.\nVerifying BWC Is Enabled\nTo verify that backward compatibility is enabled, you can inspect App.metadata.get().modules after running a Quick Repair and Rebuild in your browser's console window:\nUsing Developer Tools in Google Chrome\nOpen Developer Tools\nThis can be done in the following ways:\nCommand + Option + i\nView > Developer > Developer Tools\nRight-click on the web page and selecting \"Inspect Element\"\nSelect the \"Console\" tab\nRun the following command, replacing <module key> and verify that it returns true:\nApp.metadata.get().modules.<module key>.isBwcEnabled\nUsing Firebug in Google Chrome or Mozilla Firefox\nOpen Firebug\nSelect the \"Console\" tab\nRun the following command, replacing <module key>, and verify that it returns true:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Backward_Compatibility/Enabling_Backward_Compatibility/index.html"}
{"id": "e1ca9b298b14-1", "text": "Run the following command, replacing <module key>, and verify that it returns true:\nApp.metadata.get().modules.<module key>.isBwcEnabled\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Backward_Compatibility/Enabling_Backward_Compatibility/index.html"}
{"id": "f289356a1c8c-0", "text": "Converting Legacy Modules To Sidecar\nHow to upgrade a legacy module to be Sidecar enabled.\nOverview\nAfter upgrading your instance to Sugar 7.x, some custom modules may be left in the legacy backward compatible format. This is normally due to the module containing a custom view or file that Sugar does not recognize as being a supported customization for Sidecar. To get your module working with Sidecar, you will need to remove the unsupported customization and run the UpgradeModule.php script.\nNote:\u00c2\u00a0The following commands should be run\u00c2\u00a0on a sandbox instance before being applied to any production environment. It is also important to note that this script should only be run against custom modules. Stock modules in backward compatibility should remain in backward compatibility.\nSteps to Complete\nThe following steps require access to both the Sugar filesystem as well as an administrative user.\nNote:\u00c2\u00a0As of Sugar 10.0,\u00c2\u00a0the UpgradeModule.php script has been removed from the codebase. We are providing a zip of the files that were removed so that it is still possible to run the upgrade.\nBegin by downloading this zip file that contains the previously removed code\nUnzip the file and move the contents into your Sugar application at ./modules/UpgradeWizard/\nTo upgrade a\u00c2\u00a0custom module, identify the module's unique key. This key can be easily found by identifying the module's folder name in ./modules/<module key name>/. The module's key name will be in the format of abc_module.\u00c2\u00a0\nNext, change to the\u00c2\u00a0./modules/UpgradeWizard/\u00c2\u00a0path relative to your Sugar root directory in your terminal or command line application:cd <sugar root>/modules/UpgradeWizard/\nRun the\u00c2\u00a0UpgradeModule.php\u00c2\u00a0script, passing in the\u00c2\u00a0sugar root directory and\u00c2\u00a0the unique key of the legacy module:php UpgradeModule.php <sugar root> <module key>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Backward_Compatibility/Converting_Legacy_Modules_To_Sidecar/index.html"}
{"id": "f289356a1c8c-1", "text": "An example is shown below:php UpgradeModule.php /var/www/html/sugarcrm/ abc_module\nThe script with then output a series of messages identifying issues that need to be corrected. Once the issues have been addressed, you can then run the\u00c2\u00a0UpgradeModule.php\u00c2\u00a0script again to confirm no errors have been found.\nOnce completed, log into your instance and navigate to Admin > Repair > Quick Repair and Rebuild. Test the custom\u00c2\u00a0module to ensure it\u00c2\u00a0is working as expected. There is no\u00c2\u00a0guarantee that the module will be fully functional in Sidecar and may therefore require additional development effort to ensure compatibility.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Backward_Compatibility/Converting_Legacy_Modules_To_Sidecar/index.html"}
{"id": "3da9e8c0abc3-0", "text": "Access Control Lists\nOverview\nAccess Control Lists (ACLs) are used to control access to the modules, data,\u00c2\u00a0and actions available to users in Sugar. By default, Sugar comes with a default ACL Strategy that is configurable by an Admin through the Roles module via Admin >\u00c2\u00a0Role Management. Sugar also comes with other ACL strategies that are located in the ./data/acl/ folder, and are used in other parts of the system such as the Administration module, Emails module, Locked Fields functionality, and many others. They can also be leveraged by customizations and custom ACL strategies can be implemented to control your own customizations.\nActions\nActions are the use cases in which a User interacts with a particular module in the system. ACLs control access by using different logic to determine if a user can do an action. Below is a list of actions that are utilized by Sugar and will be requested actions against a custom ACL strategy implementation. You can add your own actions to be checked against in a custom strategy, but the following list should always be considered:\nindex, list, listview - for module ListView access\ndetail, detailview, view - module DetailView access\npopupeditview, editview - module EditView access\nedit, save - editing module data\nimport - import into the module\nexport - export from the module\ndelete - delete module record\nteam_security - should this module have team security enabled?\nfield - access field ACLs. The field action is specified via context array, see below\nsubpanel - checks if subpanel should be displayed. Should have \"subpanel\" context option.\nNote: Action names are not case sensitive, although the standard practice is to use them in all lowercase\nField Actions\nWhen using the field action, the action for the particular field that is being checked is passed via Context. The field actions that are used in Sugar are:\naccess - any access to field data", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Access_Control_Lists/index.html"}
{"id": "3da9e8c0abc3-1", "text": "access - any access to field data\nread, detail - read access\nwrite, edit - write access\nContext\nThe context array is used throughout Sugar's ACL architecture as a way to pass extra contextual data that is used by an ACL Strategy to determine the access request.\u00c2\u00a0The following context parameters are used in stock contexts, and should be used as a guideline for custom ACL implementations as parameters that should be accommodated or used:\nbean (SugarBean) - the current SugarBean object\nuser (User) - the user to check access for, otherwise defaults to the current user.\nuser_id (String) - the current user ID (also overrides global current user). If the current user object is available, use the user context, since it has precedent.\nowner_override (Bool) - if set to true, apply ACLs as if the current user were the owner of the object.\nsubpanel (aSubPanel) - used in subpanel action to provide aSubPanel object describing the panel.\nfield, action (String) - used to specify field name and action name for field ACL requests.\nmassupdate (Bool) - true if save operation is a mass update\nSugarACL\nThe SugarACL Class, ./data/SugarACL.php, is the static API for checking access for an action against a module.\u00c2\u00a0\ncheckAccess()\nThe checkAccess() method is used to check a users access for a given action against a module.\u00c2\u00a0\nSugarACL::checkAccess('Accounts','edit');\nArguments\nName\nType\nRequired\nDescription\n$module\nString\ntrue\nThe name of the module\n$action\nString\ntrue\nThe name of the action. See Actions section.\n$context\nArray\nfalse\nThe associative array of context data. See Context section.\nReturns\nBoolean\ncheckField()", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Access_Control_Lists/index.html"}
{"id": "3da9e8c0abc3-2", "text": "The associative array of context data. See Context section.\nReturns\nBoolean\ncheckField()\nThe checkField() method is used to check a users access for a given field against a module.\u00c2\u00a0\nSugarACL::checkField('Accounts','account_type','view');\nArguments\nName\nType\nRequired\nDescription\n$module\nString\ntrue\nThe name of the module\n$field\nString\ntrue\nThe name of the field\n$action\nString\ntrue\nThe name of the action.\u00c2\u00a0See Actions section.\n$context\nArray\nfalse\nThe associative array of context data. See Context section.\nReturns\nBoolean\ngetFieldAccess()\nThe getFieldAccess() method is used to get the access level for a specific\n$access = SugarACL::getFieldAccess('Accounts','account_type');\nArguments\nName\nType\nRequired\nDescription\n$module\nString\ntrue\nThe name of the module\n$field\nString\ntrue\nThe name of the field\n$context\nArray\nfalse\nThe associative array of context data. See Context section.\nReturns\nInteger\nThe integers are represented as constants in the SugarACL class, and correspond as follows:\nSugarACL::ACL_NO_ACCESS = 0 - access denied\nSugarACL::ACL_READ_ONLY = 1 - read only access\nSugarACL::ACL_READ_WRITE = 4 - full access\nfilterModuleList()\nThe filterModuleList() method is used to filter the list of modules available for a given action. For example, if you wanted to get all the modules the current user had edit access to, you might call the following in code:\nglobal $app_list_strings;\n$modules = $app_list_strings['module_list'];\n$editableModules = SugarACL::filterModuleList($modules,'edit');\nArguments\nName\nType\nRequired\nDescription\n$modules\nArray\ntrue\nThe list of modules you want to filter", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Access_Control_Lists/index.html"}
{"id": "3da9e8c0abc3-3", "text": "Required\nDescription\n$modules\nArray\ntrue\nThe list of modules you want to filter\n$action\nString\nfalse\nThe action to check for,\u00c2\u00a0See Actions section.\u00c2\u00a0Defaults to 'access' action\n$use_value\nBoolean\nfalse\nWhether to the module name in the $modules array is in the Key or the Value of the array.\u00c2\u00a0Defaults to false\nFor example, if filtering an array of modules, where the modules are defined in the values of the array:\n$modules = array(\n   'Accounts',\n   'Cases',\n   'Administration'\n);\n$accessModules = SugarACL::filterModuleList($modules,'access',true);\nReturns\nArray\nThe filtered list of modules.\ndisabledModuleList()\nSimilar to the previous method, the disableModuleList() method filters a list of modules to those that the user does not have access to.\nglobal $app_list_strings;\n$modules = $app_list_strings['module_list'];\n$disabledModules = SugarACL::disabledModuleList($modules,'access');\nArguments\nName\nType\nRequired\nDescription\n$modules\nArray\ntrue\nThe list of modules you want to filter\n$action\nString\nfalse\nThe action to check for,\u00c2\u00a0See Actions section.\u00c2\u00a0Defaults to 'access' action\n$use_value\nBoolean\nfalse\nWhether to the module name in the $modules array is in the Key or the Value of the array.\u00c2\u00a0Defaults to false\nFor example, if filtering an array of modules, where the modules are defined in the values of the array:\n$modules = array(\n   'Accounts',\n   'Cases',\n   'Administration'\n);\n$accessModules = SugarACL::filterModuleList($modules,'access',true);\nReturns\nArray\nThe filtered list of modules.\nmoduleSupportsACL()", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Access_Control_Lists/index.html"}
{"id": "3da9e8c0abc3-4", "text": "Returns\nArray\nThe filtered list of modules.\nmoduleSupportsACL()\nThe moduleSupportsACL() method is used to check if a module has ACLs defined on the vardefs.\u00c2\u00a0A good use case for this method is to not run any ACL checks if module has no ACL definitions.\nSugarACL::moduleSupportsACL('Accounts');\nArguments\nName\nType\nRequired\nDescription\n$module\nString\ntrue\nThe name of the module\nReturns\nBoolean\nlistFilter()\nThe listFilter() method allows for filtering an array of fields for a module to remove those which the user does not have access to. The removal can be done in a couple of different ways, provided by the $options argument. The filtering of the array is done in place, rather than returning the filtered list.\n$Account = BeanFactory::getBean('Accounts','12345');\n$fields = array(\n  'account_type' => 'foobar',\n  'status' => 'New',\n  'name' => 'Customer'\n);\n$context = array(\n   'bean' => $Account\n);\n$options = array(\n    'blank_value' => true\n);\nSugarACL::listFilter('Accounts',$fields,$context,$options);\necho <pre>json_encode($fields)</pre>;\nShould the user not have access to the 'status' field, the above might output:\n{\n  \"account_type\": \"foobar\",\n  \"status\": \"\",\n  \"name\": \"Customer\"\n}\nArguments\nName\nType\nRequired\nDescription\n$module\nString\ntrue\nThe name of the module\n$list\nArray\ntrue\nThe array, as a reference, which will be filtered\n$context\nArray\nfalse\nThe associative array of context data. See Context section.\n$options\nArray\nfalse", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Access_Control_Lists/index.html"}
{"id": "3da9e8c0abc3-5", "text": "false\nThe associative array of context data. See Context section.\n$options\nArray\nfalse\nAn associative array containing some of the following options:\nblank_value (Bool) - instead of removing inaccessible field put '' there\nadd_acl (Bool) - instead of removing fields add 'acl' value with access level\nsuffix (String) - strip suffix from field names\nmin_access (Int) - require this level of access for the field.\u00c2\u00a0Defaults to\u00c2\u00a0SugarACL::ACL_READ_ONLY\u00c2\u00a0or 0\nuse_value (Bool) - look for field name in value, not in the key of the list\nReturns\nVoid\nSugarBean Usage\nThe SugarBean class also comes with some methods for working with the ACLs in regards to the current SugarBean context. These methods automatically provide the 'bean' context parameter and provide a wrapper that utilizes the SugarACL class\ngetACLCategory()\nThe getACLCategory() method is used by all of the ACL helper methods that exist on the SugarBean and is used to determine the module name that should be checked against for the current Bean. By default, it will return the acl_category property set on the Bean, otherwise if that is not set, it will use the module_dir property that is configured on the Bean. This method can be overridden by a custom Bean implementation, but the following code shows which properties on a Bean implementation should be set for usage with ACLs.\n<?php\nclass testBean extends SugarBean\n{\n    public $module_dir = 'testBean';\n    //all the other SugarBean class logic...\n}\nclass test_SubmoduleBean extends SugarBean\n{\n    public $module_dir = 'testBean/submodule';\n    public $acl_category = 'test_SubmoduleBean';\n    ///all the other SugarBean class logic...\n}\n$test = new testBean();\n//echoes testBean", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Access_Control_Lists/index.html"}
{"id": "3da9e8c0abc3-6", "text": "}\n$test = new testBean();\n//echoes testBean\necho $test->getACLCategory();\n$submodule = new test_SubmoduleBean();\n//echoes test_SubmoduleBean\necho $submodule->getACLCategory();\nArguments\nNone\nReturns\nString\nACLAccess()\nThe ACLAccess() method is a wrapper for SugarACL::checkField() method, which provides the Bean context as the current SugarBean.\n$Account = BeanFactory::getBean('Accounts','12345');\nif ($Account->ACLFieldAccess('account_type','edit')){\n   //do something if User has account_type edit access\n}\nArguments\nName\nType\nRequired\nDescription\n$action\nString\nfalse\nThe name of the action to check.\u00c2\u00a0See Actions section.\n$context\nArray\nfalse\nThe associative array of context data. See Context section.\nReturns\nBoolean\nACLFieldAccess()\nThe ACLFieldAccess() method is a wrapper for SugarACL::checkAccess() method, which provides the Bean context as the current SugarBean.\n$Account = BeanFactory::getBean('Accounts','12345');\nif ($Account->ACLACcess('edit')){\n   //do something if User has edit access\n}\nArguments\nName\nType\nRequired\nDescription\n$field\nString\ntrue\nThe name of the field\n$action\nString\nfalse\nThe name of the action to check,\u00c2\u00a0see Field Actions section. Defaults to 'access'\n$context\nArray\nfalse\nThe associative array of context data. See Context section.\nReturns\nBoolean\nACLFieldGet()\nThe ACLFieldGet() method is a wrapper for SugarACL::getFieldAccess() method, which provides the Bean context as the current SugarBean.\n$Account = BeanFactory::getBean('Accounts','12345');", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Access_Control_Lists/index.html"}
{"id": "3da9e8c0abc3-7", "text": "$Account = BeanFactory::getBean('Accounts','12345');\n$accountTypeAccess = $Account->ACLFieldGet('account_type');\nArguments\nName\nType\nRequired\nDescription\n$field\nString\ntrue\nThe name of the field\n$context\nArray\nfalse\nThe associative array of context data. See Context section.\nReturns\nBoolean\nACLFilterFields()\nThe ACLFilterFields()\u00c2\u00a0method uses the\u00c2\u00a0SugarACL::checkField() method to blank out those fields which a user doesn't have access to on the current SugarBean.\n$Account = BeanFactory::getBean('Accounts','12345');\n$Account->status = 'Old';\n$Account->ACLFilterFields('edit');\necho $Account->status;\nShould the user not have 'edit' access to the 'status' field, the above wouldn't output any data since the status field would be blank.\nArguments\nName\nType\nRequired\nDescription\n$action\nString\ntrue\nThe name of the action to check.\u00c2\u00a0See Actions section.\n$context\nArray\nfalse\nThe associative array of context data. See Context section.\nReturns\nVoid\nACLFilterFieldList()\nThe ACLFilterFieldList() method is a wrapper for SugarACL::listFilter() method, which provides the Bean context as the current SugarBean.\n$Account = BeanFactory::getBean('Accounts','12345');\n$fields = array(\n  'account_type' => 'foobar',\n  'status' => 'New',\n  'name' => 'Customer'\n);\n$options = array(\n    'blank_value' => true\n);\n$Account->ACLFilterFieldList($fields,array(),$options);\necho \"<pre>\".json_encode($fields).\"</pre>\";\nShould the user not have access to the 'status' field, the above might output:\n{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Access_Control_Lists/index.html"}
{"id": "3da9e8c0abc3-8", "text": "{\n  \"account_type\": \"foobar\",\n  \"status\": \"\",\n  \"name\": \"Customer\"\n}\nArguments\nName\nType\nRequired\nDescription\n$list\nArray\ntrue\nThe array, as a reference, which will be filtered\n$context\nArray\nfalse\nThe associative array of context data. See Context section.\n$options\nArray\nfalse\nAn associative array containing some of the following options:\nblank_value (Bool) - instead of removing inaccessible field put '' there\nadd_acl (Bool) - instead of removing fields add 'acl' value with access level\nsuffix (String) - strip suffix from field names\nmin_access (Int) - require this level of access for the field.\u00c2\u00a0Defaults to\u00c2\u00a0SugarACL::ACL_READ_ONLY\u00c2\u00a0or 0\nuse_value (Bool) - look for field name in value, not in the key of the list\nReturns\nVoid\nLegacy Methods\nWhen working in the Sugar codebase there might be areas that still utilize the following legacy ACLController class. The following gives a brief overview of a few methods that might still be used but should be avoided in future custom development.\nACLController::checkAcess()\nThe ACLController::checkAccess() method is just a wrapper for SugarACL::checkAccess() method and has been left in place for backward compatibility.\nACLController::moduleSupportsACL()\nThe ACLController::moduleSupportsACL() method is just a wrapper for SugarACL::moduleSupportsACL() method and has been left in place for backward compatibility.\nACLController::displayNoAccess()\nThis method does an echo to display a \"no access\" message for pages.\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Access_Control_Lists/index.html"}
{"id": "cd5c8342db0a-0", "text": "DateTime\nOverview\nThe SugarDateTime class, located in, ./include/SugarDateTime.php, extends PHP's built in\u00c2\u00a0DateTime class and can be used\u00c2\u00a0to\u00c2\u00a0perform common operations on date and time values.\u00c2\u00a0\nSetting\nWith existing SugarDateTime objects, it is recommended to clone the object before modifying or performing operations on it.\n$new_datetime = clone $datetime;\nAnother option is to instantiate a new SugarDateTime\u00c2\u00a0object.\n// defaults to now\n$due_date_time = new SugarDateTime();\n$due_date_time->setDate($dueYear, $dueMonth, $dueDay);\n$due_date_time->setTime($dueHour, $dueMin);\n$due_date_time->setTimezone($dueTZ);\nNote : When creating a new SugarDateTime object, the date and time will default to the current date and time in the timezone configured in PHP.\nSugarDateTime Objects can also be modified by passing in common English textual date/time strings to manipulate the value.\n$due_date = clone $date;\n$end_of_the_month->modify(\"last day of this month\");\n$end_of_next_month->modify(\"last day of next month\");\n$thirty_days_later->modify(\"+30 days\");\nFormatting\nWhen formatting SugarDateTime objects into a string for display or logging purposes, there are a few options you\u00c2\u00a0can utilize through the\u00c2\u00a0formatDateTime() method.\nReturn the date/time formatted for the database:\n$db_datetime_string = formatDateTime(\"datetime\", \"db\");\nReturn the date/time formatted using a user's preference:\nglobal $current_user;\n$user_datetime_string = formatDateTime(\"datetime\", \"user\", $current_user);\nReturn the date/time formatted following ISO-8601\u00c2\u00a0standards:\n$iso_datetime_string = formatDateTime(\"datetime\", \"iso\");", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/DateTime/index.html"}
{"id": "cd5c8342db0a-1", "text": "$iso_datetime_string = formatDateTime(\"datetime\", \"iso\");\nThere are times when it is needed to return only certain parts of a date or time. The format() method accepts a string parameter to define what parts or information about the date/time should be returned.\u00c2\u00a0\n// 28 Dec 2016\necho $due_date_time->format(\"j M Y\");\n// 2016-12-28 19:01:09\necho $due_date_time->asDb();\n// The date/time 2016-12-28T11:01:09-08:00 is set in the timezone of America/Los_Angeles\necho \"The date/time \" . $due_date_time->format(\"c\") . \" is set in the timezone of \" . $due_date_time->format(\"e\");\n// The time when this date/time object was created is 11:01:09 AM -0800\necho \"The time when this date/time object was created is \" . $due_date_time->format(\"H:i:s A O\");\n// There are 31 days in the month of December\necho \"There are \" . $due_date_time->format(\"t\") . \" days in the month of \" . $due_date_time->format(\"F\");\n// There are 366 days in the year of 2016\necho \"There are \" . $due_date_time->__get(\"days_in_year\") . \" days in the year of \" . $due_date_time->format(\"Y\");\n// Between Wed, 28 Dec 2016 11:01:09 -0800 and the end of the year, there are 4 days.\necho \"Between \" . $due_date_time . \" and the end of the year, there are \" . ($due_date_time->__get(\"days_in_year\") - $due_date_time->format(\"z\")) . \" days.\";", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/DateTime/index.html"}
{"id": "cd5c8342db0a-2", "text": "\u00c2\u00a0For more information on the available options, please refer to http://php.net/manual/en/function.date.php\u00c2\u00a0\nTimeDate Class\nThe TimeDate\u00c2\u00a0class, located in ./include/TimeDate.php, utilizes the SugarDateTime class to provide an extended toolset of methods for date/time usage.\nSetting\nWith existing TimeDate objects, it is recommended to clone the object before modifying or performing operations on it.\n$new_timedate = clone $timedate;\nAnother option is to instantiate a new TimeDate\u00c2\u00a0object.\n// current time in UTC\n$timedate = new TimeDate();\n$now_utcTZ = $timedate->getNow();\n// current time in user's timezone\n$timedate = new TimeDate($current_user);\n$now_userTZ = $timedate->getNow(true);\nNote : When creating a new TimeDate\u00c2\u00a0object, the date and time will default to the current date and time in the UTC timezone unless\u00c2\u00a0a user object is passed in.\u00c2\u00a0\nFormatting\nTimeDate objects can return the Date/Time in either a string format or in a SugarDateTime object.\u00c2\u00a0The TimeDate object has many formatting options; some of the most common ones are :\ngetNow\nGet the current date/time as a\u00c2\u00a0SugarDateTime\u00c2\u00a0object\u00c2\u00a0\nfromUser\nGet SugarDateTime object\u00c2\u00a0from user's date/time string\nasUser\nFormat DateTime object as user's date/time string\nfromDb\nGet SugarDateTime\u00c2\u00a0object\u00c2\u00a0from a DB date/time string\nfromString\nCreate a\u00c2\u00a0SugarDateTime object from a string\nget_db_date_time_format\nGets\u00c2\u00a0the current database date and time format\nto_display_date_time\nFormat a\u00c2\u00a0string\u00c2\u00a0as user's display date/time\ngetNow\nreturns\u00c2\u00a0SugarDateTime object\nParameters\nName\nData Type\nDefault", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/DateTime/index.html"}
{"id": "cd5c8342db0a-3", "text": "getNow\nreturns\u00c2\u00a0SugarDateTime object\nParameters\nName\nData Type\nDefault\nDescription\n$userTz\nbool\nfalse\nWhether to use\u00c2\u00a0the user's timezone or not. False will use UTC\nReturns a SugarDateTime object set to the current date/time. If there is a\u00c2\u00a0user object associate\u00c2\u00a0to the TimeDate object, passing true to the $userTz parameter will return the object in user's timezone. If no user is associated or false is passed, the timezone returned will be in UTC.\nExample\n$timedate = new TimeDate($current_user);\n// returns current date/time in UTC\n$now_utcTZ = $timedate->getNow();\n// returns current date/time in the user's timezone\n$now_userTZ = $timedate->getNow(true);\nfromUser\nreturns\u00c2\u00a0SugarDateTime object\nParameters\nName\nData Type\nDefault\nDescription\n$date\nstring\nn/a\nDate/Time string to convert to an object\n$user\nUser\nnull\nUser to utilize formatting and timezone info from\nReturns a SugarDateTime object\u00c2\u00a0converted from the passed in string.\u00c2\u00a0If there is a user object passed in as a parameter will return the object in user's timezone. If no user is passed in, the timezone returned will be in UTC.\nExample\n$date = \"2016-12-28 13:09\";\n$timedate = new TimeDate();\n$datetime = $timedate->fromUser($date, $current_user);\nasUser\nreturns\u00c2\u00a0string\nParameters\nName\nData Type\nDefault\nDescription\n$date\nstring\nn/a\nDate/Time string to convert to an object\n$user\nUser\nnull\nUser to utilize formatting and timezone info from", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/DateTime/index.html"}
{"id": "cd5c8342db0a-4", "text": "$user\nUser\nnull\nUser to utilize formatting and timezone info from\nReturns a\u00c2\u00a0string\u00c2\u00a0of the date and time formatted based on the user's profile settings.\u00c2\u00a0If there is a user object passed in as a parameter it will return the object in user's timezone. If no user is passed in, the timezone returned will be in UTC.\nExample\n$datetime = new datetime(\"2016-12-28 13:09\");\n$timedate = new TimeDate();\n$formattedDate = $timedate->asUser($datetime, $current_user);\nfromDb\nreturns SugarDateTime\nParameters\nName\nData Type\nDefault\nDescription\n$date\nstring\nn/a\nDate/Time string in database format to convert to an object\nReturns a SugarDateTime object\u00c2\u00a0converted from the passed in database formatted string.\nNote : If the string does not match the database format exactly, this function will return boolean false.\nExample\n// Y-m-d H:i:s\n$db_datetime = \"2016-12-28 13:09:01\";\n$timedate = new TimeDate();\n$datetime = $timedate->fromDb($db_datetime);\n// returns bool(false)\n$wrong_datetime = \"2016-12-28 13:09\";\n$timedate = new TimeDate();\n$datetime = $timedate->fromDb($timedate);\nfromString\nreturns SugarDateTime\nParameters\nName\nData Type\nDefault\nDescription\n$date\nstring\nn/a\nDate/Time string to convert to an object\n$user\nUser\nnull\nUser to utilize timezone info from", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/DateTime/index.html"}
{"id": "cd5c8342db0a-5", "text": "$user\nUser\nnull\nUser to utilize timezone info from\nReturns a SugarDateTime object\u00c2\u00a0converted from the passed in database formatted string.\u00c2\u00a0If there is a user object passed in as a parameter it will return the object in user's timezone. If no user is passed in, the timezone returned will be in UTC.\nExample\n$datetime_str = \"December 28th 2016 13:09\";\n$timedate = new TimeDate();\n$datetime = $timedate->fromString($datetime_str);\nget_db_date_time_format\nreturns\u00c2\u00a0string\nParameters\nN/a\nReturns a\u00c2\u00a0string of the current database date and time format settings.\u00c2\u00a0\nNote : For just the date format use\u00c2\u00a0get_db_date_format() and for just the time format use\u00c2\u00a0get_db_time_format().\nExample\n$timedate = new TimeDate();\n// Y-m-d H:i:s\n$db_format = $timedate->get_db_date_time_format();\nto_display_date_time\nreturns\u00c2\u00a0string\nParameters\nName\nData Type\nDefault\nDescription\n$date\nstring\nn/a\nDate/Time string in database format\n$meridiem\nboolean\ntrue\nDeprecated -- Remains for backwards compatibility only\n$convert_tz\nboolean\ntrue\nConvert to user's timezone\n$user\nUser\nnull\nUser to utilize formatting and timezone info from\nReturns a string of the date and time formatted based on the user's profile settings. If no user is passed in, the current user's default will be used. If $convert_tz is true the string returned will be\u00c2\u00a0in the passed in user's timezone. If no user is passed in, the timezone returned will be in UTC.\nNote : If the string does not match the database format exactly, this function will return boolean false.\nExample", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/DateTime/index.html"}
{"id": "cd5c8342db0a-6", "text": "Example\n$datetime_str = \"2016-12-28 13:09:01\";\n// 12-28-2016 07:09\n$timedate = new TimeDate();\n$datetime = $timedate->to_display_date_time($datetime_str);\n// 2016-12-28 13:09\n$timedate = new TimeDate();\n$datetime = $timedate->to_display_date_time($datetime_str, true, false, $diff_user);\nParsing\nIn addition to formatting, TimeDate objects can also return Date/Time values based on special parameters.\u00c2\u00a0The TimeDate object has many date parsing options; some of the most common ones are :\nparseDateRange\nGets\u00c2\u00a0the start and end date/time from a range keyword\u00c2\u00a0\nparseDateRange\nreturns array\nParameters\nName\nData Type\nDefault\nDescription\n$range\nstring\nn/a\nString\u00c2\u00a0from a predetermined list of available ranges\n$user\nUser\nnull\nUser to utilize formatting and timezone info from\n$adjustForTimezone\nboolean\ntrue\nConvert to user's timezone\nReturns an array of\u00c2\u00a0SugarDateTime objects containing the start and Date/Time values calculated based on the entered parameter. If no user is passed in, the current user's default will be used. If $adjustForTimezone\u00c2\u00a0is true the string returned will be\u00c2\u00a0in the passed in user's timezone. If NULL is passed in as the\u00c2\u00a0user, the timezone returned will be in UTC. The available values for $range are :\nRange String\nDescription\nyesterday\nYesterday's start and end date/time\ntoday\nToday's start and end date/time\ntomorrow\nTomorrows's start and end date/time\nlast_7_days\nStart and end date/time of the last seven days\nnext_7_days", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/DateTime/index.html"}
{"id": "cd5c8342db0a-7", "text": "Start and end date/time of the last seven days\nnext_7_days\nStart and end date/time of the next seven days\nlast_30_days\nStart and end date/time of the last thirty days\nnext_30_days\nStart and end date/time of the next thirty days\nnext_month\nStart and end date/time of next month\nlast_month\nStart and end date/time of last month\nthis_month\nStart and end date/time of the current month\nlast_year\nStart and end date/time of last year\nthis_year\nStart and end date/time of the current year\nnext_year\nStart and end date/time of next year\nExample\n$timedate = new TimeDate($current_user);\n// returns today's start and end date/time in UTC\n$today_utcTZ = $timedate->parseDateRange(\"today\", NULL, false);\n// returns today's start and end date/time in the user's timezone\n$today_userTZ = $timedate->parseDateRange(\"today\", $current_user, true);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/DateTime/index.html"}
{"id": "40a0588ef00e-0", "text": "SugarPDF\nOverview\nAn overview of SugarPDF and how it relates to TCPDF.\u00c2\u00a0As of version\u00c2\u00a06.7.x, Sugar includes a Smarty template engine called\u00c2\u00a0PDF Manager that is accessible by navigating to Admin > PDF Manager. The\u00c2\u00a0PDF Manager allows administrators to create and manage templates for deployed modules without having to write custom code. \u00c2\u00a0The following sections are only specific to developers looking to create their own custom TCPDF\u00c2\u00a0templates using PHP.\nPDF Classes\nThe various classes used in generating PDFs within Sugar.\nTCPDF\nSugar uses the TCPDF 4.6.013\u00c2\u00a0library, located in ./vendor/tcpdf/,\u00c2\u00a0as the core engine to generate PDFs. This library is extended by Sugarpdf\u00c2\u00a0which is used by the core application to generate PDFs.\u00c2\u00a0\nSugarpdf\nThe Sugarpdf class, located in ./include/Sugarpdf/Sugarpdf.php, extends the TCPDF class. Within this class, we have overridden certain functions to integrate sugar features. Some key methods that were overridden are listed below:\u00c2\u00a0\nMethod\nDescription\nHeader\nOverridden to enable custom logos.\nSetFont\nOverridden to allow for the loading of custom fonts. The custom fonts direction is defined by the K_PATH_CUSTOM_FONTS var. By default, this value is set to ./custom/vendor/tcpdf/fonts/\nCell\nOverridden to apply the prepare_string() function. This allows for the ability to clean the string before sending to PDF. \u00c2\u00a0\nSome key additional methods that were added are listed below:\nMethod\nDescription\npredisplay\nPreprocessing before the display method is called. Is intended to setup general PDF document properties like margin, footer, header, etc.\ndisplay\nPerforms the actual PDF content generation. This is where the logic to display output to the PDF should be placed.\nprocess", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarPDF/index.html"}
{"id": "40a0588ef00e-1", "text": "process\nCalls predisplay and display.\nwriteCellTable\nMethod to print a table using the cell print method of TCPDF\nwriteHTMLTable\nMethod to print a table using the writeHTML print method of TCPDF\nCustom PDF classes that extend Sugarpdf can be located in the following directories:\n./include/Sugarpdf/sugarpdf/sugarpdf.<pdf view>.php\n./modules/<module>/sugarpdf/sugarpdf.<pdf view>.php\n./custom/modules/<module>/sugarpdf/sugarpdf.<pdf view>.php\nPDF Manager classes\u00c2\u00a0that extend Sugarpdf are located in the following directories:\n./include/Sugarpdf/sugarpdf/sugarpdf.smarty.php\n./include/Sugarpdf/sugarpdf/sugarpdf.pdfmanager.php\n./custom/include/Sugarpdf/sugarpdf/sugarpdf.pdfmanager.php\nEach extended class will define a specific PDF view that is accessible with the following URL parameters:\nmodule=<module>\naction=sugarpdf\nsugarpdf=<pdf view>\nWithin each custom PDF class, the display method will need to be redefined. If you would like, It is also possible to override other methods like Header. The process method of this class will be called from ViewSugarpdf. When a PDF is being generated, the most relevant sugarpdf.<pdf action>.pdf class is determined by the SugarpdfFactory.\nViewSugarpdf\nThe ViewSugarpdf class, located in ./include/MVC/View/views/view.sugarpdf.php,\u00c2\u00a0is used to create the SugarViews that generate PDFs. These views can be found and/or created in one of the following directory paths:\n./modules/<module>/views/view.sugarpdf.php\n./custom/modules/<module>/views/view.sugarpdf.php", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarPDF/index.html"}
{"id": "40a0588ef00e-2", "text": "./custom/modules/<module>/views/view.sugarpdf.php\nSugarViews can be called by navigating to a URL in the format of:\nhttp://<url>/index.php?module=<module>&action=sugarpdf&sugarpdf=<pdf action>\nAs of 6.7, PDFs are mainly generated using the PDF Manager templating system. To generate the PDF stored in the PDF Manager, you would call a URL in the format of:\nhttp://<url>/index.php?module<module>&record=<record id>&action=sugarpdf&sugarpdf=pdfmanager&pdf_template_id=<template id>\u00c2\u00a0\u00c2\u00a0\nSugarpdfFactory\nThe ViewSugarpdf\u00c2\u00a0class uses the SugarpdfFactory class, located in ./include/Sugarpdf/SugarpdfFactory.php, to find the most relevant sugarpdf.<pdf action>.pdf\u00c2\u00a0class which generates the PDF document for a given PDF view and module. If one is not found, then the core\u00c2\u00a0Sugarpdf\u00c2\u00a0class is used.\nThe SugarpdfFactory\u00c2\u00a0class loads the first class found for the specified PDF action as determined by the following order:\n./custom/modules/<module>/sugarpdf/sugarpdf.<pdf view>.php\n./modules/<module>/sugarpdf/sugarpdf.<pdf view>.php\n./custom/include/Sugarpdf/sugarpdf/sugarpdf.<pdf view>.php\n./include/Sugarpdf/sugarpdf/sugarpdf.<pdf view>.php\n./include/Sugarpdf/sugarpdf.php\nSugarpdfHelper", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarPDF/index.html"}
{"id": "40a0588ef00e-3", "text": "./include/Sugarpdf/sugarpdf.php\nSugarpdfHelper\nThe SugarpdfHelper, located in ./include/Sugarpdf/SugarpdfHelper.php, is included by Sugarpdf. This is a utility file that contains many of the functions we use to generate PDFs. Available functions are:\nwrapTag, wrapTD, wrapTable, etc. : These functions help to create an HTML code.\nprepare_string : This function prepare a string to be ready for the PDF printing.\nformat_number_sugarpdf : This function is a copy of format_number() from currency with a fix for sugarpdf.\nPdfManagerHelper\nThe\u00c2\u00a0PdfManagerHelper, located in ./modules/PdfManager/PdfManagerHelper.php, is primarily utilized by the pdfmanager Sugarpdf\u00c2\u00a0view. This class file contains methods useful for accessing PDF Manager templates. Some of the primary methods are:\ngetAvailableModules :\u00c2\u00a0Returns an array of available modules for use with PdfManager.\ngetFields :\u00c2\u00a0Takes an module name and returns a list of fields and links available for this module in PdfManager.\ngetPublishedTemplatesForModule :\u00c2\u00a0Returns an array of\u00c2\u00a0the available templates for a specific module.\nFontManager\nThe FontManagerclass, located in ./include/Sugarpdf/FontManager.php, is a stand-alone class that manages all the fonts for TCPDF. More information can be found in the PDF Fonts\u00c2\u00a0section below.\nFunctionality:\nList all the available fonts from the OOB font directory and the custom font directory (it can create a well-formatted list for select tag).\nGet the details of each listed font (Type, size, encoding,...) by reading the font php file.\nAdd a new font to the custom font directory from a font file and a metric file.\nDelete a font from the custom font directory.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarPDF/index.html"}
{"id": "40a0588ef00e-4", "text": "Delete a font from the custom font directory.\nGenerating a PDF\nTo generate a custom PDF in Sugar, you will need to create a PDF view that extends the Sugarpdf class. To accomplish\u00c2\u00a0this, create the file:\n\u00c2\u00a0./custom/modules/<module>/sugarpdf/sugarpdf.<pdf view>.php\n<?php\nif(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nrequire_once('include/Sugarpdf/Sugarpdf.php');\nclass <module>Sugarpdf<pdf view> extends Sugarpdf\n{\n    /**\n     * Override\n     */\n    function process(){\n        $this->preDisplay();\n        $this->display();\n        $this->buildFileName();\n    }\n    /**\n     * Custom header\n     */\n    public function Header()\n    {\n        $this->SetFont(PDF_FONT_NAME_MAIN, 'B', 16);\n        $this->MultiCell(0, 0, 'TCPDF Header',0,'C');\n        $this->drawLine();\n    }\n    /**\n     * Custom header\n     */\n    public function Footer()\n    {\n        $this->SetFont(PDF_FONT_NAME_MAIN, '', 8);\n        $this->MultiCell(0,0,'TCPDF Footer', 0, 'C');\n    }\n    /**\n     * Predisplay content\n     */\n    function preDisplay()\n    {\n        //Adds a predisplay page\n        $this->AddPage();\n        $this->SetFont(PDF_FONT_NAME_MAIN,'',PDF_FONT_SIZE_MAIN);\n        $this->Ln();\n        $this->MultiCell(0,0,'Predisplay Content',0,'C');\n    }\n    /**\n     * Main content\n     */", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarPDF/index.html"}
{"id": "40a0588ef00e-5", "text": "}\n    /**\n     * Main content\n     */\n    function display()\n    {\n        //add a display page\n        $this->AddPage();\n        $this->SetFont(PDF_FONT_NAME_MAIN,'',PDF_FONT_SIZE_MAIN);\n        $this->Ln();\n        $this->MultiCell(0,0,'Display Content',0,'C');\n    }\n    /**\n     * Build filename\n     */\n    function buildFileName()\n    {\n        $this->fileName = 'example.pdf';\n    }\n    /**\n     * This method draw an horizontal line with a specific style.\n     */\n    protected function drawLine()\n    {\n        $this->SetLineStyle(array('width' => 0.85 / $this->getScaleFactor(), 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(220, 220, 220)));\n        $this->MultiCell(0, 0, '', 'T', 0, 'C');\n    }\n}\nThis file will contain the markup for the PDF. The main things to note are the Header(), Footer() and display() methods as they contain most of the styling and display logic. The method buildFileName() will generate the document's name when downloaded by the user.\nOnce in place, navigate to Admin > Repair > Quick Repair and Rebuild. The PDF will now be accessible\u00c2\u00a0by\u00c2\u00a0navigating to the following url in your browser:\nhttp://{sugar url}/index.php?module=<module>&action=sugarpdf&sugarpdf=<pdf action>\nPDF Settings\nThis section will outline how to configure the PDF settings. These settings determine the widths, heights, images, pdf metadata, and\u00c2\u00a0the UI configurations found in:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarPDF/index.html"}
{"id": "40a0588ef00e-6", "text": "Admin > PDF Manager > Edit Report PDF Template \nSettings\nThe default PDF settings for TCPDF can be found in ./include/Sugarpdf/sugarpdf_default.php. You can add additional custom settings by creating the following file:\n./custom/include/Sugarpdf/sugarpdf_default.php\n<?php\n$sugarpdf_default[\"PDF_NEW_SETTING\"] = \"Value\";\nYou should note that values specified here will be the default values. Once edited, the updated values are stored in the database config table under the category \"sugarpdf\" and a name matching the setting name.\ncategory: sugarpdf\nname: pdf_new_setting\nvalue: Value\nDisplaying and Editing Settings\nA select set of settings can be edited within the Sugar UI by navigating to:\n  Admin > PDF Manager > Edit Report PDF Template\nThe settings here are managed in the file ./modules/Configurator/metadata/SugarpdfSettingsdefs.php. A brief description of the settings parameters are listed below:\nlabel : This is the display label for the setting.\ninfo_label : Hover info text for the display label.\nvalue : The PDF Setting.\nclass : Determines which panel the setting resides in. Possible values are 'basic' and 'logo'. 'advanced' is not currently an available value.\ntype : Determines the settings display widget. Possible values are: 'image', 'text', 'percent', 'multiselect', 'bool', 'password', and 'file'.\nCustom settings can be added to this page by creating ./custom/modules/Configurator/metadata/SugarpdfSettingsdefs.php and specifying a new setting index. An example is below:\n./custom/modules/Configurator/metadata/SugarpdfSettingsdefs.php\n<?php\n    //Retrieve setting info from db\n    defineFromConfig(\"PDF_NEW_SETTING\", $sugarpdf_default[\"PDF_NEW_SETTING\"]);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarPDF/index.html"}
{"id": "40a0588ef00e-7", "text": "//Add setting display\n    $SugarpdfSettings['sugarpdf_pdf_new_setting'] = array(\n        \"label\" => $mod_strings[\"LBL_PDF_NEW_SETTING_TITLE\"],\n        \"info_label\" => $mod_strings[\"LBL_PDF_NEW_SETTING_INFO\"],\n        \"value\" => PDF_NEW_SETTING,\n        \"class\" => \"basic\",\n        \"type\" => \"text\",\n    );\nYou should note that the $SugarpdfSettings index should following the format sugarpdf_pdf_<setting name>. If your setting does not follow this format, it will not be saved or retrieved from the database correctly.\nOnce the setting is defined, you will need to define the display text for the UI setting.\n./custom/modules/Configurator/language/en_us.lang.php\nOnce finished, navigate to Admin > Repair > Quick Repair and Rebuild. This will rebuild the language files for your display text.\nPDF Fonts\nThe stock fonts for TCPDF are stored in the directory ./vendor/tcpdf/fonts/. If you would like to add additional fonts to the system, they should be added to the ./custom/vendor/tcpdf/fonts/\u00c2\u00a0directory.\nFont Cache\nThe font list is built by the font manager with the listFontFiles() or getSelectFontList() methods. The list is then saved in the cache as ./cache/Sugarpdf/cachedFontList.php. This caching process prevents unnecessary parsing of the fonts folder. The font cache is automatically cleared when the delete() or add() methods are used. When you create a module loader package to install fonts you will have to call the clearCachedFile() method in a post_execute and post_uninstall action in the manifest.php to clear the font cache.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarPDF/index.html"}
{"id": "6a48f6d4687a-0", "text": "Elastic Search\nOverview\nThe focus of this document is to guide developers on how Sugar integrates with Elastic Search.\nResources\nWe recommend the following resources to get started with Elasticsearch:\nElasticsearch: The Definitive Guide\nElasticsearch Reference\nDeployment\nThe following figure shows a typical topology of Elasticsearch with a Sugar system. All the communication with Elasticsearch goes through Sugar via REST APIs.\nFramework\nThe following figure shows the overall architecture with main components in the Elasticsearch framework and related components in Sugar framework.\nMain Components\nThis section describes how to use each of the main components in detail.\nMapping Manager\nThis component builds the mappings for providers in the system. The mappings are used for Elastic to interpret data stored there, which is similar to a database schema.\nDefine the full_text_search\u00c2\u00a0property in a module's vardef\u00c2\u00a0file for a given field:\nenabled\u00c2\u00a0: sets the field to be enabled for global search;\nsearchable\u00c2\u00a0: sets the field to be searchable or not;\nboost\u00c2\u00a0: sets the boost value so that the field can be ranked differently at search time.\ntype : overrides the sugar type originally defined;\naggregations : sets the properties specific related to aggregations;\nDefine what analyzers to use for a given sugar type:\nThe analyzers for both indexing and searching are specified. They may be different for the same field. The index analyzer is used at indexing time, while the search analyzer is used at query time.\nEach of the providers generates its own mapping.\nGenerates mappings for each field and sends it over to Elasticsearch.\nExample Mapping\nThis section outlines how the mapping is created for Account module's name field. The Account module's name field is defined as \"searchable\" in the \"full_text_search\" index of the vardefs. The Sugar type \"name\" uses the regular and ngram string analyzers for indexing and search.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Elastic_Search/index.html"}
{"id": "6a48f6d4687a-1", "text": "./modules/Accounts/vardefs.php\n...\n'name' => array(\n    'name' => 'name',\n    'type' => 'name',\n    'dbType' => 'varchar',\n    'vname' => 'LBL_NAME',\n    'len' => 150,\n    'comment' => 'Name of the Company',\n    'unified_search' => true,\n    'full_text_search' => array(\n        'enabled' => true,\n        'searchable' => true,\n        'boost' => 1.9099999999999999,\n    ),\n    'audited' => true,\n    'required' => true,\n    'importable' => 'required',\n    'duplicate_on_record_copy' => 'always',\n    'merge_filter' => 'selected',\n),\n...\nThe field handler, located in ./src/Elasticsearch/Provider/GlobalSearch/Handler/Implement/MultiFieldHandler.php, defines the mappings used by Elasticsearch. The class property $typesMultiField\u00c2\u00a0in the MultiFieldHandler class defines the relationship between types and\u00c2\u00a0mappings. For the \"name\" type, we use the gs_string and gs_string_wildcard\u00c2\u00a0definitions to define our mappings and analyzers.\n./src/Elasticsearch/Provider/GlobalSearch/Handler/Implement/MultiFieldHandler.php\n...\nprotected $typesMultiField = array(\n    ...\n    'name' => array(\n        'gs_string',\n        'gs_string_wildcard',\n    ),\n    ...\n);\n...\nThe class property $multiFieldDefs\u00c2\u00a0in the MultiFieldHandler class defines the actual Elasticsearch mapping to be used.\n...\nprotected $multiFieldDefs = [\n    ...\n    /*\n     * Default string analyzer with full word matching base ond", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Elastic_Search/index.html"}
{"id": "6a48f6d4687a-2", "text": "...\n    /*\n     * Default string analyzer with full word matching base ond\n     * the standard analyzer. This will generate hits on the full\n     * words tokenized by the standard analyzer.\n     */\n    'gs_string' => [\n        'type' => 'text',\n        'index' => true,\n        'analyzer' => 'gs_analyzer_string',\n        'store' => true,\n    ],\n    /*\n     * String analyzer using ngrams for wildcard matching. The\n     * weighting of the hits on this mapping are less than full\n     * matches using the default string mapping.\n     */\n    'gs_string_wildcard' => [\n        'type' => 'text',\n        'index' => true,\n        'analyzer' => 'gs_analyzer_string_ngram',\n        'search_analyzer' => 'gs_analyzer_string',\n        'store' => true,\n    ],\n    ...\n];\n...\nThe mapping is created from the definitions in Elasticsearch. A sample mapping is shown below:\n\"Accounts__name\": {\n\t\"include_in_all\": false,\n\t\"index\": \"not_analyzed\",\n\t\"type\": \"string\",\n\t\"fields\":{\n\t\t\"gs_string_wildcard\":{\n\t\t\t\"index_analyzer\": \"gs_analyzer_string_ngram\",\n\t\t\t\"store\": true,\n\t\t\t\"search_analyzer\": \"gs_analyzer_string\",\n\t\t\t\"type\": \"string\"\n\t\t},\n\t\t\"gs_string\":{\n\t\t\t\"store\": true,\n\t\t\t\"analyzer\": \"gs_analyzer_string\",\n\t\t\t\"type\": \"string\"\n\t\t}\n\t}\n}\nIndex Manager", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Elastic_Search/index.html"}
{"id": "6a48f6d4687a-3", "text": "\"type\": \"string\"\n\t\t}\n\t}\n}\nIndex Manager\nAn index includes types, similar to a database including tables. In our system, a type is based on a module consisting of mappings.\nAs shown in the following figure, the Index Manager combines the analysis built from Analysis Builder and the mappings from Mapping Manager from different providers and organizes them by modules.\nIndexer & Queue Manager\nAfter creating the index, data needs to be moved from the Sugar system to Elasticsearch. The queue manager uses the\u00c2\u00a0\u00c2\u00a0fts_queue and job_queue\u00c2\u00a0tables to queue the information. The indexer then processes data from Sugar bean into the format of Elasticsearch\u00c2\u00a0documents.\nThe whole process is as follows:\nEach Sugar bean is added to fts_queue table.\nElasticsearch queue scheduler is added to job_queue table.\nWhen the job starts, the scheduler generates an Elasticsearch\u00c2\u00a0queue consumer for each module.\nEach consumer queries the\u00c2\u00a0fts_queue table fo find the corresponding sugar beans.\nThe indexer gets fields from each bean and processes them into individual documents.\nThe indexer uses the bulk APIs to send documents to Elasticsearch in batches.\nGlobal Search Provider\nThe provider supplies information to build analysis, mapping, query, etc. It is done by using handlers. Currently, there are two providers in the system: global search and visibility. To extend the functionalities, new providers and handlers may be added.\nThe following figure shows the existing handler interfaces and some of the handlers implementing them.\nQuery Builder\nThe Query builder composes the query string for search. A structure of a typical multi-match query is shown as follows:\n{\n    \"query\": {\n        \"filtered\": {\n            \"query\": {\n                \"bool\": {\n                    \"must\": [{\n                        \"bool\": {\n                            \"should\": [{\n                                \"multi_match\": {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Elastic_Search/index.html"}
{"id": "6a48f6d4687a-4", "text": "\"bool\": {\n                            \"should\": [{\n                                \"multi_match\": {\n                                    \"type\": \"cross_fields\",\n                                    \"query\": \"test\",\n                                    \"fields\": [\n                                        \"Cases__name.gs_string^1.53\",\n                                        \"Cases__name.gs_string_wildcard^0.69\",\n                                        \"Cases__description.gs_string^0.66\",\n                                        \"Cases__description.gs_text_wildcard^0.23\",\n                                        \"Bugs__name.gs_string^1.51\",\n                                        \"Bugs__name.gs_string_wildcard^0.68\",\n                                        \"Bugs__description.gs_string^0.68\",\n                                        \"Bugs__description.gs_text_wildcard^0.24\"\n                                    ],\n                                    \"tie_breaker\": 1\n                                }\n                            }]\n                        }\n                    },\n                    {\n                        \"bool\": {\n                            \"should\": [{\n                                \"multi_match\": {\n                                    \"type\": \"cross_fields\",\n                                    \"query\": \"query\",\n                                    \"fields\": [\n                                        \"Cases__name.gs_string^1.53\",\n                                        \"Cases__name.gs_string_wildcard^0.69\",\n                                        \"Cases__description.gs_string^0.66\",\n                                        \"Cases__description.gs_text_wildcard^0.23\",\n                                        \"Bugs__name.gs_string^1.51\",\n                                        \"Bugs__name.gs_string_wildcard^0.68\",\n                                        \"Bugs__description.gs_string^0.68\",\n                                        \"Bugs__description.gs_text_wildcard^0.24\"\n                                    ],\n                                    \"tie_breaker\": 1\n                                }\n                            }]\n                        }\n                    }]\n                }\n            },\n            \"filter\": {\n                \"bool\": {\n                    \"must\": [{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Elastic_Search/index.html"}
{"id": "6a48f6d4687a-5", "text": "\"filter\": {\n                \"bool\": {\n                    \"must\": [{\n                        \"bool\": {\n                            \"should\": [{\n                                \"bool\": {\n                                    \"must\": [{\n                                        \"term\": {\n                                            \"_type\": \"Bugs\"\n                                        }\n                                    }]\n                                }\n                            },\n                            {\n                                \"bool\": {\n                                    \"must\": [{\n                                        \"term\": {\n                                            \"_type\": \"Cases\"\n                                        }\n                                    }]\n                                }\n                            }]\n                        }\n                    }]\n                }\n            }\n        }\n    },\n    \"highlight\": {\n        \"pre_tags\": [\n            \"<strong>\"\n        ],\n        \"post_tags\": [\n            \"<\\/strong>\"\n        ],\n        \"require_field_match\": 1,\n        \"number_of_fragments\": 3,\n        \"fragment_size\": 255,\n        \"encoder\": \"html\",\n        \"order\": \"score\",\n        \"fields\": {\n            \"*.gs_string\": {\n                \"type\": \"plain\",\n                \"force_source\": false\n            },\n            \"*.gs_string_exact\": {\n                \"type\": \"plain\",\n                \"force_source\": false\n            },\n            \"*.gs_string_html\": {\n                \"type\": \"plain\",\n                \"force_source\": false\n            },\n            \"*.gs_string_wildcard\": {\n                \"type\": \"plain\",\n                \"force_source\": false\n            },\n            \"*.gs_text_wildcard\": {\n                \"type\": \"plain\",\n                \"force_source\": false\n            },\n            \"*.gs_phone_wildcard\": {\n                \"type\": \"plain\",\n                \"force_source\": false\n            },\n            \"*.gs_email\": {\n                \"type\": \"plain\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Elastic_Search/index.html"}
{"id": "6a48f6d4687a-6", "text": "},\n            \"*.gs_email\": {\n                \"type\": \"plain\",\n                \"force_source\": false,\n                \"number_of_fragments\": 0\n            },\n            \"*.gs_email_wildcard\": {\n                \"type\": \"plain\",\n                \"force_source\": false,\n                \"number_of_fragments\": 0\n            }\n        }\n    }\n}\nFigure 7: Multi-match query with aggregations.\nA query may include multiple filters, post filters, queries, and settings, which can get complicated sometimes. To add new queries, we recommend adding new classes implementing QueryInterface, instead of modifying Query Builder or even calling Elastica APIs directly.\nACL\nACL control is done in the Query Builder. The search fields are filtered based on their ACL access levels when being added to the query string in a specific query. For instance, MultiMatchQuery used for global search may include the following filterings:\nIf a field is owner read (i.e., SugarACL::ACL_OWNER_READ_WRITE), it will be added to a sub-query with a filter of ownerId.\nIf a field is not owner read, its access level must not equal to SugarACL::ACL_NO_ACCESS, in order to be added as one of the search fields in the query.\nThe corresponding function is MultiMatchQuery.php::isFieldAccessible(). Potentially this function can be shared by different queries that require ACL control.\nVisibility\nThe visibility model is applied when building the query too. It is done by adding filters built by individual visibility strategies, defined in ./data/visibility/ directory. These strategies implement StrategyInterface including:\nbuilding analysis,\nbuilding mapping,\nprocessing document before being indexed,\ngetting bean index fields,\nadding visibility filters.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Elastic_Search/index.html"}
{"id": "6a48f6d4687a-7", "text": "processing document before being indexed,\ngetting bean index fields,\nadding visibility filters.\nThe functions are similar to the global search provider's handler interfaces. The query builder only uses adding the visibility filters, while others provide information to Analysis builder, Mapping Manager, Indexer, etc. Hence the visibility provider is separated as an independent provider in the framework.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Elastic_Search/index.html"}
{"id": "ecd32c942174-0", "text": "Uploads\nOverview\nThe upload directory is used to store files uploaded for imports, attachments, documents, and module loadable packages.\nUploads\nThe upload directory is used to store any files uploaded to Sugar. By default, anything uploaded to Sugar is stored in the ./upload/ directory. You can change this directory by updating the upload_dir configuration variable. Once uploaded, the file will be stored in this directory with a GUID name.\nThere\u00c2\u00a0are\u00c2\u00a0several file-size limits that affect uploads to Sugar:\nSetting Name\nLocation\nDescription\nDefault\nupload_max_filesize\nphp.ini\nMaximum allowed size for uploaded files\n2 MB\npost_max_size\nphp.ini\nMaximum size of POST data that PHP will accept\n8 MB\u00c2\u00a0\nupload_maxsize\nconfig.php\nThe maximum individual file size that users can upload to modules that support file uploads\n30 MB\nmax_aggregate_email_attachments_bytes\nconfig.php\nThe maximum allowed size of all uploaded attachments added together for a single email message\n10 MB\nThe lowest of the first three values above will be respected when an oversized file is uploaded to Sugar. The first two\u00c2\u00a0settings\u00c2\u00a0are the PHP server's\u00c2\u00a0upload_max_filesize and post_max_size, which are configured in your system's php.ini file. The third setting is the Sugar configuration\u00c2\u00a0for\u00c2\u00a0upload_maxsize,\u00c2\u00a0which will restrict the upload limit from within Sugar without affecting any other applications that may be running on your server. This limit can be easily adjusted in Sugar via Admin > System Settings but is only useful if it is set to a size smaller than the php.ini limits.\nFinally, the max_aggregate_email_attachments_bytes setting will permit users to upload files as email attachments according to the previous size limits but restrict users from uploading more files to a single message than its configuration permits.\u00c2", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Uploads/index.html"}
{"id": "ecd32c942174-1", "text": "Note:\u00c2\u00a0PHP-defined file size settings and the upload directory cannot be modified for instances hosted on Sugar's cloud service.\nUpload Extensions\nBy default, several extension types are restricted due to security issues. Any files uploaded with these extensions will have '.txt' appended to it. The restricted extensions are listed below:\nphp\nphp3\nphp4\nphp5\npl\ncgi\npy\nasp\ncfm\njs\nvbs\nhtml\nhtm\nYou can add or remove extensions to this list by modifying sugar configuration setting for upload_badext. You should note that this setting cannot be modified for instances hosted on Sugar's cloud service.\nHow Files Are Stored\nNote Attachments\nWhen a file is uploaded to Sugar attached to a note, the file will be moved to the upload directory with a GUID name matching that of the notes id. The attributes of the file, such as filename and file_mime_type, will be stored in the note record.\nThe SQL to fetch information about a notes attachment is shown below:\nSELECT filename, file_mime_type FROM notes;\nEmail Attachments\nEmail attachments are stored the same way as note attachments. When an email is imported to Sugar, the file will be moved to the upload directory with a GUID file name matching that of the notes id. The attributes of the file, such as filename and file_mime_type, will be stored in the note record and the note will have a parent_type of 'Emails'. This relates the attachment to the content of the email.\nThe SQL to fetch information about an emails attachment is shown below:\nSELECT filename, file_mime_type FROM notes INNER JOIN emails ON notes.parent_type = 'Emails' AND notes.parent_id = emails.id INNER JOIN emails_text ON emails.id = emails_text.email_id;\nPicture Fields", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Uploads/index.html"}
{"id": "ecd32c942174-2", "text": "Picture Fields\nPicture fields will upload the image to the upload directory with a GUID name and store the GUID in the database field on the record. An example of picture field can be found on the Contacts module.\nFor a contact, the id of the picture attachment can be found with the SQL below:\nSELECT picture FROM contacts;\nKnowledge Base Attachments\nWhen working with the Knowledge Base, files and images attached to the form will be created as a record in the /#EmbeddedFiles module. These files will be stored as <GUID> of EmbbededFiles record in the upload folder.All other file enclosed to attachments field of KBContents will be also saved as Notes record in the upload folder.\nThe SQL to fetch information about a knowledge base attachment is shown below:\nselect kb.id, kb.name, kb.revision, n.filename, n.file_mime_type, n.file_ext from notes n, kbcontents kb where n.parent_type = \"KBContents\" and n.parent_id = kb.id order by kb.name, kb.revision;\nModule Loadable Packages\nModule Loader packages are stored in the system differently than other uploads. They are uploaded to the ./upgrades/module directory,\u00c2\u00a0each uploaded file is now stored in a subdirectory derived from the UUID filename. Existing files will be moved into subdirectories during upgrade.\u00c2\u00a0For example, the file\u00c2\u00a03657325a-bdd6-11eb-9a6c-08002723a3b8\u00c2\u00a0will now be stored in the\u00c2\u00a0./upload/25a/\u00c2\u00a0subdirectory. These UID character locations were selected to ensure even distribution of files across the new subdirectories.\nThe details of the package, such as installation status and description, are stored in the upgrade_history table.\nThe SQL to fetch information about an installed package is shown below:\nSELECT * FROM upgrade_history;\nCSV Imports", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Uploads/index.html"}
{"id": "ecd32c942174-3", "text": "SELECT * FROM upgrade_history;\nCSV Imports\nWhen importing records into Sugar, the most recent uploaded CSV file is stored in the upload directory as IMPORT_<module>_<user id>. Once the import has been run, the results of the import are stored in ./upload/import/ directory using a predefined format using the current user's id. The files created will be as follows:\ndupes_<user id>.csv : The list of duplicate records found during the import\ndupesdisplay_<user_id>.csv : The HTML formatted CSV for display to the user after import\nerror_<user id>.csv : The list of errors encountered during the import\nerrorrecords_<user_id>.csv : The HTML formatted CSV for display to the user after import\nerrorrecordsonly_<user id>.csv : The list of records that encountered an error\nstatus_<user id>.csv : Determines the status of the users import\nTopicsWorking with File UploadsThe UploadFile class handles the various tasks when uploading a file.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Uploads/index.html"}
{"id": "b990a25ed0f1-0", "text": "Working with File Uploads\nOverview\nThe UploadFile class handles the various tasks when uploading a file.\nRetrieving a Files Upload Location\nTo retrieve a files upload path, you can use the get_upload_path method and pass in the file's GUID id.\nrequire_once 'include/upload_file.php';\nUploadFile::get_upload_path($file_id);\nThis method will normally return the path as:\nupload://1d0fd9cc-02e5-f6cd-1426-51a509a63334\nRetrieving a Files Full File System Location\nTo retrieve a files full system path, you can use the get_upload_path and real_path methods as shown below:\nrequire_once 'include/upload_file.php';\nUploadFile::realpath(UploadFile::get_upload_path($file_id));\nThis method will normally return the path where they are uploaded to. Each uploaded file is now stored in a subdirectory derived from the UUID filename. Existing files will be moved into subdirectories during upgrade.\u00c2\u00a0For example, the file\u00c2\u00a03657325a-bdd6-11eb-9a6c-08002723a3b8\u00c2\u00a0will now be stored in the\u00c2\u00a0./upload/25a/\u00c2\u00a0subdirectory. These UID character locations were selected to ensure even distribution of files across the new subdirectories.\nRetrieving a Files Contents\nAs an alternative to using file_get_contents or sugar_file_get_contents, you can retrieve the contents of a file using the get_file_contents method as shown below:\nrequire_once 'include/upload_file.php';\n$file = new UploadFile();\n//get the file location\n$file->temp_file_location = UploadFile::get_upload_path($file_id);\n$file_contents = $file->get_file_contents();\nDuplicating a File", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Uploads/UploadFile/index.html"}
{"id": "b990a25ed0f1-1", "text": "$file_contents = $file->get_file_contents();\nDuplicating a File\nTo duplicate an uploaded file, you can use the\u00c2\u00a0duplicate_file method by passing in the files current id and the id you would like it copied to as\u00c2\u00a0shown below:\nrequire_once 'include/upload_file.php';\n$uploadFile = new UploadFile();\n$result = $uploadFile->duplicate_file($oldFileId, $newFileId);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Uploads/UploadFile/index.html"}
{"id": "3178a93c1057-0", "text": "This page refers to beta functionality. Please be advised that the content of this page is subject to change.\nCLI\nOverview\nSugar on-premise deployments include a command line interface tool built using the Symfony Console Framework. Sugar's CLI is intended to be an\u00c2\u00a0administrator or developer level power tool to execute PHP code in the context of Sugar's code base. These commands are version specific and can be executed on a preinstalled Sugar instance or on an installed Sugar instance. Sugar's CLI is not intended to be used as a tool to interact remotely with an instance nor is it designed\u00c2\u00a0to interact with multiple instances.\u00c2\u00a0\nCommands\nSugar Commands are an implementation of\u00c2\u00a0Console Commands. They extend the base console classes to execute\u00c2\u00a0Sugar specific actions. Each instance of Sugar is shipped with a list of predefined commands. The current list of commands is shown below.\nCommand\nDescription\nhelp\nDisplays help for a command\nlist\nLists commands\naclcache:dump\nDumps ACL cache contents into cache/acldumps folder\nelastic:explain\nExecute global search explain queries for debugging purposes. As this will generate a lot of output in JSON format, it is recommended to redirect the output to a file for later processing\nelastic:indices\nShow Elasticsearch index statistics\nelastic:queue\nShow Elasticsearch queue statistics\nelastic:queue_cleanup\nCleanup records from Elasticsearch queue\nelastic:refresh_enable\nEnable refresh on all indices\nelastic:refresh_status\nShow Elasticsearch index refresh status\nelastic:refresh_trigger\nPerform a manual refresh on all indices\nelastic:replicas_enable\nEnable replicas on all indices\nelastic:replicas_status\nShow Elasticsearch index refresh status\nelastic:routing\nShow Elasticsearch index routing\nidm-mode:manage\nenable, disable IDM mode, or move config data to DB\npassword:config\nShow password hash configuration\npassword:reset\nReset user password for local user authentication\npassword:weak", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/CLI/index.html"}
{"id": "3178a93c1057-1", "text": "password:reset\nReset user password for local user authentication\npassword:weak\nShow users having weak or non-compliant password hashes\nsearch:fields\nShow search engine enabled fields\nsearch:module\nEnable/disable given module for search\nsearch:reindex\nSchedule SearchEngine reindex\nsearch:silent_reindex\nCreate mappings and index the data\nsearch:silent_reindex_mp\nCreate mappings and index the data using multi-processing\nsearch:status\nShow search engine availability and enabled modules\nteam-security:rebuild\nRebuild denormalized team security data\nteam-security:status\nDisplay the status of the denormalized data\nteamset:backup\nBacks up the team_sets related tables\nteamset:prune\nPrune all team set tables of unused team sets. Original tables will be backed up automatically. DO NOT USE while users are logged into the system\nteamset:restore_from_backup\nRestores all team set tables from backups. DO NOT USE while users are logged into the system\nteamset:scan\nScan all module tables for unused team sets and report the number found\nteamset:sql\nPrint the sql query used to search for unused teamsets\nNote : For advanced users, a bash autocompletion script for CLI is located at ./src/Console/Resources/sugarcrm-bash-completion for inclusion in \u00c2\u00a0~/.bashrc. More details on using the script can be found in the file's header comments.\nUsage\nThe command executable, located at\u00c2\u00a0./bin/sugarcrm, is executed from the root of the Sugar instance. The command signature is shown below:\nphp bin/sugarcrm <command> [options] [arguments]\nHelp\nThe command console has built-in help documentation. If you pass in a command that isn't found, you will be shown the default help documentation.\u00c2\u00a0\nSugarCRM Console version <version>\nUsage:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/CLI/index.html"}
{"id": "3178a93c1057-2", "text": "SugarCRM Console version <version>\nUsage:\n  command [options] [arguments]\nOptions:\n  -h, --help            Display this help message\n  -q, --quiet           Do not output any message\n  -V, --version         Display this application version\n      --ansi            Force ANSI output\n      --no-ansi         Disable ANSI output\n  -n, --no-interaction  Do not ask any interactive question\n      --profile         Display timing and memory usage information\n  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug\nAvailable commands:\n  help             Displays help for a command\n  list             Lists commands\n aclcache\n  aclcache:dump                Dumps ACL cache contents into cache/acldumps folder.\n elastic\n  elastic:explain              Execute global search explain queries for debugging purposes. As this will generate a lot of output in JSON format, it is recommended to redirect the output to a file for later processing.\n  elastic:indices              Show Elasticsearch index statistics\n  elastic:queue                Show Elasticsearch queue statistics\n  elastic:queue_cleanup        Cleanup records from Elasticsearch queue.\n  elastic:refresh_enable       Enable refresh on all indices\n  elastic:refresh_status       Show Elasticsearch index refresh status\n  elastic:refresh_trigger      Perform a manual refresh on all indices\n  elastic:replicas_enable      Enable replicas on all indices\n  elastic:replicas_status      Show Elasticsearch index refresh status\n  elastic:routing              Show Elasticsearch index routing\n idm-mode\n  idm-mode:manage              enable, disable IDM mode, or move config data to DB\n password\n  password:config              Show password hash configuration\n  password:reset               Reset user password for local user authentication.\n  password:weak                Show users having weak or non-compliant password hashes\n search", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/CLI/index.html"}
{"id": "3178a93c1057-3", "text": "password:weak                Show users having weak or non-compliant password hashes\n search\n  search:fields                Show search engine enabled fields\n  search:module                Enable/disable given module for search\n  search:reindex               Create mappings and schedule a reindex\n  search:silent_reindex        Create mappings and index the data\n  search:silent_reindex_mp     Create mappings and index the data using multi-processing\n  search:status                Show search engine availability and enabled modules\n team-security\n  team-security:rebuild        Rebuild denormalized team security data\n  team-security:status         Display the status of the denormalized data\n teamset\n  teamset:backup               Backs up the team_sets related tables.\n  teamset:prune                Prune all team set tables of unused team sets. Original tables will be backed up automatically. DO NOT USE while users are logged into the system!\n  teamset:restore_from_backup  Restores all team set tables from backups. DO NOT USE while users are logged into the system!\n  teamset:scan                 Scan all module tables for unused team sets and report the number found.\n  teamset:sql                  Print the sql query used to search for unused teamsets\n\u00c2\u00a0Additional help documentation is also available for individual commands.\u00c2\u00a0Some examples of accessing the help are shown below.\u00c2\u00a0\nPassing\u00c2\u00a0the word \"help\" before a command name:\nphp bin/sugarcrm help <command>\nPassing\u00c2\u00a0the \"-h\" option:\nphp bin/sugarcrm <command> -h\nAn example of the list help documentation is shown below.\nUsage:\n  list [options] [--] []\nArguments:\n  namespace            The namespace name\nOptions:\n      --xml            To output list as XML\n      --raw            To output raw command list", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/CLI/index.html"}
{"id": "3178a93c1057-4", "text": "--xml            To output list as XML\n      --raw            To output raw command list\n      --format=FORMAT  The output format (txt, xml, json, or md) [default: \"txt\"]\nHelp:\n The list command lists all commands:\n   php bin/sugarcrm list\n You can also display the commands for a specific namespace:\n   php bin/sugarcrm list test\n You can also output the information in other formats by using the --format option:\n   php bin/sugarcrm list --format=xml\n It's also possible to get raw list of commands (useful for embedding command runner):\n   php bin/sugarcrm list --raw\nCustom Commands\nSugar allows developers the ability to create custom commands. These commands are registered using the Extension Framework. Each custom command will extend the stock Command class and implement a\u00c2\u00a0specific mode interface. The file system location of the command code can exist anywhere in the instance's file system including a separate composer loaded repository.\u00c2\u00a0\nBest Practices\nThe following\u00c2\u00a0are some common best practices developers should keep in mind when adding new commands :\nDo not extend from existing commands\nDo not duplicate an already existing command\nPick the correct mode for the command\nLimit the logic in the command\nDo not put reusable components in the command itself\nEach command requires specific sections of code in order to properly create the command. These requirements are listed in the sections below.\nCommand Namespace\nIt is recommended to name any custom commands using a proper \"command namespace\". These namespaces are different than PHP namespaces and reduce the chances of\u00c2\u00a0collisions\u00c2\u00a0occurring between vendors. An example of this would be to prefix any commands with a namespace format of vendor:category:command\u00c2\u00a0E.g. MyDevShop:repairs:fixMyModule\nNote : The CLI framework does not allow overriding of existing commands.\nPHP Namespace", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/CLI/index.html"}
{"id": "3178a93c1057-5", "text": "Note : The CLI framework does not allow overriding of existing commands.\nPHP Namespace\nThe header of the PHP command file will need to define the following namespace:\nnamespace Sugarcrm\\Sugarcrm\\custom\\Console\\Command;\nIn addition to the namespace, the following use commands are\u00c2\u00a0required for different operations :\nName\nDescription\nExample\nCommand\nEvery command will extend the Command class\nuse Symfony\\Component\\Console\\Command\\Command;\nMode\nWhether the command is an Instance or Standalone Mode command\nuse Sugarcrm\\Sugarcrm\\Console\\CommandRegistry\\Mode\\InstanceModeInterface;\nuse Sugarcrm\\Sugarcrm\\Console\\CommandRegistry\\Mode\\StandaloneModeInterface;\nInput\nAccepts Input from the command\nuse Symfony\\Component\\Console\\Input\\InputInterface;\nOutput\nSends Output from the command\nuse Symfony\\Component\\Console\\Output\\OutputInterface;\nMode\nWhen creating\u00c2\u00a0Sugar commands,\u00c2\u00a0developers will need to specify the mode or set of modes for the command. These modes help prepare the appropriate resources for execution of the command.\u00c2\u00a0\nMode\nDescription\nInstance Mode\n\u00c2\u00a0Commands that\u00c2\u00a0require\u00c2\u00a0an installed Sugar instance.\nStandalone Mode\n\u00c2\u00a0Commands that do not require an installed Sugar instance.\nNote : Multiple modes can be selected.\nClass Definition\nThe custom command class definition should extend the stock command class as well as implement a\u00c2\u00a0mode's interface.\u00c2\u00a0\n// Instance Mode Class Definition\nclass <classname> extends Command implements InstanceModeInterface\n{\n    //protected methods\n}\n// Standalone Mode Class Definition\nclass <classname> extends Command implements StandaloneModeInterface\n{\n    //protected methods\n}\n// Implementing both Modes\nclass <classname> extends Command implements InstanceModeInterface, StandaloneModeInterface\n{\n    //protected methods\n}\nMethods\nEach command class implements\u00c2\u00a0two protected methods :\nMethod\nDescription\nconfigure()", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/CLI/index.html"}
{"id": "3178a93c1057-6", "text": "Methods\nEach command class implements\u00c2\u00a0two protected methods :\nMethod\nDescription\nconfigure()\n\u00c2\u00a0Runs on the\u00c2\u00a0creation of the command. Useful to set the name, description, and help on the command.\nexecute(InputInterface $input, OutputInterface $output)\n\u00c2\u00a0The code to run for executing the command. Accepts an input and output parameter.\u00c2\u00a0\nAn example of implementing the protected methods is shown below:\nprotected function configure()\n{\n    $this->setName('sugardev:helloworld')\n         ->setDescription('Hello World')\n         ->setHelp('This command accepts no paramters and returns \"Hello World\".')\n    ;\n}\nprotected function execute(InputInterface $input, OutputInterface $output)\n{\n    $output->writeln(\"Hello world -> \" . $this->getApplication()->getMode());\n}\nRegistering Command\nAfter creating the custom command file,\u00c2\u00a0register it with the Extension Framework.\u00c2\u00a0This file will be located in\u00c2\u00a0./custom/Extension/application/Ext/Console/. An example of registering a command is below:\n<?php\nSugarcrm\\Sugarcrm\\Console\\CommandRegistry\\CommandRegistry::getInstance()\n   ->addCommand(new Sugarcrm\\Sugarcrm\\custom\\Console\\Command\\<Command Class Name>());\nNext, navigate to Admin > Repair > Quick Repair and Rebuild.\u00c2\u00a0The custom command will now be available.\nExample\nThe following sections demonstrate how to create a \"Hello World\" example. This command does not alter the Sugar\u00c2\u00a0system and will only\u00c2\u00a0output display text. First, create the command class under the appropriate namespace.\n./custom/src/Console/Command/HelloWorldCommand.php\n<?php\nnamespace Sugarcrm\\Sugarcrm\\custom\\Console\\Command;\nuse Sugarcrm\\Sugarcrm\\Console\\CommandRegistry\\Mode\\InstanceModeInterface;\nuse Symfony\\Component\\Console\\Command\\Command;", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/CLI/index.html"}
{"id": "3178a93c1057-7", "text": "use Symfony\\Component\\Console\\Command\\Command;\nuse Symfony\\Component\\Console\\Input\\InputInterface;\nuse Symfony\\Component\\Console\\Output\\OutputInterface;\n/**\n *\n * Hello World Example\n *\n */\nclass HelloWorldCommand extends Command implements InstanceModeInterface\n{\n    protected function configure()\n    {\n        $this\n            ->setName('sugardev:helloworld')\n            ->setDescription('Hello World')\n            ->setHelp('This command accepts no paramters and returns \"Hello World\".')\n        ;\n    }\n    protected function execute(InputInterface $input, OutputInterface $output)\n    {\n        $output->writeln(\"Hello world -> \" . $this->getApplication()->getMode());\n    }\n}\nNext, register the new command:\n./custom/Extension/application/Ext/Console/RegisterHelloWorldCommand.php\n<?php\n// Register HelloWorldCommand\nSugarcrm\\Sugarcrm\\Console\\CommandRegistry\\CommandRegistry::getInstance()\n    ->addCommand(new Sugarcrm\\Sugarcrm\\custom\\Console\\Command\\HelloWorldCommand());\nNavigate to Admin > Repair > Quick Repair and Rebuild. The new command will be\u00c2\u00a0executable\u00c2\u00a0from the root of the Sugar instance. It can be executed by running the following command:\nphp bin/sugarcrm sugardev:helloworld\n\u00c2\u00a0Result:\nHello world -> InstanceMode\nHelp text can be displayed by executing\u00c2\u00a0the following command:\u00c2\u00a0\nphp bin/sugarcrm help sugardev:helloworld\n\u00c2\u00a0Result:\nUsage:\n  sugardev:helloworld\nOptions:\n  -h, --help            Display this help message\n  -q, --quiet           Do not output any message\n  -V, --version         Display this application version\n      --ansi            Force ANSI output\n      --no-ansi         Disable ANSI output\n  -n, --no-interaction  Do not ask any interactive question", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/CLI/index.html"}
{"id": "3178a93c1057-8", "text": "-n, --no-interaction  Do not ask any interactive question\n      --profile         Display timing and memory usage information\n  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug\nHelp:\n This command accepts no paramters and returns \"Hello World\".\nDownload the module loadable example package here.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/CLI/index.html"}
{"id": "928f09927ca8-0", "text": "SugarBPM\nIntroduction\nSugarBPM\u00e2\u0084\u00a2 automation suite is the next-generation workflow management tool for Sugar. Introduced in 7.6, SugarBPM is loosely based on BPMN process notation standards and provides a simple drag-and-drop user interface along with an intelligent flow designer to allow for the creation of easy yet powerful process definitions.\nNote:\u00c2\u00a0SugarBPM\u00e2\u0084\u00a2 is not available for Sugar Professional.\nSugarBPM enables administrators to streamline common business processes by managing approvals, sales processes, call triaging, and more. The easy-to-use workflow tool adds advanced BPM functionality to the core Sugar software stack.\nA business process is a set of logically related tasks that are performed in order to achieve a specific organizational goal. It presents all of the tasks that must be completed in a simplified and streamlined format. SugarBPM empowers Sugar administrators, allowing for the automation of vital business processes for their organization. The SugarBPM automation suite features an extensive toolbox of modules that provide the ability to easily create digital forms and map out fully functioning workflows.\nSugarBPM Modules\nSugarBPM is broken down into four distinct modules, each with its own area of responsibility. Three of the four SugarBPM modules have access control settings that restrict its visibility to System Administrators, Module Administrators, and Module Developers.\nProcess Definitions\nA process definition defines the steps in an overall business process. Process definitions are created by either a Sugar administrator, a module Administrator or a module Developer. The process definition consists of a collection of activities and their relationships, criteria to indicate the start and end of the process, and information about the individual activities (e.g., participants) contained within the business process.\nBusiness Rules", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarBPM/index.html"}
{"id": "928f09927ca8-1", "text": "Business Rules\nA business rule is a reusable set of conditions and outcomes that can be embedded in a process definition. The set of rules may enforce business policy, make a decision, or infer new data from existing data. For example, if Sally manages all business opportunities of $10,000 or more, and Chris manages all business opportunities under $10,000, a business rule can be created and used by all relevant process definitions based on the same target module to ensure that the assignment policy is respected. In the case of an eventual personnel change, only the business rule will need to be edited to affect all related processes.\nEmail Templates\nA process email template is required in order to include a Send Message event in a process definition. The SugarCRM core product includes several places where email templates can be created for different purposes, but SugarBPM requires all sent messages to be created via the Process Email Templates module.\nProcesses\nA process is a running instance of a process definition. A single process begins every time a process definition meeting certain criteria is executed. For example, a single process definition could be created to automate quote approvals, but because users may engage in several quote approvals per day, each approval will be represented by a separate process instance, all governed by the single process definition.\nDatabase Tables\nInformation surrounding various portions of SugarBPM can be found in the following SugarBPM database tables:\nTable name\nDescription\npmse_bpm_access_management\nThis table is not used.\npmse_bpm_activity_definition\nHolds definition data for an activity. Maps directly to the pmse_bpmn_activity table and may, in the future, be merged with the pmse_bpmn_activity table to prevent forked data backends.\npmse_bpm_activity_step\nThis table is not used.\npmse_bpm_activity_user\nThis table is not used.\npmse_bpm_config\nThis table is not used.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarBPM/index.html"}
{"id": "928f09927ca8-2", "text": "This table is not used.\npmse_bpm_config\nThis table is not used.\npmse_bpm_dynamic_forms\nHolds module specific form information - basically viewdefs for a module - for a process.\npmse_bpm_event_definition\nHolds definition data for an event. Maps directly to the pmse_bpmn_event\u00c2\u00a0table and may, in the future, be merged with the pmse_bpmn_event table to prevent forked data backends.\npmse_bpm_flow\nHolds information about triggered process flows as well as state of any process that is currently running.\npmse_bpm_form_action\nHolds information about a process that has been acted upon.\npmse_bpm_gateway_definition\nHolds definition data for a gateway. Maps directly to the pmse_bpmn_event\u00c2\u00a0table and may, in the future, be merged with the pmse_bpmn_gateway table to prevent forked data backends.\npmse_bpm_group\nThis table is not used.\npmse_bpm_group_user\nThis table is not used.\npmse_bpm_notes\nHolds notes saved for a process record.\npmse_bpm_process_definition\nHolds definition data for a process definition. Maps directly to the pmse_bpmn_process table and may, in the future, be merged with the pmse_bpmn_process table to prevent forked data backends.\npmse_bpm_related_dependency\nHolds information about dependencies related to an event\npmse_bpm_thread\nHolds information related to process threads for running processes.\npmse_bpmn_activity\nPlease see pmse_bpm_activity_definition\npmse_bpmn_artifact\nHolds BPM artifact information, like Comments on a process diagram. At present, SugarBPM only supports the text annotation artifact.\npmse_bpmn_bound", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarBPM/index.html"}
{"id": "928f09927ca8-3", "text": "pmse_bpmn_bound\nData related to element boundaries on the diagram.\u00c2\u00a0\npmse_bpmn_data\nThis table is not used.\npmse_bpmn_diagram\nData related to a process definition's diagram.\u00c2\u00a0\npmse_bpmn_documentation\nThis table is not used.\npmse_bpmn_event\nPlease see pmse_bpm_event_definition\npmse_bpmn_extension\nThis table is not used.\npmse_bpmn_flow\nHolds information about the connecting flows of a diagram.\npmse_bpmn_gateway\nPlease see pmse_bpm_gateway_definition\npmse_bpmn_lane\nThis table is not used.\npmse_bpmn_laneset\nThis table is not used.\npmse_bpmn_participant\nThis table is not used.\npmse_bpmn_process\nPlease see pmse_bpm_process_definition\npmse_business_rules\nHolds business rule record data.\npmse_emails_templates\nHolds email template record data.\npmse_inbox\nHolds information about processes that are currently running or that have completed.\npmse_project\nHolds process definition record information.\nRelationships\nThe following Entity Relationship Diagram highlights the relationships between the various SugarBPM tables.\n-Relationships\" width=\"1654\" recordid=\"e3710de4-b5b1-11e6-a3de-005056bc231a\" style=\"width: nullpx; height: NaNpx;\" />\nFlows\nWhen a process definition is created the following 5 tables get populated:\npmse_bpm_dynamic_forms contains dyn_view_defs which is the\u00c2\u00a0JSON\u00c2\u00a0encoded string of module-specific form information\npmse_bpm_process_definition contains the module associated with and the status of a\u00c2\u00a0process definition", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarBPM/index.html"}
{"id": "928f09927ca8-4", "text": "pmse_bpmn_diagram contains process definition name as well and a diagram uid\npmse_bpmn_process contains process definition name. The same Id is shared between pmse_bpm_process_definition and pmse_bpmn_process dia_id is a foreign key related to pmse_bpmn_diagram\npmse_project contains process definition name, project id, module, status. Other tables have a\u00c2\u00a0foreign key of prj_id in them.\nUpon adding a start/end/send message event:\npmse_bpmn_event contains event name\npmse_bpm_event_definition Shares id with pmse_bpmn_event\npmse_bpmn_bound\nWhen Settings is changed to \"New Records Only\"\npmse_bpm_related_dependency\nUpon adding an action or activity:\npmse_bpm_activity_definition contains the action name\nThe act_fields column contains the JSON\u00c2\u00a0encoded list of fields which will be changed\npmse_bpm_activity contains action name. Shares id with pmse_bpm_activity_definition. act_script_type\u00c2\u00a0contains the type of action e.g. CHANGE_FIELD\npmse_bpmn_bound\nUpon adding a connector between start event and action:\npmse_bpmn_flow contains origin and destination info\nUpon adding a Gateway:\npmse_bpm_gateway_definition\npmse_bpm_gateway shares id with pmse_bpm_gateway_definition\npmse_bpmn_flow flo_condition contains JSON\u00c2\u00a0encoded string of conditions required to proceed ahead with an action or activity\npmse_bpmn_bound\nWhen a process runs:\npmse_inbox cas_status indicates the\u00c2\u00a0status of a\u00c2\u00a0process\npmse_bpm_thread\npmse_bpm_flow Stores the entire flow that the process elements went through (so if 3 elements and 2 connectors are in the process definition then 5 records will exist)\nAfter Process has run and appears in Process Management:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarBPM/index.html"}
{"id": "928f09927ca8-5", "text": "After Process has run and appears in Process Management:\npmse_bpm_case_data\npmse_bpm_form_action contains frm_action,\u00c2\u00a0\u00c2\u00a0cas_pre_data\u00c2\u00a0, and cas_data\nAdd a comment:\npmse_bpmn_artifact contains the comment\npmse_bpm_bound\nAdd a business rule to a process definition:\npmse_business_rules rst_source_definition contains the conditions of the business rule\npmse_bpm_activity_definition act_fields contains the business rule id\nAdd an email template to a process definition:\npmse_email_templates\npmse_bpm_event_definition evn_criteria contains the email template id\nExtension and Customization\nIn Sugar 7.8, Sugar introduced the Process Manager library to support extending SugarBPM in an upgrade-safe way. For more information on extending SugarBPM, or on using the Process Manager library, please read the Process Manager documentation.\nCaveats\nIn Sugar 7.8, the Process Manager library brought Registry Object to maintain the state of SugarBPM processes during a PHP Process. This change introduced a limitation in SugarBPM that prevents the same process definition from running on multiple records inside the same PHP process. For certain customizations in Sugar, if you are updating multiple records in a module using SugarBean, you may want them to trigger the defined process definitions for each record.\nThe following code can be added to your customization to allow for that functionality:\nuse Sugarcrm\\Sugarcrm\\ProcessManager\\Registry;\n//custom code\nRegistry\\Registry::getInstance()->drop('triggered_starts');\n$bean->save();\nThe 'triggered_starts' registry contains the Start Event IDs that have been triggered previously in the PHP process, thus allowing the SugarBean::save() method to trigger SugarBPM and go through the same Start Event again.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarBPM/index.html"}
{"id": "928f09927ca8-6", "text": "TopicsExtending SugarBPM (Process Manager)From its earliest version, Sugar has been a tool that allows for customizing and extending in a way that allows developers to shape and mold it to a specific business need. Most components of Sugar are customizable or extensible through the use of custom classes (for custom functionality) or extensions (for custom metadata). However, a recent addition to the product, the SugarBPM\u00e2\u0084\u00a2 automation suite, did not fit this paradigm. In response, the Process Manager Library was introduced to give developers the ability to customize any portion of SugarBPM where object instantiation was previously handled using the 'new' operator.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarBPM/index.html"}
{"id": "cc8f8fa74e39-0", "text": "Extending SugarBPM (Process Manager)\nIntroduction\nFrom its earliest version, Sugar has been a tool that allows for customizing and extending in a way that allows developers to shape and mold it to a specific business need. Most components of Sugar are customizable or extensible through the use of custom classes (for custom functionality) or extensions (for custom metadata). However, a recent addition to the product, the SugarBPM\u00e2\u0084\u00a2 automation suite, did not fit this paradigm. In response, the Process Manager Library was introduced to give developers the ability to customize any portion of SugarBPM where object instantiation was previously handled using the 'new' operator.\u00c2\u00a0\nNote:\u00c2\u00a0SugarBPM\u00e2\u0084\u00a2 is not available in Sugar Professional. For an introduction to the SugarBPM modules and architecture, please refer to the SugarBPM documentation in this guide.\nProcess Manager\nBy way of ProcessManager\\Factory we can now develop custom versions of most any PMSE* class and have that class used in place of the core PMSE* class.\nLimitations\nThe current implementation of the Process Manager Library only handles server-side customizations by way of the Factory class. These customizations can be applied to any instantiable pmse_* object, however, static classes and singleton classes, such as the following, are not affected by the library:\nPMSE\nPMSEEngineUtils\nPMSELogger\nWhile some effort has been made to allow for the creation of custom actions in the Process Definition designer, as of Sugar 7.8, that is the only client customization allowance that will be implemented.\nLibrary Structure\nThe Process Manager Library is placed under the Sugarcrm\\Sugarcrm\\ProcessManager namespace and contains the following directories and classes:\nFactory\nException/\nBaseException\nDateTimeException\nExceptionInterface\nExecutionException\nInvalidDataException\nNotAuthorizedException\nRuntimeException\nField/\nEvaluator/\nAbstractEvaluator\nBase\nCurrency", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarBPM/Extending_SugarBPM/index.html"}
{"id": "cc8f8fa74e39-1", "text": "NotAuthorizedException\nRuntimeException\nField/\nEvaluator/\nAbstractEvaluator\nBase\nCurrency\nDatetime\nDecimal\nEvaluatorInterface\nInt\nMultienum\nRelate\nRegistry/\nRegistry\nRegistryInterface\nExamples\nGetting a SugarBPM object\nAlmost all objects in SugarBPM can be instantiated through the Process Manager Factory. When loading a class, the Factory getPMSEObject method will look in the following directories as well as the custom versions of these directories for files that match the object name being loaded:\nmodules/pmse_Business_Rules/\nmodules/pmse_Business_Rules/clients/base/api/\nmodules/pmse_Emails_Templates/\nmodules/pmse_Emails_Templates/clients/base/api/\nmodules/pmse_Inbox/clients/base/api/\nmodules/pmse_Inbox/engine/\nmodules/pmse_Inbox/engine/parser/\nmodules/pmse_Inbox/engine/PMSEElements/\nmodules/pmse_Inbox/engine/PMSEHandlers/\nmodules/pmse_Inbox/engine/PMSEPreProcessor/\nmodules/pmse_Inbox/engine/wrappers/\nmodules/pmse_Project/clients/base/api/\nmodules/pmse_Project/clients/base/api/wrappers/\nmodules/pmse_Project/clients/base/api/wrappers/PMSEObservers/\nWhat this means is that virtually any class that is found by name in these directories can be instantiated and returned via the getPMSEObject() method. This also means that customizations to any of these classes can be easily implemented by creating a Custom version of the class under the appropriate ./custom directory path.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarBPM/Extending_SugarBPM/index.html"}
{"id": "cc8f8fa74e39-2", "text": "For example, to create a custom version of PMSEProjectWrapper, you would create a CustomPMSEProjectWrapper class at \u00c2\u00a0./custom/modules/pmse_Project/clients/base/api/wrappers/CustomPMSEProjectWrapper.php. This allows you to have full control of your instance of SugarBPM while giving you the flexibility to add any classes you want and consuming them through the factory.\n./custom/modules/pmse_Project/clients/base/api/wrappers/CustomPMSEProjectWrapper.php\n<?php\nrequire_once 'modules/pmse_Project/clients/base/api/wrappers/PMSEProjectWrapper.php';\nclass CustomPMSEProjectWrapper extends PMSEProjectWrapper\n{\n}\nThis can now be consumed by simply calling the getPMSEObject() method:\n<?php\n// Set the process manager library namespace\nuse \\Sugarcrm\\Sugarcrm\\ProcessManager\\Factory;\n// Get our wrapper\n$wrapper = ProcessManager\\Factory::getPMSEObject('PMSEProjectWrapper');\nGetting a SugarBPM Element Object\nElement objects in SugarBPM generally represent some part of the Process engine, and often time map to design elements. All Element objects can be found in the modules/pmse_Inbox/engine/PMSEElements/ directory.\nGetting a SugarBPM Element object can be done easily by calling the getElement() method of the Process Manager Factory:\n<?php\nuse \\Sugarcrm\\Sugarcrm\\ProcessManager\\Factory;\n// Get a default PMSEElement object\n$element = ProcessManager\\Factory::getElement();\nTo get a specific object, you can pass the object name to the getElement() method:\n$activity = ProcessManager\\Factory::getElement('PMSEActivity');\nAlternatively, you can remove the PMSE prefix and call the method with just the element name:\n$gateway = ProcessManager\\Factory::getElement('Gateway');", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarBPM/Extending_SugarBPM/index.html"}
{"id": "cc8f8fa74e39-3", "text": "$gateway = ProcessManager\\Factory::getElement('Gateway');\nTo create a custom SugarBPM Element, you can simply create a new file at ./custom/modules/pmse_Inbox/engine/PMSEElements/ where the file name is prefixed with Custom.\n./custom/modules/pmse_Inbox/engine/PMSEElements/CustomPMSEScriptTask.php\n<?php\nrequire_once 'modules/pmse_Inbox/engine/PMSEElements/PMSEScriptTask.php';\nuse Sugarcrm\\Sugarcrm\\ProcessManager;\nclass CustomPMSEScriptTask extends PMSEScriptTask\n{\n}\nNote: All SugarBPM Element classes\u00c2\u00a0must implement the PMSERunnable interface. Failure to implement this interface will result in an exception when using the Factory to get an Element object.\nTo get a\u00c2\u00a0custom ScriptTask\u00c2\u00a0object via the Factory, just call getElement():\n$obj = ProcessManager\\Factory::getElement('ScriptTask');\nTo make your own custom widget element, you can implement the PMSERunnable interface:\n./custom/modules/pmse_Inbox/engine/PMSEElements/CustomPMSEWidget.php\n<?php\nrequire_once 'modules/pmse_Inbox/engine/PMSEElements/PMSERunnable.php';\nuse Sugarcrm\\Sugarcrm\\ProcessManager;\nclass CustomPMSEWidget implements PMSERunnable\n{\n}\nTo get a Widget object via the Factory, just call getElement():\n$obj = ProcessManager\\Factory::getElement('Widget');\nGetting and Using a Process Manager Field Evaluator Object\nProcess Manager Field Evaluator objects determine if a field on a record has changed and if a field on a record is empty according to the field type. The purpose of these classes\u00c2\u00a0can grow to include more functionality in the future.\nGetting a field evaluator object is also done\u00c2\u00a0through the Factory:\n<?php\nuse \\Sugarcrm\\Sugarcrm\\ProcessManager\\Factory;", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarBPM/Extending_SugarBPM/index.html"}
{"id": "cc8f8fa74e39-4", "text": "<?php\nuse \\Sugarcrm\\Sugarcrm\\ProcessManager\\Factory;\n// Get a Datetime Evaluator. Type can be date, time, datetime or datetimecombo\n$eval = ProcessManager\\Factory::getFieldEvaluator(['type'  => 'date']);\nA more common way of getting a field evaluator object is to pass the field definitions for a field on a SugarBean\u00c2\u00a0into the Factory:\n$eval = ProcessManager\\Factory::getFieldEvaluator($bean ->field_defs[$field]);\n$eval = ProcessManager\\Factory::getFieldEvaluator($bean ->field_defs[$field]);\nOnce the evaluator object is fetched, you may\u00c2\u00a0initialize it with properties:\n/*\n This is commonly used for field change evaluations\n */\n// $bean is a SugarBean object\n// $field is the name of the field being evaluated\n// $data is an array of data that is used in the evaluation\n$eval ->init($bean, $field, $data);\n// Has the field changed?\n$changed  = $eval->hasChanged();\n\u00c2\u00a0\nOr you can set properties onto the evaluator:\n/*\n This is commonly used for empty evaluations\n */\n// Set the bean onto the evaluator\n$eval->setBean($bean);\n// And set the name onto the evaluator\n$eval->setName($field);\n// Are we empty?\n$isEmpty  = $eval->isEmpty();\nCreating and consuming a custom field evaluator is as easy as creating a custom class and extending the Base\u00c2\u00a0class:\n./custom/src/ProcessManager/Field/Evaluator/CustomWidget.php\n<?php\nnamespace Sugarcrm\\Sugarcrm\\ProcessManager\\Field\\Evaluator;\n/**\n * Custom widget field evaluator\n *  @package ProcessManager\n */\nclass CustomWidget extends Base\n{\n}\n\u00c2", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarBPM/Extending_SugarBPM/index.html"}
{"id": "cc8f8fa74e39-5", "text": "*/\nclass CustomWidget extends Base\n{\n}\n\u00c2\u00a0\nAlternatively, you can create a custom evaluator that extends the AbstractEvaluator parent class if you implement the EvaluatorInterface interface.\n./custom/src/ProcessManager/Field/Evaluator/CustomWidget.php\n<?php\nnamespace Sugarcrm\\Sugarcrm\\ProcessManager\\Field\\Evaluator;\n/**\n * Custom widget field evaluator\n *  @package ProcessManager\n */\nclass CustomWidget extends AbstractEvaluator  implements EvaluatorInterface\n{\n}\nAnd at this point, you can use the Factory to get your widget object:\n// Get a custom widget evaluator object\n$eval  = ProcessManager\\Factory::getFieldEvaluator(['type'  => 'widget']);\nGetting an Exception Object with Logging\nGetting a SugarBPM exception with logging is as easy as calling a single Factory method. Currently, the Process Manager library supports the following exception types:\nDateTime\nExecution\nInvalidData\nNotAuthorized\nRuntime\nAs a fallback, the Base exception can be used. All exceptions log their message to the PMSE log when created, and all exceptions implement ExceptionInterface.\nThe most basic way to get a ProcessManager exception is to call the getException() method on the Factory with no arguments:\n<?php\nuse \\Sugarcrm\\Sugarcrm\\ProcessManager\\Factory;\n// Get a BaseException object, with a default message\n// of 'An unknown Process Manager exception had occurred'\n$exception = ProcessManager\\Factory::getException();\n\u00c2\u00a0\nTo get a particular type of exception, or to set your message, you can add the first two arguments:\nif ($error) {\n     throw ProcessManager\\Factory::getException('InvalidData', $error);\n}\nIt is possible to set an exception code, as well as a previous exception, when creating an Exception object:\n// Assume $previous is an ExecutionException", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarBPM/Extending_SugarBPM/index.html"}
{"id": "cc8f8fa74e39-6", "text": "// Assume $previous is an ExecutionException\nthrow ProcessManager\\Factory ::getException('Runtime', 'Cannot carry out the action', 255, $previous);\nFinally, to create your own custom exception classes, you must add a new custom file in the following path with the file named appropriately:\n./custom/src/ProcessManager/Exception/CustomEvaluatorException.php\n<?php\nnamespace Sugarcrm\\Sugarcrm\\ProcessManager\\Exception;\n/**\n * Custom Evaluator exception\n *  @package ProcessManager\n */\nclass CustomEvaluatorException  extends BaseException  implements ExceptionInterface\n{\n}\nAnd to consume this custom exception, call the Factory:\n$exception = ProcessManager\\Factory::getException('Evaluator', 'Could not evaluate the expression');\nMaintaining State Throughout a Process\nThe Registry\u00c2\u00a0class\u00c2\u00a0implements the RegistryInterface which exposes the following public methods:\nset($key, $value, $override = false)\nget($key, $default = null)\nhas($key)\ndrop($key)\ngetChanges($key)\nreset()\nTo use the Registry class, simply use the namespace to get the singleton:\n<?php\nuse \\Sugarcrm\\Sugarcrm\\ProcessManager\\Registry;\n$registry = Registry\\Registry::getInstance();\nTo set a value into the registry, simply add it along with a key:\n$registry->set('reg_key', 'Hold on to this');\nNOTE: To prevent named index collision, it is advisable to write indexes to contain a namespace indicator, such as a prefix.\n$registry->set('mykeyindex:reg_key', 'Hold on to this');\nOnce a value is set in the registry, it is immutable unless the\u00c2\u00a0set($key, $value, $override = false)\u00c2\u00a0method is called with\u00c2\u00a0the override argument set to true:\n// Sets the reg_key value", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarBPM/Extending_SugarBPM/index.html"}
{"id": "cc8f8fa74e39-7", "text": "// Sets the reg_key value\n$registry->set('reg_key', 'Hold on to this');\n// Since the registry key reg_key is already set, this will do nothing\n$registry->set('reg_key', 'No wait!');\n// To forcefully set it, add a true for the third argument\n$registry->set('reg_key', 'No wait!', true);\nWhen a key is changed on the registry, these changes are logged and can be\u00c2\u00a0inspected using getChanges():\n// Set and reset a value on the registry\n$registry->set('key', 'Foo');\n$registry->set('key', 'Bar', true);\n$registry->set('key', 'Baz', true);\n// Get the changes for this key\n$changes  = $registry ->getChanges('key');\n/*\n$changes will be:\n array(\n     0 => array(\n         'from' => 'Foo',\n         'to' => 'Bar',\n     ),\n     1 => array(\n         'from' => 'Bar',\n         'to' => 'Baz',\n     ),\n */\nTo get the value of the key you just set, call the get() method:\n$value = $registry->get('reg_key');\nTo get a value of a key with a default, you can pass the default value as the second argument to get():\n// Will return either the value for attendee_count or 0\n$count  = $registry->get('attendee_count', 0);\nTo see if the registry currently holds a value, call the has() method:\nif ($registry->has('field_list')) {\n    // Do something here\n}\nTo remove a value from the registry, use the drop() method. This will add an entry to\u00c2\u00a0the changelog, provided the key was\u00c2\u00a0already set.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarBPM/Extending_SugarBPM/index.html"}
{"id": "cc8f8fa74e39-8", "text": "$registry->drop('key');\nFinally, to clear the entire registry of all values and changelog entries, use the reset() method.\n$registry->reset();\nNote: This is very destructive. Please use with caution because you can purge settings that you didn't own.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/SugarBPM/Extending_SugarBPM/index.html"}
{"id": "8c062500c5cb-0", "text": "Global Search\nOverview\nHow to customize the global search results.\nConfiguring Search Results\nThe Search-List view, located in ./clients/base/views/search-list/,\u00c2\u00a0is responsible for the\u00c2\u00a0global search results page. By default, it contains the rowactions\u00c2\u00a0that are available for each result.\u00c2\u00a0The following sections will outline how to configure the primary and secondary fields.\nPrimary and Secondary Fields\nEach row returned from the global search\u00c2\u00a0is\u00c2\u00a0split into two lines. The first line contains the primary fields and avatar. A primary field is a field considered to be important to the identification of a record and is usually composed of the records name value and a link to the record.\u00c2\u00a0The avatar is an icon specific to the module the results are coming from.\nThe second line\u00c2\u00a0contains\u00c2\u00a0the highlighted matches and any\u00c2\u00a0secondary fields specified. A highlight is a hit returned by elastic search. Highlights are driven from elastic and no definition is needed in the metadata to define them. Both primary and secondary fields can be highlighted. A secondary field is a field that has regularly accessed data. It is important to note\u00c2\u00a0that the initial type-ahead drop-down will not show specified secondary fields unless the user hits enter and is taken to the search results page. Different modules have different secondary fields. For example, an account's secondary fields are email and phone number, while cases' secondary fields are case ID number and related account.\nTo leverage the metadata manager, the global search view reuses the same metadata format as other views.\u00c2\u00a0You can add any indexed field in elastic search\u00c2\u00a0to the search list view. An example of the stock metadata is shown below.\n./modules/{module}/clients/base/views/search-list/search-list.php\n<?php\n$viewdefs[$moduleName]['base']['view']['search-list'] = array(\n    'panels' => array(\n        array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Global_Search/index.html"}
{"id": "8c062500c5cb-1", "text": "'panels' => array(\n        array(\n            'name' => 'primary', // This is mandatory and the word `primary` can not be changed.\n            'fields' => array(\n                /*\n                 * Put here the list of primary fields.\n                 * You can either define a field as a string and the metadata\n                 * manager will load the field vardefs, or you can define as an\n                 * array if you want to add properties or override vardefs\n                 * properties just for the search results view.\n                 *\n                 * You most likely want to show the module icon on the left of the\n                 * view. For this, you need to add the following picture field as\n                 * a primary field.\n                 */\n                array(\n                    'name' => 'picture',\n                    'type' => 'avatar',\n                    'size' => 'medium',\n                    'css_class' => 'pull-left',\n                ),\n                array(\n                    'name' => 'name',\n                    'type' => 'name',\n                    'link' => true,\n                    'label' => 'LBL_SUBJECT',\n                ),\n            ),\n        ),\n        /*\n         * If you don't want secondary fields, you can remove the following array.\n         */\n        array(\n            'name' => 'secondary', // This is mandatory and the word `secondary` can not be changed.\n            'fields' => array(\n                /*\n                 * Put here the list of secondary fields\n                 */\n                'status', // This field is defined as a string for example.\n                array(\n                    'name' => 'description',\n                    'label' => 'LBL_SEARCH_DESCRIPTION',\n                ),\n            ),\n        ),\n    ),\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Global_Search/index.html"}
{"id": "8c062500c5cb-2", "text": "),\n            ),\n        ),\n    ),\n);\nNote: You can technically override the row actions for the results of a module, however,\u00c2\u00a0the view currently only supports the preview action so it\u00c2\u00a0is not recommended to customizes these actions.\nExamples\nThe following examples\u00c2\u00a0demonstrate how to modify the primary and secondary rows of the global search.\nAdding Fields to the Primary Row\nThis example will demonstrate how to add \"Mobile\" into the search-list view's primary\u00c2\u00a0row for Contact module results.\nTo accomplish this, you can duplicate ./modules/Contacts/clients/base/views/search-list/search-list.php to \u00c2\u00a0\u00c2\u00a0./custom/modules/Contacts/clients/base/views/search-list/search-list.php\u00c2\u00a0if it doesn't exist. Once in place, add your phone_mobile\u00c2\u00a0definition to the\u00c2\u00a0$viewdefs['Contacts']['base']['view']['search-list']['panels'] array definition with the name attribute equal to \"primary'. An example is shown below:\n./custom/modules/Contacts/clients/base/views/search-list/search-list.php\n<?php\n$viewdefs['Contacts']['base']['view']['search-list'] = array(\n    'panels' => array(\n        array(\n            'name' => 'primary',\n            'fields' => array(\n                array(\n                    'name' => 'picture',\n                    'type' => 'avatar',\n                    'size' => 'medium',\n                    'readonly' => true,\n                    'css_class' => 'pull-left',\n                ),\n                array(\n                    'name' => 'name',\n                    'type' => 'name',\n                    'link' => true,\n                    'label' => 'LBL_SUBJECT',\n                ),\n                // Adding the mobile into first row of the results\n                'phone_mobile',\n            ),\n        ),\n        array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Global_Search/index.html"}
{"id": "8c062500c5cb-3", "text": "'phone_mobile',\n            ),\n        ),\n        array(\n            'name' => 'secondary',\n            'fields' => array(\n                array(\n                    'name' => 'email',\n                    'label' => 'LBL_PRIMARY_EMAIL',\n                ),\n            ),\n        ),\n    ),\n);\nOnce in place, navigate to Admin > Repair > Quick Repair and Rebuild. Your changes will then be reflected in the system.\nAdding Fields to the Secondary Row\nThis example will demonstrate how to add \"Mobile\" into the search-list view's secondary row for Contact module results.\u00c2\u00a0It is important to note\u00c2\u00a0that the initial type-ahead drop-down will not show specified secondary fields unless the user hits enter and is taken to the search results page.\nIn this example, we are going to add Portal Name into search-list for Contact module results.\nTo accomplish this, you can duplicate ./modules/Contacts/clients/base/views/search-list/search-list.php to \u00c2\u00a0\u00c2\u00a0./custom/modules/Contacts/clients/base/views/search-list/search-list.php\u00c2\u00a0if it doesn't exist. Once in place, add your phone_mobile definition to the\u00c2\u00a0$viewdefs['Contacts']['base']['view']['search-list']['panels'] array definition with the name attribute equal to \"secondary'. An example is shown below:\n<?php\n$viewdefs['Contacts']['base']['view']['search-list'] = array(\n    'panels' => array(\n        array(\n            'name' => 'primary',\n            'fields' => array(\n                array(\n                    'name' => 'picture',\n                    'type' => 'avatar',\n                    'size' => 'medium',\n                    'readonly' => true,\n                    'css_class' => 'pull-left',\n                ),\n                array(\n                    'name' => 'name',\n                    'type' => 'name',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Global_Search/index.html"}
{"id": "8c062500c5cb-4", "text": "'name' => 'name',\n                    'type' => 'name',\n                    'link' => true,\n                    'label' => 'LBL_SUBJECT',\n                ),\n            ),\n        ),\n        array(\n            'name' => 'secondary',\n            'fields' => array(\n                array(\n                    'name' => 'email',\n                    'label' => 'LBL_PRIMARY_EMAIL',\n                ),\n                // Adding mobile to second row for search results in globalsearch\n                'phone_mobile' \n            ),\n        ),\n    ),\n);\nOnce in place, navigate to Admin > Repair > Quick Repair and Rebuild. Your changes will then be reflected in the system.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Global_Search/index.html"}
{"id": "c8955d1c10ee-0", "text": "Job Queue\nOverview\nThe Job Queue executes automated tasks in Sugar through a\u00c2\u00a0scheduler, which integrates with external UNIX systems and Windows systems to run jobs that are scheduled through those systems.\u00c2\u00a0Jobs are the individual runs of the specified function from a scheduler.\u00c2\u00a0\nThe Job Queue is composed\u00c2\u00a0of the following parts:\nSugarJobQueue\u00c2\u00a0: Implements the queue functionality. The queue contains the various jobs.\nSchedulersJob\u00c2\u00a0: A single instance of a job. This represents a single executable task and is held in the SugarJobQueue.\nScheduler\u00c2\u00a0: This is a periodically occurring job.\nSugarCronJobs :\u00c2\u00a0The cron process that uses SugarJobQueue to run jobs. It runs periodically and does not support parallel execution.\nStages\nSchedule Stage\nOn the scheduling stage (checkPendingJobs in Scheduler class), the queue checks if any schedules are qualified to run at this time and do not have job instance already in the queue. If such schedules exist, a job instance will immediately be created for each.\nExecution Stage\nThe SQL queue table is checked for any jobs in the \"Pending\" status. These\u00c2\u00a0will be set to \"Running\"' and then executed in accordance to its target and settings.\nCleanup Stage\nThe queue is checked for jobs that are in the \"Running\" state longer than the defined timeout. Such jobs are considered \"Failed\" jobs (they may be re-queued if their definition includes re-queuing on failure).", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Job_Queue/index.html"}
{"id": "c8955d1c10ee-1", "text": "TopicsSchedulersSugar provides a Scheduler service that can execute predefined functions asynchronously on a periodic basis. The Scheduler integrates with external UNIX systems and Windows systems to run jobs that are scheduled through those systems. The typical configuration is to have a UNIX cron job or a Windows scheduled job execute the Sugar Scheduler service every couple of minutes. The Scheduler service checks the list of Schedulers defined in the Scheduler Admin screen and executes any that are currently due.Scheduler JobsJobs are the individual runs of the specified function from a scheduler. This article will outline the various parts of a Scheduler Job.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Job_Queue/index.html"}
{"id": "ddd23ca7d2cd-0", "text": "Scheduler Jobs\nOverview\nJobs are the individual runs of the specified function from a scheduler. This article will outline the various parts of a Scheduler Job.\nProperties\nname : Name of the job\nscheduler_id : ID of the scheduler that created the job. This may be empty as schedulers are not required to create jobs\nexecute_time : Time when job is ready to be executed\nstatus : Status of the job\nresolution : Notes whether or not the job was successful\nmessage : Contains messages produced by the job, including errors\ntarget : Function or URL called by the job\ndata : Data attached to the job\nrequeue : Boolean to determine whether the job will be replaced in the queue upon failure\nretry_count : Determines how many times the system will retry the job before failure\nfailure_count : The number f times the job has failed\njob_delay : The delay (in seconds) between each job run\nassigned_user_id : User ID of which the job will be executed as\nclient : The name of the client owning the job\npercent_complete : For postponed jobs, this can be used to determine how much of the job has been completed\nCreating a Job\nTo create job, you must first create an instance of SchedulesJobs class and use submitJob in SugarJobQueue. An example is shown below:\n<?php\n$jq = new SugarJobQueue();\n$job = new SchedulersJob();\n$job->name = \"My Job\";\n$job->target = \"function::myjob\";\n$jobid = $jq->submitJob($job);\necho \"Created job $jobid!\";\nJob Targets\nJob target contains two components, type and name, separated by \"::\". Type can be:\nfunction : Name or static method name (using :: syntax). This function will be passed the job object as the first parameter and if data is not empty, it will be passed as the second parameter.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Job_Queue/Jobs/index.html"}
{"id": "ddd23ca7d2cd-1", "text": "url : External URL to call when running the job\nRunning the Job\nThe job is run via the runJob() function in SchedulersJob. This function will return a boolean success value according to the value returned by the target function. For URL targets, the HTTP error code being less than 400 will return success.\nIf the function updated the job status from 'running', the return value of a function is ignored. Currently, the postponing of a URL job is not supported.\nJob status\nJobs can be in following statuses:\nqueued : The job is waiting in the queue to be executed\nrunning : The job is currently being executed\ndone : The job has executed and completed\nJob Resolution\nJob resolution is set when the job is finished and can be:\nqueued : The job is still not finished\nsuccess : The job has completed successfully\nfailure : The job has failed\npartial : The job is partially done but needs to be completed\nJob Logic Hooks\nThe scheduler jobs module has two additional logic hooks that can be used to monitor jobs. The additional hooks that can be used are shown below:\njob_failure_retry : Executed when a job fails but will be retried\njob_failure : Executed when the job fails for the final time\nYou can find more information on these hooks in the Job Queue Hooks section.\nTopicsCreating Custom JobsHow to create and execute your own custom jobs.Queuing Logic Hook ActionsThis example will demonstrate how to pass tasks to the job queue. This enables you to send longer running jobs such as sending emails, calling web services, or doing other resource intensive jobs to be handled asynchronously by the cron in the background.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Job_Queue/Jobs/index.html"}
{"id": "8cca2fd47493-0", "text": "Creating Custom Jobs\nOverview\nHow to create and execute your own custom jobs.\nHow it Works\nAs of 6.3.0, custom job functions can be created using the extension framework. The function for the job will be defined in ./custom/Extension/modules/Schedulers/Ext/ScheduledTasks/. Files in this directory are compiled into ./custom/modules/Schedulers/Ext/ScheduledTasks/scheduledtasks.ext.php and then included for use in ./modules/Schedulers/_AddJobsHere.php.\nCreating the Job\nUse the section below to introduce the technology in relation to the product and describe its benefits.\nThis first step is to create your jobs custom key. For this example we will be using 'custom_job' as our job key.\n./custom/Extension/modules/Schedulers/Ext/ScheduledTasks/custom_job.php\n<?php\n//add the job key to the list of job strings\narray_push($job_strings, 'custom_job');\nfunction custom_job()\n{\n    //custom job code\n    //return true for completed\n    return true;\n}\nNext, we will need to define our jobs label string:\n./custom/Extension/modules/Schedulers/Ext/Language/en_us.custom_job.php\n<?php\n$mod_strings['LBL_CUSTOM_JOB'] = 'Custom Job';\nFinally, We will need to navigate to:\nAdmin / Repair / Quick Repair and Rebuild\nOnce a Quick Repair and Rebuild has been run, the new job will be available for use when creating new schedulers in:\nAdmin / Scheduler\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Job_Queue/Jobs/Creating_Custom_Jobs/index.html"}
{"id": "badaecf39b0d-0", "text": "Queuing Logic Hook Actions\nOverview\nThis example will demonstrate how to pass tasks to the job queue. This enables you to send longer running jobs such as sending emails, calling web services, or doing other resource intensive jobs to be handled asynchronously by the cron in the background.\nExample\nThis example will queue an email to be sent out by the cron when an account record is saved. First, we will create a before_save logic hook on accounts.\n./custom/modules/Accounts/logic_hooks.php\n<?php\n    $hook_version = 1; \n    $hook_array = Array(); \n    $hook_array['before_save'][] = Array();\n    $hook_array['before_save'][] = Array(\n        1, \n        'Queue Job Example', \n        'custom/modules/Accounts/Accounts_Save.php', \n        'Accounts_Save', \n        'QueueJob'\n    );\n?>\nIn our logic hook, we will create a new SchedulersJob and submit it to the SugarJobQueue targeting our custom AccountAlertJob that we will create next.\n./custom/modules/Accounts/Accounts_Save.php\n<?php\n    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\n        require_once 'include/SugarQueue/SugarJobQueue.php';\n    class Accounts_Save\n    {\n        function QueueJob(&$bean, $event, $arguments)\n        {\n            //create the new job\n            $job = new SchedulersJob();\n            //job name\n            $job->name = \"Account Alert Job - {$bean->name}\";\n            //data we are passing to the job\n            $job->data = $bean->id;\n            //function to call\n            $job->target = \"function::AccountAlertJob\"; \n            global $current_user;", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Job_Queue/Jobs/Queuing_Logic_Hook_Actions/index.html"}
{"id": "badaecf39b0d-1", "text": "global $current_user;\n            //set the user the job runs as\n            $job->assigned_user_id = $current_user->id;\n            //push into the queue to run\n            $jq = new SugarJobQueue();\n            $jobid = $jq->submitJob($job);\n        }\n    }\n?>\nNext, we will need to define the Job. This will be done by creating a new function to execute our code. We will put this file in the ./custom/Extension/modules/Schedulers/Ext/ScheduledTasks/ directory with the name AccountAlertJob.php.\n./custom/Extension/modules/Schedulers/Ext/ScheduledTasks/AccountAlertJob.php\n<?php\nfunction AccountAlertJob($job)\n{\n    if (!empty($job->data))\n    {\n        $bean = BeanFactory::getBean('Accounts', $job->data);\n        $emailObj = new Email();\n        $defaults = $emailObj->getSystemDefaultEmail();\n        $mail = new SugarPHPMailer();\n        $mail->setMailerForSystem();\n        $mail->From = $defaults['email'];\n        $mail->FromName = $defaults['name'];\n        $mail->Subject = from_html($bean->name);\n        $mail->Body = from_html(\"Email alert that '{$bean->name}' was saved\");\n        $mail->prepForOutbound();\n        $mail->AddAddress('example@sugar.crm');\n        if($mail->Send())\n        {\n            //return true for completed\n            return true;\n        }\n    }\n    return false;\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Job_Queue/Jobs/Queuing_Logic_Hook_Actions/index.html"}
{"id": "badaecf39b0d-2", "text": "return true;\n        }\n    }\n    return false;\n}\nFinally, navigate to Admin / Repair / Quick Repair and Rebuild. The system will then generate the file ./custom/modules/Schedulers/Ext/ScheduledTasks/scheduledtasks.ext.php containing our new function. We are now able to queue and run the scheduler job from a logic hook.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Job_Queue/Jobs/Queuing_Logic_Hook_Actions/index.html"}
{"id": "50bbabd145a1-0", "text": "Schedulers\nOverview\nSugar provides a Scheduler service that can execute predefined functions asynchronously on a periodic basis. The Scheduler integrates with external UNIX systems and Windows systems to run jobs that are scheduled through those systems. The typical configuration is to have a UNIX cron job or a Windows scheduled job execute the Sugar Scheduler service every couple of minutes. The Scheduler service checks the list of Schedulers defined in the Scheduler Admin screen and executes any that are currently due.\nA series of schedulers are defined by default with every Sugar installation. For detailed information on these stock schedulers, please refer to the Schedulers documentation.\nConfig Settings\ncron.max_cron_jobs - Determines the maximum number of jobs executed per cron run\n cron.max_cron_runtime - Determines the maximum amount of time a job can run before forcing a failure\n cron.min_cron_interval - Specified the minimum amount of time between cron runs\nConsiderations\nSchedulers execute\u00c2\u00a0the next time the cron runs after the interval of time has passed, which\u00c2\u00a0may not be at the exact time specified on the scheduler.\nIf you see\u00c2\u00a0the message \"Job runs too frequently, throttled to protect the system\" in the\u00c2\u00a0Sugar log, the cron is running too frequently.\nIf you would prefer the cron to run more frequently, set the cron.min_cron_interval setting to 0 and disable throttling completely.\nTopicsCreating Custom SchedulersIn addition to the default schedulers that are packaged with Sugar, developers can create custom scheduler jobs.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Job_Queue/Schedulers/index.html"}
{"id": "99b7928bbdc8-0", "text": "Creating Custom Schedulers\nOverview\nIn addition to the default schedulers that are packaged\u00c2\u00a0with Sugar,\u00c2\u00a0developers can create\u00c2\u00a0custom scheduler jobs.\nDefining the Job Label\nThe first step to create a custom scheduler is creating a\u00c2\u00a0label extension file. This will add the display text for the\u00c2\u00a0scheduler job when creating a new scheduler in Admin > Scheduler. The file path of our file will be in the format of\u00c2\u00a0./custom/Extension/modules/Schedulers/Ext/Language/<language key>.<name>.php. For our example, name the file en_us.custom_job.php.\n./custom/Extension/modules/Schedulers/Ext/Language/en_us.custom_job.php\n<?php\n$mod_strings['LBL_CUSTOM_JOB'] = 'Custom Job';\nDefining the Job Function\nNext, define the\u00c2\u00a0custom job's function using the extension framework. The file path of the\u00c2\u00a0file will be in the format of ./custom/Extension/modules/Schedulers/Ext/ScheduledTasks/<function_name>.php. For this\u00c2\u00a0example, name the file custom_job.php.\u00c2\u00a0Prior to 6.3.x, job functions were added by creating the file ./custom/modules/Schedulers/_AddJobsHere.php. This method of creating functions is still compatible but is not recommended from a best practices standpoint.\n./custom/Extension/modules/Schedulers/Ext/ScheduledTasks/custom_job.php\n<?php\narray_push($job_strings, 'custom_job');\nfunction custom_job()\n{\n    //logic here\n    //return true for completed\n    return true;\n}\nUsing the New Job\nOnce the files are in place, navigate to Admin > Repair > Quick Repair and Rebuild. This will rebuild the extension directories with our additions. Next, navigate to Admin > Scheduler > Create Scheduler. In the Jobs dropdown, there will be a new custom job in the list.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Job_Queue/Schedulers/Creating_Custom_Schedulers/index.html"}
{"id": "99b7928bbdc8-1", "text": "Last modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Job_Queue/Schedulers/Creating_Custom_Schedulers/index.html"}
{"id": "7790482ec18a-0", "text": "Teams\nOverview\nTeams provide the ability to limit access at the record level, allowing sharing flexibility across functional groups.\u00c2\u00a0Developers can manipulate teams programmatically\u00c2\u00a0provided\u00c2\u00a0they understand Sugar's\u00c2\u00a0visibility framework.\nFor more information on teams, please refer to the Team Management documentation.\nDatabase Tables\nTable\nDescription\nteams\nEach record in this table represents a team in the system.\nteam_sets\nEach record in this table represents a unique team combination. For example, each user's private team will have a corresponding team set entry in this table. A team set may also be comprised of one or more teams.\nteam_sets_teams\nThe team_sets_teams table maintains the relationships to determine which teams belong to a team set. Each table that previously used the team_id column to maintain team security now uses the team_set_id column's value to associate the record to team(s).\nteam_sets_modules\nThis table is used to manage team sets and keep track of which modules have records that are or were associated to a particular team set.\nNever\u00c2\u00a0modify these tables without going through the PHP object methods. Manipuating the team sets with direct SQL\u00c2\u00a0may cause undesired side effects in the system due to how the validations and security methods work.\nModule Team Fields\nIn addition to the team tables, each module table also contains a team_id and team_set_id column. The team_set_id contains the id of a record in the team_sets table that contains the unique combination of teams associated with the record. The team_id will contain the id of the primary team designated for a record.\nTeam Sets (team_set_id)", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Teams/index.html"}
{"id": "7790482ec18a-1", "text": "Team Sets (team_set_id)\nAs mentioned above, Sugar implemented this feature not as a many-to-many relationship but as a one-to-many relationship. On each table that had a team_id field we added a 'team_set_id' field. We have also added a team_sets table, which maintains the team_set_id, and a team_sets_teams table, which relates a team set to the teams. When performing a team based query we use the 'team_set_id' field on the module table to join to team_sets_teams.team_set_id and then join all of the teams associated with that set. Given the list of teams from team_memberships we can then decide if the user has access to the record.\nPrimary Team (team_id)\nThe team_id is still being used, not only to support backwards compatibility with workflow and reports, but also to provide some additional features. When displaying a list, we use the team set to determine whether the user has access to the record. When displaying the data, we show the team from team id in the list. When the user performs a mouseover on that team, Sugar performs an Ajax call to display all of the teams associated with the record. This team_id field is designated as the Primary Team because it is the first team shown in the list, and for sales territory management purposes, can designate the team that actually owns the record and can report on it.\nTeam Security\nThe team_sets_teams table allows the system to check for permissions on multiple teams. The following diagram illustrates table relationships in SugarBean's add_team_security_where_clause method.\nUsing the team_sets_teams table the system will determine which teams are associated with the team_set_id and then look in the team_memberships table for users that belong to the team(s).\nTeamSetLink", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Teams/index.html"}
{"id": "7790482ec18a-2", "text": "TeamSetLink\nTypically, any relationship in a class is handled by the data/Link2.php class. As a part of dynamic teams, we introduced the ability to provide your own custom Link class to handle some of the functionality related to managing relationships. The team_security parent vardefs in the Sugar objects contain the following in the 'teams' field definition:\n'link_class' => 'TeamSetLink',\n'link_file' => 'modules/Teams/TeamSetLink.php',\nThe link_class entry defines the class name we are using, and the link_file tells us where that class file is located. This class extends the legacy Link.php and overrides some of the methods used to handle relationships such as 'add' and 'delete'.\nTopicsManipulating Teams ProgrammaticallyHow to manipulate team relationships.Visibility FrameworkThe visibility framework provides the capability to alter the queries Sugar uses to retrieve records from the database. This framework can allow for additional restrictions or specific logic to meet business requirements of hiding or showing only specific records. Visibility classes only apply to certain aspects of Sugar record retrieval, e.g. List Views, Dashlets, and Filter Lookups.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Teams/index.html"}
{"id": "0ce33ce2e5b9-0", "text": "Visibility Framework\nOverview\nThe visibility framework provides the capability to alter the queries Sugar uses to retrieve records from the database. This framework can allow for additional restrictions or specific logic to meet business requirements of hiding or showing only specific records. Visibility classes only apply to certain aspects of Sugar record retrieval, e.g. List Views, Dashlets, and Filter Lookups.\nCustom Row Visibility\nCustom visibility class files are stored under ./custom/data/visibility/. The files in this directory can be enabled or disabled by modifying a module's visibility property located in\u00c2\u00a0./custom/Extension/modules/<module>/Ext/Vardefs/. Every enabled visibility class is merged into the module's definition, allowing multiple layers of logic to be added to a module.\nVisibility Class\nTo add custom row visibility, you must create a visibility class that will extend the core\u00c2\u00a0SugarVisibility class ./data/SugarVisibility.php .\u00c2\u00a0The visibility class has the ability to override the following methods:\nName\nDescription\naddVisibilityQuery\nAdd visibility clauses to a SugarQuery object.\naddVisibilityFrom\n[Deprecated] Add visibility clauses to the FROM part of the query. This method should\u00c2\u00a0still be implemented, as not all objects have been switched over to use addVisibilityQuery() method.\naddVisibilityFromQuery\n[Deprecated] Add visibility clauses to the FROM part of SugarQuery.\u00c2\u00a0This method should\u00c2\u00a0still be implemented, as not all objects have been switched over to use addVisibilityQuery() method.\naddVisibilityWhere\n[Deprecated] Add visibility clauses to the WHERE part of the query.\u00c2\u00a0This method should\u00c2\u00a0still be implemented, as not all objects have been switched over to use\u00c2\u00a0addVisibilityQuery() method.\naddVisibilityWhereQuery\n[Deprecated] Add visibility clauses to the WHERE part of SugarQuery.\u00c2\u00a0This method should\u00c2\u00a0still be implemented, as not all objects have been switched over to use addVisibilityQuery() method.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Teams/Custom_Record_Visibility/index.html"}
{"id": "0ce33ce2e5b9-1", "text": "The visibility class should also implement\u00c2\u00a0Sugarcrm\\Sugarcrm\\Elasticsearch\\Provider\\Visibility\\StrategyInterface\u00c2\u00a0so that the visibility rules are also applied to the global search.\u00c2\u00a0\u00c2\u00a0StrategyInterface\u00c2\u00a0has the following functions that should be implemented:\nName\nDescription\nelasticBuildAnalysis\nBuild Elasticsearch analysis settings.\u00c2\u00a0 This function can be empty if you do not need any special analyzers.\nelasticBuildMapping\nBuild Elasticsearch mapping.\u00c2\u00a0 This function should contain a mapping of fields that should be analyzed.\nelasticProcessDocumentPreIndex\nProcess document before it's being indexed. This function should perform any actions to the document that needs to be completed before\u00c2\u00a0it is indexed.\u00c2\u00a0\nelasticGetBeanIndexFields\nBean index fields to be indexed.\u00c2\u00a0 This function should return an array of the fields that need to be indexed as part of your\u00c2\u00a0custom visibility.\nelasticAddFilters\nAdd visibility filters.\u00c2\u00a0 This function should apply the Elastic filters.\nExample\nThe following example creates a custom visibility filter that determines whether Opportunity records should be displayed based on their Sales Stage.\u00c2\u00a0 Opportunity records with Sales Stage set to Closed Won or Closed Lost will not be displayed in the Opportunities module or global search for users with the Demo Visibility role.\u00c2\u00a0\u00c2\u00a0\n/custom/data/visibility/FilterOpportunities.php:\n<?php\nuse Sugarcrm\\Sugarcrm\\Elasticsearch\\Provider\\Visibility\\StrategyInterface as ElasticStrategyInterface;\nuse Sugarcrm\\Sugarcrm\\Elasticsearch\\Provider\\Visibility\\Visibility;\nuse Sugarcrm\\Sugarcrm\\Elasticsearch\\Analysis\\AnalysisBuilder;\nuse Sugarcrm\\Sugarcrm\\Elasticsearch\\Mapping\\Mapping;\nuse Sugarcrm\\Sugarcrm\\Elasticsearch\\Adapter\\Document;\n/**\n *\n * Custom visibility class for Opportunities module:\n *\n * This demo allows to restrict access to opportunity records based on the", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Teams/Custom_Record_Visibility/index.html"}
{"id": "0ce33ce2e5b9-2", "text": "*\n * This demo allows to restrict access to opportunity records based on the\n * user's role and configured filtered sales stages.\n *\n * The following $sugar_config parameters are available:\n *\n * $sugar_config['custom']['visibility']['opportunities']['target_role']\n * This parameter takes a string containing the role name for which\n * the filtering should apply.\n *\n * $sugar_config['custom']['visibility']['opportunities']['filter_sales_stages']\n * This parameters takes an array of filtered sales stages. If current user is\n * member of the above configured role, then the opportunities with the sale\n * stages as configured in this array will be inaccessible.\n *\n *\n * Example configuration given that 'Demo Visibility' role exists (config_override.php):\n *\n * $sugar_config['custom']['visibility']['opportunities']['target_role'] = 'Demo Visibility';\n * $sugar_config['custom']['visibility']['opportunities']['filter_sales_stages'] = array('Closed Won', 'Closed Lost');\n *\n */\nclass FilterOpportunities extends SugarVisibility implements ElasticStrategyInterface\n{\n    /**\n     * The target role name\n     * @var string\n     */\n    protected $targetRole = '';\n    /**\n     * Filtered sales stages\n     * @var array\n     */\n    protected $filterSalesStages = array();\n    /**\n     * {@inheritdoc}\n     */\n    public function __construct(SugarBean $bean, $params = null)\n    {\n        parent::__construct($bean, $params);\n        $config = SugarConfig::getInstance();\n        $this->targetRole = $config->get(\n            'custom.visibility.opportunities.target_role',\n            $this->targetRole\n        );\n        $this->filterSalesStages = $config->get(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Teams/Custom_Record_Visibility/index.html"}
{"id": "0ce33ce2e5b9-3", "text": ");\n        $this->filterSalesStages = $config->get(\n            'custom.visibility.opportunities.filter_sales_stages',\n            $this->filterSalesStages\n        );\n    }\n    /**\n     * {@inheritdoc}\n     */\n    public function addVisibilityWhere(&$query)\n    {\n        if (!$this->isSecurityApplicable()) {\n            return $query;\n        }\n        $whereClause = sprintf(\n            \"%s.sales_stage NOT IN (%s)\",\n            $this->getTableAlias(),\n            implode(',', array_map(array($this->bean->db, 'quoted'), $this->filterSalesStages))\n        );\n        if (!empty($query)) {\n            $query .= \" AND $whereClause \";\n        } else {\n            $query = $whereClause;\n        }\n        return $query;\n    }\n    /**\n     * {@inheritdoc}\n     */\n    public function addVisibilityWhereQuery(SugarQuery $sugarQuery, $options = array())\n    {\n        $where = null;\n        $this->addVisibilityWhere($where, $options);\n        if (!empty($where)) {\n            $sugarQuery->where()->addRaw($where);\n        }\n        return $sugarQuery;\n    }\n    /**\n     * Check if we can apply our security model\n     * @param User $user\n     * @return false|User\n     */\n    protected function isSecurityApplicable(User $user = null)\n    {\n        $user = $user ?: $this->getCurrentUser();\n        if (!$user) {\n            return false;\n        }\n        if (empty($this->targetRole) || empty($this->filterSalesStages)) {\n            return false;\n        }", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Teams/Custom_Record_Visibility/index.html"}
{"id": "0ce33ce2e5b9-4", "text": "return false;\n        }\n        if (!is_string($this->targetRole) || !is_array($this->filterSalesStages)) {\n            return false;\n        }\n        if (!$this->isUserMemberOfRole($this->targetRole, $user)) {\n            return false;\n        }\n        if ($user->isAdminForModule(\"Opportunities\")) {\n            return false;\n        }\n        return $user;\n    }\n    /**\n     * Get current user\n     * @return false|User\n     */\n    protected function getCurrentUser()\n    {\n        return empty($GLOBALS['current_user']) ? false : $GLOBALS['current_user'];\n    }\n    /**\n     * Check if given user has a given role assigned\n     * @param string $targetRole Name of the role\n     * @param User $user\n     * @return boolean\n     */\n    protected function isUserMemberOfRole($targetRole, User $user)\n    {\n        $roles = ACLRole::getUserRoleNames($user->id);\n        return in_array($targetRole, $roles) ? true : false;\n    }\n    /**\n     * Get table alias\n     * @return string\n     */\n    protected function getTableAlias()\n    {\n        $tableAlias = $this->getOption('table_alias');\n        if (empty($tableAlias)) {\n            $tableAlias = $this->bean->table_name;\n        }\n        return $tableAlias;\n    }\n    /**\n     * {@inheritdoc}\n     */\n    public function elasticBuildAnalysis(AnalysisBuilder $analysisBuilder, Visibility $provider)\n    {\n        // no special analyzers needed\n    }\n    /**\n     * {@inheritdoc}\n     */", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Teams/Custom_Record_Visibility/index.html"}
{"id": "0ce33ce2e5b9-5", "text": "}\n    /**\n     * {@inheritdoc}\n     */\n    public function elasticBuildMapping(Mapping $mapping, Visibility $provider)\n    {\n        $mapping->addNotAnalyzedField('visibility_sales_stage');\n    }\n    /**\n     * {@inheritdoc}\n     */\n    public function elasticProcessDocumentPreIndex(Document $document, \\SugarBean $bean, Visibility $provider)\n    {\n        // populate the sales_stage into our explicit filter field\n        $sales_stage = isset($bean->sales_stage) ? $bean->sales_stage : '';\n        $document->setDataField('visibility_sales_stage', $sales_stage);\n    }\n    /**\n     * {@inheritdoc}\n     */\n    public function elasticGetBeanIndexFields($module, Visibility $provider)\n    {\n        // make sure to pull sales_stage regardless of search\n        return array('sales_stage');\n    }\n    /**\n     * {@inheritdoc}\n     */\n    public function elasticAddFilters(User $user, Elastica\\Query\\BoolQuery $filter,\n                                      Sugarcrm\\Sugarcrm\\Elasticsearch\\Provider\\Visibility\\Visibility $provider)\n    {\n        if (!$this->isSecurityApplicable($user)) {\n            return;\n        }\n        // apply elastic filter to exclude the given sales stages\n        $filter->addMustNot($provider->createFilter(\n            'OpportunitySalesStages',\n            array(\n                'filter_sales_stages' => $this->filterSalesStages,\n            )\n        ));\n    }\n}\n./custom/Extension/modules/Opportunities/Ext/Vardefs/opp_visibility.php\n<?php\nif (!defined('sugarEntry') || !sugarEntry) {\n    die('Not A Valid Entry Point');\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Teams/Custom_Record_Visibility/index.html"}
{"id": "0ce33ce2e5b9-6", "text": "die('Not A Valid Entry Point');\n}\n$dictionary['Opportunity']['visibility']['FilterOpportunities'] = true;\n./custom/src/Elasticsearch/Provider/Visibility/Filter/OpportunitySalesStagesFilter.php\n<?php\nnamespace Sugarcrm\\Sugarcrm\\custom\\Elasticsearch\\Provider\\Visibility\\Filter;\nuse Sugarcrm\\Sugarcrm\\Elasticsearch\\Provider\\Visibility\\Filter\\FilterInterface;\nuse Sugarcrm\\Sugarcrm\\Elasticsearch\\Provider\\Visibility\\Visibility;\n/**\n *\n * Custom opportunity filter by sales_stage\n *\n * This logic can exist directly in the FilterOpportunities visibility class.\n * However by abstracting the (custom) filters makes it possible to re-use\n * them in other places as well.\n */\nclass OpportunitySalesStagesFilter implements FilterInterface\n{\n    /**\n     * @var Visibility\n     */\n    protected $provider;\n    /**\n     * {@inheritdoc}\n     */\n    public function setProvider(Visibility $provider)\n    {\n        $this->provider = $provider;\n    }\n    /**\n     * {@inheritdoc}\n     */\n    public function buildFilter(array $options = array())\n    {\n        return new \\Elastica\\Query\\Terms(\n            'visibility_sales_stage',\n            $options['filter_sales_stages']\n        );\n    }\n}\nAfter creating the above files, log in to your Sugar instance as an administrator and navigate to\u00c2\u00a0Administration\u00c2\u00a0> Repair > Quick Repair and Rebuild.\u00c2\u00a0\u00c2\u00a0\nNext, perform a full reindex by navigating to\u00c2\u00a0Administration\u00c2\u00a0> Search\u00c2\u00a0and selecting the \"delete existing data\" option.\u00c2\u00a0\nExecute a cron to process all of the queued records into Elasticsearch\u00c2\u00a0by doing the following:\u00c2", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Teams/Custom_Record_Visibility/index.html"}
{"id": "0ce33ce2e5b9-7", "text": "Open a command line client and navigate to your Sugar directory.\nExecute\u00c2\u00a0chmod +x bin/sugarcrm\u00c2\u00a0to ensure\u00c2\u00a0bin/sugarcrm is executable.\nExecute\u00c2\u00a0php cron.php\u00c2\u00a0to consume the queue.\nExecute\u00c2\u00a0bin/sugarcrm elastic:queue\u00c2\u00a0to see if the queue has finished.\nRepeat steps 3 and 4 until the queue has 0 records.\nThis example requires the Sales Stage field to be part of the Opportunities module.\u00c2\u00a0\u00c2\u00a0Navigate to\u00c2\u00a0Administration > Opportunities\u00c2\u00a0and ensure the\u00c2\u00a0Opportunities\u00c2\u00a0radio button is selected.\nCreate a new role named \"Demo Visibility\"\u00c2\u00a0and assign a user to this role.\u00c2\u00a0 Note: if you are using the sample data, do NOT use Jim as he has admin permission on the Opportunities module and will be able to view all records. We recommend using Max.\nConfigure your instance to filter opportunities for a given sales stages for this role by adding the following to ./config_override.php:\n<?php\n$sugar_config['custom']['visibility']['opportunities']['target_role'] = 'Demo Visibility';\n$sugar_config['custom']['visibility']['opportunities']['filter_sales_stages'] = array('Closed Won', 'Closed Lost');\nLog in as the user to whom you assigned the Demo Visibility role. Observe that opportunity records in the sales stages \"Closed Won\" and \"Closed Lost\"\u00c2\u00a0are\u00c2\u00a0no longer accessible.\nYou can download a module loadable package of this example here.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Teams/Custom_Record_Visibility/index.html"}
{"id": "e690aa0ef188-0", "text": "Manipulating Teams Programmatically\nOverview\nHow to manipulate team relationships.\nFetching Teams\nTo fetch teams related to a bean, you will need to retrieve an instance of a TeamSet object and use the getTeams() method to retrieve the teams using the team_set_id. An example is shown below:\n//Create a TeamSet bean - no BeanFactory\nrequire_once 'modules/Teams/TeamSet.php';\n$teamSetBean = new TeamSet();\n//Retrieve the bean\n$bean = BeanFactory::getBean($module, $record_id);\n//Retrieve the teams from the team_set_id\n$teams = $teamSetBean->getTeams($bean->team_set_id);\nAdding Teams\nTo add a team to a bean, you will need to load the team's relationship and use the add() method. This method accepts an array of team ids to add. An example is shown below:\n//Retrieve the bean\n$bean = BeanFactory::getBean($module, $record_id);\n//Load the team relationship \n$bean->load_relationship('teams');\n//Add the teams\n$bean->teams->add(\n    array(\n        $team_id_1, \n        $team_id_2\n    )\n);\nConsiderations\nIf adding teams in a logic hook, the recommended approach is to use an after_save hook rather than a before_save hook as the $_REQUEST may reset any changes you make.\nRemoving Teams\nTo remove a team from a bean, you will need to load the team's relationship and use the remove() method. This method accepts an array of team ids to remove. An example is shown below:\n//Retrieve the bean\n$bean = BeanFactory::getBean($module, $record_id);\n//Load the team relationship \n$bean->load_relationship('teams');\n//Remove the teams\n$bean->teams->remove(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Teams/Manipulating_Teams_Programmatically/index.html"}
{"id": "e690aa0ef188-1", "text": "//Remove the teams\n$bean->teams->remove(\n    array(\n        $team_id_1, \n        $team_id_2\n    )\n);\nConsiderations\nIf removing teams in a logic hook, the recommended approach is to use an after_save hook rather than a before_save hook as the $_REQUEST may reset any changes you make.\nReplacing Team Sets\nTo replace all of the teams related to a bean, you will need to load the team's relationship and use the replace() method. This method accepts an array of team ids. An example is shown below:\n//Retrieve the bean\n$bean = BeanFactory::getBean($module, $record_id);\n//Load the team relationship \n$bean->load_relationship('teams');\n//Set the primary team\n$bean->team_id = $team_id_1\n//Replace the teams\n$bean->teams->replace(\n    array(\n        $team_id_1, \n        $team_id_2\n    )\n);\n//Save to update primary team\n$bean->save()\nConsiderations\nIf replacing teams in a logic hook, the recommended approach is to use an after_save hook rather than a before_save hook as the $_REQUEST or workflow may reset any changes you make.\nThis method does not replace (or set) the primary team for the record. When replacing teams, you need to also make sure that the primary team, determined by the team_id field, is set appropriately and included in the replacement ids. If this is being done in a logic hook you should set the primary team in a before_save hook and replace the team set in the after_save hook.\nWhen using an after_save\u00c2\u00a0hook, be sure to call $bean->teams->setSaved(false) to explicitly reset the save state. This ensures that the updates to the team sets are applied.\nExample:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Teams/Manipulating_Teams_Programmatically/index.html"}
{"id": "e690aa0ef188-2", "text": "Example:\n//before save function\npublic function before_save_hook($bean, $event, $arguments)\n{\n    $bean->team_id = $team_id_1;\n}\n//after save function\npublic function after_save_hook($bean, $event, $arguments)\n{\n\t$bean->teams->setSaved(false); // Manually reset TeamSet state for save\n    $bean->teams->replace(\n        array(\n            $team_id_1,\n            $team_id_2\n        )\n    );\n}\nCreating and Retrieving Team Set IDs\nTo create or retrieve the team_set_id for a group of teams, you will need to retrieve an instance of a TeamSet object and use the addTeams() method. If a team set does not exist, this method will create it and return an id. An example is below:\n//Create a TeamSet bean - no BeanFactory\nrequire_once 'modules/Teams/TeamSet.php';\n$teamSetBean = new TeamSet();\n//Retrieve/create the team_set_id\n$team_set_id = $teamSetBean->addTeams(\n    array(\n        $team_id_1,\n        $team_id_2\n    )\n);\nAdding Additional Access\nTo enable additional access for a record, you can either set the team id or team set\u00c2\u00a0to the beans\u00c2\u00a0acl_team_set_id field. An example of this is shown below:\nrequire_once 'modules/Teams/TeamSet.php';\n// Create a new teamset or fetch the id of an existing teamset\n$teamSetBean = new TeamSet();\n$teamSetId = $teamSetBean->addTeams([\n    'East', // Demo Team ID\n    'West', // Demo Team ID\n]);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Teams/Manipulating_Teams_Programmatically/index.html"}
{"id": "e690aa0ef188-3", "text": "'East', // Demo Team ID\n    'West', // Demo Team ID\n]);\n$bean = BeanFactory::getBean('Accounts', '15bcf01c-1e1e-11e8-9e13-f45c89a8598f');\n// Set additional access\n$bean->acl_team_set_id = $teamSetId; // if set to NULL, this will remove any existing value\n$bean->save();\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Architecture/Teams/Manipulating_Teams_Programmatically/index.html"}
{"id": "2488a9c58980-0", "text": "Data Framework\nThe Sugar application comprises core elements such as modules, fields, vardefs, and other foundational components. The Data Framework pages document how these core elements are modeled and implemented in Sugar.\nTopicsModulesHow modules are defined and used within the systemModelsAn overview of the SugarBean model.VardefsVardefs (Variable Definitions) provide the Sugar application with information about SugarBeans. Vardefs specify information on the individual fields, relationships between beans, and the indexes for a given bean.FieldsHow fields interact with the various aspects of Sugar.RelationshipsRelationships are the basis for linking information within the system. This page explains the various aspects of relationships. For information on custom relationships, please refer to the Custom Relationships documentation.SubpanelsFor Sidecar, Sugar's subpanel layouts have been modified to work as simplified metadata. This page is an overview of the metadata framework for subpanels.DatabaseAll Sugar products support the MySQL and Microsoft SQL Server databases. Sugar Enterprise and Sugar Ultimate also support the DB2 and Oracle databases. In general, Sugar uses only common database functionality, and the application logic is embedded in the PHP code. Sugar does not use or recommend database triggers or stored procedures. This design simplifies coding and testing across different database vendors. The only implementation difference across the various supported databases is column types.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/index.html"}
{"id": "dfff445c31e0-0", "text": "Modules\nOverview\nHow modules are defined and used within the system\nModule Definitions\nThe module definitions, defined in ./include/modules.php, determine\u00c2\u00a0how modules are displayed and used throughout the application. Any custom metadata, whether from a plugin or a custom module, should be loaded through the Include\u00c2\u00a0extension.\u00c2\u00a0Prior to 6.3.x, module definitions could be added by creating the file ./include/modules_override.php. This method of creating module definitions is still compatible but is not recommended from a best practices standpoint.\u00c2\u00a0\nHierarchy Diagram\nThe modules metadata are loaded in the following manner:\n$moduleList\nThe $moduleList is an array containing a list of modules in the system. The format of the array is to have a numeric index and a value of the modules unique key.\n$moduleList[] = 'Accounts';\n$beanList\nThe $beanList variable is an array that stores a list of all active beans (modules) in the application. The format of the array is array('<bean plural name>' => '<bean singular name>');. The $beanList key is used to lookup values in the $beanFiles variable.\n$beanList['Accounts'] = 'Account';\n$beanFiles\nThe $beanFiles variable is an array used to reference the class files for a bean. The format of the array is array('<bean singular name>' => '<relative class file>');. The bean name, stored in singular form, is a reference to the class name of the object, which is looked up from the $beanList 'key'.\n$beanFiles['Account'] = 'modules/Accounts/Account.php';\n$modInvisList", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Modules/index.html"}
{"id": "dfff445c31e0-1", "text": "$modInvisList\nThe $modInvisList variable\u00c2\u00a0removes a module from the navigation tab in the MegaMenu, reporting, and it's subpanels under related modules.To enable a hidden module for reporting, you can use\u00c2\u00a0$report_include_modules.\u00c2\u00a0To enable a hidden modules\u00c2\u00a0subpanels on related modules, you can use\u00c2\u00a0$modules_exempt_from_availability_check.\u00c2\u00a0The\u00c2\u00a0\n$modInvisList[] = 'Prospects';\n$modules_exempt_from_availability_check\nThe\u00c2\u00a0$modules_exempt_from_availability_check variable is used in conjunction with\u00c2\u00a0$modInvisList. When a module has been removed from the MegaMenu view with $modInvisList,\u00c2\u00a0this will allow for the display of the modules subpanels under related modules.\n$modules_exempt_from_availability_check['OAuthKeys'] = 'OAuthKeys';\n$report_include_modules\n\u00c2\u00a0The\u00c2\u00a0$report_include_modules\u00c2\u00a0variable is used in conjunction with\u00c2\u00a0$modInvisList. When a module has been hidden with $modInvisList,\u00c2\u00a0this will allow for the module to be enabled for reporting.\n$report_include_modules['Prospects'] = 'Prospect';\n$adminOnlyList\nThe $adminOnlyList variable is an extra level of security for modules that are can be accessed only by administrators through the Admin page. Specifying all will restrict all actions to be admin only.\n$adminOnlyList['PdfManager'] = array(\n    'all' => 1\n);\n$bwcModules\nThe $bwcModules variable determines which modules are in backward compatibility mode. More information on backward compatibility can be found in the Backward Compatibility section.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Modules/index.html"}
{"id": "3c261ad5c3c2-0", "text": "Relationships\nOverview\nRelationships are the basis for linking information within the system. This page\u00c2\u00a0explains the various aspects of relationships. For information on custom relationships, please refer to the Custom Relationships documentation.\nDefinitions\nRelationships are initially defined in the module's vardefs file under the relationships array. For reference, you can find them using the vardef path\u00c2\u00a0./modules/<module>/vardefs.php.\nDatabase Structure\nIn Sugar, most relationships are stored using a joining table. This applies to both one-to-many (1:M) relationships as well as many-to-many (M:M) relationships. An example of this is the relationship between Accounts and Opportunities where there are three tables:\u00c2\u00a0accounts,\u00c2\u00a0accounts_opportunities,\u00c2\u00a0and\u00c2\u00a0opportunities.\u00c2\u00a0You will find that the joining table,\u00c2\u00a0accounts_opportunities,\u00c2\u00a0will contain the fields needed in order to establish the relationship link.\nThe fields on the accounts_opportunities\u00c2\u00a0table are listed below:\nFields\nDescription\nid\nA unique identifier for the relationship row (not typically used)\nopportunity_id\nThe ID for the related opportunity\u00c2\u00a0record. This is\u00c2\u00a0named uniquely based on the relationship\naccount_id\nThe ID for the related account\u00c2\u00a0record. This is named uniquely based on the relationship\ndate_modified\nThe date the row was last modified\ndeleted\nWhether or not the relationship still exists\nRelationship Cache\nAll relationships in Sugar are compiled into the cache directory ./cache/Relationships/relationships.cache.php.\u00c2\u00a0If needed, the relationships cache can be rebuilt by navigating to\u00c2\u00a0Admin > Repair > Rebuild Relationships.\nTopicsCustom RelationshipsThis page needs an overview\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Relationships/index.html"}
{"id": "ca45634a7d7d-0", "text": "Custom Relationships\nOverview\nThis page needs an overview\nCreating Custom Relationships\nRelationships are initially defined in the module's vardefs file under the relationships array. For reference, you can find them using the vardef path as follows:\n./modules/<module>/vardefs.php\nCustom relationships are created in a different way using the Extension Framework. The process requires two steps which are explained in the following sections:\nDefining the Relationship MetaData\nDefining the Relationship in the TableDictionary\nDefining the Relationship MetaData\nThe definitions for custom relationships will be found in a path similar to:\n./custom/metadata/<relatonship name>MetaData.php\nThis file will contain the $dictionary information needed for the system to generate the relationship. The $dictionary array will contain the following:\nIndex\nType\nDescription\ntrue_relationship_type\nString\nThe relationship's structure (possible values: 'one-to-many' or 'many-to-many')\nfrom_studio\nBoolean\nWhether the relationship was created in Studio\ntable\nString\nThe name of the table that is created in the database to contain the link ids\nfields\nArray\nAn array of fields to be created on the relationship join table\nindices\nArray\nThe list of indexes to be created\nrelationships\nArray\nAn array defining relationships\nrelationships.<rel>\nArray\nThe array defining the relationship\nrelationships.<rel>.lhs_module\nString\nLeft-hand module (should match $beanList index)\nrelationships.<rel>.lhs_table\nString\nLeft-hand table name\nrelationships.<rel>.lhs_key\nString\nThe key to use from the table on the left\nrelationships.<rel>.rhs_module\nString\nRight-hand module (should match $beanList index)\nrelationships.<rel>.rhs_table\nString\nRight-hand table name\nrelationships.<rel>.rhs_key\nString\nThe key to use from the table on the right\nrelationships.<rel>.relationship_type\nString", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Relationships/Custom_Relationships/index.html"}
{"id": "ca45634a7d7d-1", "text": "The key to use from the table on the right\nrelationships.<rel>.relationship_type\nString\nThe relationship type, typically stored as 'many-to-many'\nrelationships.<rel>.join_table\nString\nThe join table\nrelationships.<rel>.join_key_lhs\nString\nLeft table key, should exist in table field definitions above\nrelationships.<rel>.join_key_rhs\nString\nRight\u00c2\u00a0table key, should exist in table field definitions above\nMetaData Example\nCreating a custom 1:M relationship between Accounts and Contacts will yield the following metadata file:\n./custom/metadata/accounts_contacts_1MetaData.php\n<?php\n// created: 2013-09-20 15:15:47\n$dictionary[\"accounts_contacts_1\"] = array (\n  'true_relationship_type' => 'one-to-many',\n  'from_studio' => true,\n  'relationships' =>\n  array (\n    'accounts_contacts_1' =>\n    array (\n      'lhs_module' => 'Accounts',\n      'lhs_table' => 'accounts',\n      'lhs_key' => 'id',\n      'rhs_module' => 'Contacts',\n      'rhs_table' => 'contacts',\n      'rhs_key' => 'id',\n      'relationship_type' => 'many-to-many',\n      'join_table' => 'accounts_contacts_1_c',\n      'join_key_lhs' => 'accounts_contacts_1accounts_ida',\n      'join_key_rhs' => 'accounts_contacts_1contacts_idb',\n    ),\n  ),\n  'table' => 'accounts_contacts_1_c',\n  'fields' =>\n  array (\n    0 =>\n    array (\n      'name' => 'id',\n      'type' => 'varchar',\n      'len' => 36,\n    ),\n    1 =>\n    array (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Relationships/Custom_Relationships/index.html"}
{"id": "ca45634a7d7d-2", "text": "),\n    1 =>\n    array (\n      'name' => 'date_modified',\n      'type' => 'datetime',\n    ),\n    2 =>\n    array (\n      'name' => 'deleted',\n      'type' => 'bool',\n      'len' => '1',\n      'default' => '0',\n      'required' => true,\n    ),\n    3 =>\n    array (\n      'name' => 'accounts_contacts_1accounts_ida',\n      'type' => 'varchar',\n      'len' => 36,\n    ),\n    4 =>\n    array (\n      'name' => 'accounts_contacts_1contacts_idb',\n      'type' => 'varchar',\n      'len' => 36,\n    ),\n  ),\n  'indices' =>\n  array (\n    0 =>\n    array (\n      'name' => 'accounts_contacts_1spk',\n      'type' => 'primary',\n      'fields' =>\n      array (\n        0 => 'id',\n      ),\n    ),\n    1 =>\n    array (\n      'name' => 'accounts_contacts_1_ida1',\n      'type' => 'index',\n      'fields' =>\n      array (\n        0 => 'accounts_contacts_1accounts_ida',\n      ),\n    ),\n    2 =>\n    array (\n      'name' => 'accounts_contacts_1_alt',\n      'type' => 'alternate_key',\n      'fields' =>\n      array (\n        0 => 'accounts_contacts_1contacts_idb',\n      ),\n    ),\n  ),\n);\nDefining the Relationship in the TableDictionary", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Relationships/Custom_Relationships/index.html"}
{"id": "ca45634a7d7d-3", "text": "),\n    ),\n  ),\n);\nDefining the Relationship in the TableDictionary\nOnce a relationship's metadata has been created, the metadata file will have a reference placed in the TableDictionary:\n./custom/Extension/application/Ext/TableDictionary/<relationship name>.php\nThis file will contain an 'include' reference to the metadata file:\n<?php\n    include('custom/metadata/<relationship name>MetaData.php');\n?>\nTableDictionary Example\nThe custom 1:M relationship between Accounts and Contacts will yield the following TableDictionary file:\n./custom/Extension/application/Ext/TableDictionary/accounts_contacts_1.php\n<?php\n    //WARNING: The contents of this file are auto-generated\n    include('custom/metadata/accounts_contacts_1MetaData.php');\n?>\nIf you have created the\u00c2\u00a0relationship through Studio, the files above will be automatically created. If you are manually creating the files, run a Quick Repair and Rebuild and run any SQL scripts generated. The Quick Repair and Rebuild will rebuild the file map and relationship cache as well as populate the relationship in the relationships table.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Relationships/Custom_Relationships/index.html"}
{"id": "9b27bb27bb41-0", "text": "Database\nOverview\nAll Sugar products support the MySQL and Microsoft SQL Server databases. Sugar Enterprise and Sugar Ultimate also support the DB2 and Oracle databases. In general, Sugar uses only common database functionality, and the application logic is embedded in the PHP code. Sugar does not use or recommend database triggers or stored procedures. This design simplifies coding and testing across different database vendors. The only implementation difference across the various supported databases is column types.\u00c2\u00a0\nPrimary Keys, Foreign Keys, and GUIDs\nBy default, Sugar uses globally unique identification values (GUIDs) for primary keys for all database records. Sugar provides a Sugarcrm\\Sugarcrm\\Util\\Uuid::uuid1() utility function for creating these GUIDs in the following format: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee. The primary key's column length is 36 characters.\u00c2\u00a0\nThe GUID format and value has no special meaning (relevance) in Sugar other than the ability to match records in the database. Sugar links two records (such as an Accounts record with a Contacts record) with a specified ID in the record type relationship table (e.g. accounts_contacts).\nPrimary keys in Sugar may\u00c2\u00a0contain any unique string such as a GUID algorithm, a key that has some meaning (e.g. bean type first, followed by info), an external key, or auto-incrementing numbers converted to strings. Sugar chose GUIDs over auto-incrementing keys to enable easier data synchronization across databases and avoid primary-key collisions.\nYou can also import data from a previous system with one primary key format and make all new records in Sugar use the GUID primary key format. All keys must\u00c2\u00a0be stored as globally unique strings with no more than 36 characters.\nNotice\u00c2\u00a0If multiple records between modules contain matching ids, you may experience undesired behaviors within the system.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/index.html"}
{"id": "9b27bb27bb41-1", "text": "To\u00c2\u00a0implement a new primary key method or to import data with a different primary key format (based on the existing GUID mechanism for new records), keep in mind\u00c2\u00a0the following rules of primary key behavior:\nQuote characters : Sugar expects primary keys to be string types and will format the SQL with quotes. If you change the primary key types to an integer type, SQL errors may occur since Sugar stores all ID values in quotes in the generated SQL. The database may be able to ignore this issue. MySQL running in Safe mode experiences issues, for instance.\nCase sensitivity : The ID values abc and ABC are treated the same in MySQL but represent different values in Oracle. When migrating data to Sugar, some CRM systems may use case-sensitive strings as their IDs on export. If this is the case, and you are running MySQL, you must\u00c2\u00a0run an algorithm on the data to make sure all of the IDs are unique. One simple algorithm is to MD5 the ID values that they provide. A quick check will let you know if there is a problem. If you imported 80,000 leads and there are only 60,000 in the system, some may have been lost due to non-unique primary keys caused by case insensitivity.\nKey size\u00c2\u00a0: Sugar only tracks the first 36 characters in the primary key. Any replacement primary key will either require changing all of the ID columns with one of an appropriate size or to make sure you do not run into any truncation or padding issues. MySQL in some versions has had issues with Sugar where the IDs were not matching because it was adding spaces to pad the row out to the full size. MySQL's handling of char and varchar padding has changed in later\u00c2\u00a0versions. To protect against this, make sure the GUIDs are not padded with blanks in the database by removing any leading or trailing space characters.\nIndexes", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/index.html"}
{"id": "9b27bb27bb41-2", "text": "Indexes\nIndexes can be defined in the main or custom vardefs.php for a module in an array under the key indices. See below for an example of defining several indices:\n'indices' => array(\n     array(\n         'name' => 'idx_modulename_name',\n         'type' => 'index',\n         'fields' => array('name'),\n     ),\n     array(\n         'name' => 'idx_modulename_assigned_deleted',\n         'type' => 'index',\n         'fields' => array('assigned_user_id', 'deleted'),\n     ),\n ),\nThe name of the index must start with idx_ and must be unique across the database. Possible values for type include primary for a primary key or index for a normal index. The fields list matches the column names used in the database.\nDoctrine\nIn order to provide robust support for Prepared Statements, which provide more security and better database access performance, Sugar 7.9 has adopted parts of Doctrine's Database Abstraction Layer, especially the QueryBuilder class, for working with prepared statements. The picture below shows how Sugar objects like DBManager and SugarQuery utilize Doctrine to provide this functionality, while still using the same toolset that has existed in Sugar.\n\u00c2\u00a0\nDBManager\nThe DBManager class will use Doctrine QueryBuilder for building INSERT and UPDATE queries.\nSugarQuery\nThe SugarQuery class will use Doctrine QueryBuilder for building SELECT queries.\nSugarBean\nThe SugarBean class will continue to use DBManager class for saving all fields.\nTopicsDBManagerThe DBManager Object provides an interface for working with the database.SugarQuerySugarQuery, located in ./include/SugarQuery/SugarQuery.php, provides an object-oriented approach to working with the database. This allows developers to generate the applicable SQL for a Sugar system without having to know which database backend the instance is using. SugarQuery supports all databases supported by Sugar.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/index.html"}
{"id": "9b27bb27bb41-3", "text": "Last modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/index.html"}
{"id": "596861757546-0", "text": "DBManager\nOverview\nThe DBManager Object provides an interface for working with the database.\nInstantiating the DBManager Object\nThe DBManagerFactory class, located in ./include/database/DBManagerFactory.php,\u00c2\u00a0can help instantiate a DBManager object using the getInstance() method.\n$db = \\DBManagerFactory::getInstance();\nFor best practices, we recommend using the global DBManager Object:\n$GLOBALS['db']\nQuerying The Database\nSugar supports prepared statements. The following sections outline the legacy usage and the newly prepared statement usage.\nSELECT queries\nFor select queries that do not have a dynamic portion of the where clause, you can use the query()\u00c2\u00a0method on the DBManager object. For queries that are accepting data passed into the system in the where clause, the following examples demonstrate how best utilize the new Prepared Statement functionality.\nLegacy:\n$id = '1234-abcde-fgh45-6789';\n$query = 'SELECT * FROM accounts WHERE id = ' . $GLOBALS['db']->quoted($id);\n$results = $GLOBALS['db']->query($query);\nBest Practice:\nUse the getConnection() method to retrieve a Doctrine Connection Object which handles prepared statements.\n$id = '1234-abcde-fgh45-6789';\n$query = 'SELECT * FROM accounts WHERE id = ?';\n$conn = $GLOBALS['db']->getConnection(); \n$result = $conn->executeQuery($query, [$id]);\nIn the case that query logic is variable or conditionally built then it makes sense to use Doctrine QueryBuilder directly.\nLegacy:\n$query = 'SELECT * FROM accounts'; \nif ($status !== null) {\n\t$query .= ' WHERE status = ' . $GLOBALS['db']->quoted($status);\n}\n$results = $GLOBALS['db']->query($query);\nBest Practice:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/DBManager/index.html"}
{"id": "596861757546-1", "text": "}\n$results = $GLOBALS['db']->query($query);\nBest Practice:\nUse the getConnection() method to retrieve the Doctrine Connection Object, and then use the createQueryBuilder() method on the Connection Object to retrieve the QueryBuilder Object.\n$builder = $GLOBALS['db']->getConnection()->createQueryBuilder();\n$builder->select('*')->from('accounts');\nif ($status !== null) {\n\t$builder->where('status = ' . $builder->createPositionalParameter($status));\n}\n$result = $builder->executeQuery();\nRetrieving Results\nLegacy:\nAfter using the\u00c2\u00a0query()\u00c2\u00a0method, such as in the Legacy code examples above, you can use the\u00c2\u00a0fetchByAssoc() method to retrieve results. The query() method will submit the query and retrieve the results while the fetchByAssoc() method will iterate through the results:\n$sql = \"SELECT id FROM accounts WHERE deleted = 0\";\n$result = $GLOBALS['db']->query($sql);\nwhile($row = $GLOBALS['db']->fetchByAssoc($result) )\n{\n    //Use $row['id'] to grab the id fields value\n    $id = $row['id'];\n}\nBest Practice:\nWhen using Prepared Statements, both the Doctrine Query Builder and the Doctrine Connection Object will return a Doctrine\\DBAL\\Result Object to allow iterating through the results of the query. You can use the fetchNumeric()\u00c2\u00a0,\u00c2\u00a0fetchAssociative() or fetchAllNumeric()\u00c2\u00a0or fetchAllAssociative() methods to retrieve results.\nfetchAllAssociative() Example\nThe fetchAllAssociative() method will return the entire result set as an associative array, with each index containing a row of data.\n$conn = $GLOBALS['db']->getConnection();\n$result = $conn->executeQuery(\"SELECT * FROM accounts\");\nforeach ($result->iterateAssociative() as $row) {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/DBManager/index.html"}
{"id": "596861757546-2", "text": "foreach ($result->iterateAssociative() as $row) {\n    $name = $row['name'];\n    // do something\n}\niterateAssociativeIndexed() Example\nThe iterateAssociativeIndexed() method executes the query and iterate over the result with the key representing the first column and the value is an associative array of the rest of the columns and their values:\n$query = 'SELECT id, name FROM accounts';\n$conn = $GLOBALS['db']->getConnection();\nforeach ($conn->iterateAssociativeIndexed($query) as $id => $data) {\n    // ...\n}\nRetrieving a Single Result\nTo retrieve a single result from the database, such as a specific record field, you can use the getOne() method for Legacy query usage.\n$sql = \"SELECT name FROM accounts WHERE id = :id\";\n$conn = $GLOBALS['db']->getConnection();\n$row = $conn->fetchAssociative($sql, ['id' => $id]);\n// alternative\n$sql = \"SELECT name FROM accounts WHERE id = '{$id}'\";\n$name = $GLOBALS['db']->getOne($sql);\nLimiting Results\nTo limit the results of a query, you can add a limit to the SQL string or for legacy query usage you can use the limitQuery() method on the DBManager Object:\nLegacy:\n$sql = \"SELECT id FROM accounts WHERE deleted = 0\";\n$offset = 0;\n$limit = 1;\n$result = $GLOBALS['db']->limitQuery($sql, $offset, $limit);\nwhile($row = $GLOBALS['db']->fetchByAssoc($result) )\n{\n    //Use $row['id'] to grab the id fields value\n    $id = $row['id'];\n}\nPrepared Statements:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/DBManager/index.html"}
{"id": "596861757546-3", "text": "$id = $row['id'];\n}\nPrepared Statements:\nWhen using the Doctrine Query Builder, you can limit the results of the query by using the\u00c2\u00a0setMaxResults() method.\n$builder = $GLOBALS['db']->getConnection()->createQueryBuilder();\n$builder->select('*')->from('accounts');\nif ($status !== null) {\n\t$builder->where('status = ' . $builder->createPositionalParameter($status)); \n}\n$builder->setMaxResults(2);\n$result = $builder->executeQuery();\nINSERT queries\nINSERT queries\u00c2\u00a0can be easily performed using DBManager class.\nLegacy:\n$query = 'INSERT INTO table (foo, bar) VALUES (\"foo\", \"bar\")';\n$GLOBALS['db']->query($query);\nBest Practice:\n$fieldDefs = $GLOBALS['dictionary']['table']['fields'];\n$GLOBALS['db']->insertParams('table', $fieldDefs, ['foo' => 'foo','bar' => 'bar']);\nUPDATE queries\nWhen updating records with known IDs or a set of records with simple filtering criteria, then DBManager can be used:\nLegacy:\n$query = 'UPDATE table SET foo = \"bar\" WHERE id = ' . $GLOBALS['db']->quoted($id);\n$GLOBALS['db']->query($query);\nBest Practice:\n$fieldDefs = $GLOBALS['dictionary']['table']['fields'];\n$GLOBALS['db']->updateParams('table', $fieldDefs, ['foo' => 'bar',], ['id' => $id]);\nFor more complex criteria\u00c2\u00a0or when column values contain expressions or references to other fields in the table then Doctrine QueryBuilder can be used.\nLegacy:\n$query = 'UPDATE table SET foo = \"bar\" WHERE foo = \"foo\" OR foo IS NULL';\n$GLOBALS['db']->query($query);\nBest Practice:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/DBManager/index.html"}
{"id": "596861757546-4", "text": "$GLOBALS['db']->query($query);\nBest Practice:\n$query = 'UPDATE table SET foo = ? WHERE foo = ? OR foo IS NULL';\n$conn = $GLOBALS['db']->getConnection();\n$rowCount = $conn->executeStatement($query, ['bar', 'foo']);\nGenerating SQL Queries from SugarBean\nTo have Sugar automatically generate SQL queries, you can use the following\u00c2\u00a0methods from the bean class.\nSelect Queries\nTo create a select query you can use the create_new_list_query() method:\n$bean = BeanFactory::newBean($module);\n$order_by = '';\n$where = '';\n$fields = array(\n    'id',\n    'name',\n);\n$sql = $bean->create_new_list_query($order_by, $where, $fields);\nCount Queries\nYou can also run the generated SQL through the create_list_count_query() method to generate a count query:\n$bean = BeanFactory::newBean('Accounts');\n$sql = \"SELECT * FROM accounts WHERE deleted = 0\";\n$count_sql = $bean->create_list_count_query($sql);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/DBManager/index.html"}
{"id": "6ba0a71f4c57-0", "text": "SugarQuery\nOverview\nSugarQuery, located in ./include/SugarQuery/SugarQuery.php, provides an object-oriented approach\u00c2\u00a0to working with the database. This allows developers to generate\u00c2\u00a0the\u00c2\u00a0applicable SQL for a Sugar system without having to know which database backend the instance is using. SugarQuery supports all databases supported by Sugar.\nNote: SugarQuery only supports reading data from the database at this time (i.e. SELECT statements).\u00c2\u00a0\nSetup\nTo use SugarQuery, simply create a new SugarQuery object.\n$sugarQuery = new SugarQuery();\nBasic Usage\nUsing the SugarQuery object\u00c2\u00a0to retrieve records or generate SQL queries is very simple. At a minimum you need to set the Module\u00c2\u00a0you are working with, using the from()\u00c2\u00a0method, however, there are helper methods for just about any operation you would need in a SQL query. The methods listed below will outline the major methods\u00c2\u00a0you should consider utilizing on the SugarQuery object in order to achieve your development goals.\nfrom()\nThe from() method is used to set the primary module the SugarQuery object will be querying from. It is also used to set some crucial options for the query, such as whether Team Security should be used or if only non-deleted records should be queried. The following example will set the SugarQuery object to query from the Accounts module.\n$sugarQuery->from(BeanFactory::newBean('Accounts'));\nArguments\nName\nType\nRequired\nDescription\n$bean\nSugarBean Object\ntrue\nThe SugarBean object for a\u00c2\u00a0specified module. The SugarBean object does not have to be a blank or new Bean as seen in the example above, but can be a previously instantiated SugarBean object.\n$options\nArray\nfalse\nAn associative array that can specify any\u00c2\u00a0of the following options:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/index.html"}
{"id": "6ba0a71f4c57-1", "text": "Array\nfalse\nAn associative array that can specify any\u00c2\u00a0of the following options:\nalias - string -\u00c2\u00a0The alias for the module table in the generated SQL query\nteam_security -\u00c2\u00a0boolean - Whether or not Team Security should be added to the generated SQL\u00c2\u00a0query\u00c2\u00a0\nadd_deleted -\u00c2\u00a0boolean - Whether or not 'deleted' = 0 should be added to Where clause of generated SQL query\nReturns\nSugarQuery Object \nAllows for method chaining on the SugarQuery object.\nselect()\nThe example above\u00c2\u00a0demonstrates the most\u00c2\u00a0basic example of retrieving records from a module. The select() method can be used on the SugarQuery object to specify the specific fields you wish to retrieve from the query.\n//Alter the Selected Fields\n$sugarQuery->select(array('id', 'name'));\nArguments\nName\nType\nRequired\nDescription\n$fields\nArray\nfalse\nSets the fields that should be added to the SELECT portion of the SQL query\nReturns\nSugarQuery_Builder_Select Object\nYou cannot chain SugarQuery methods off of the select() method, however, you can use the returned Select object to modify the SELECT portion of the statement. Review the\u00c2\u00a0SugarQuery_Builder_Select object in ./include/SugarQuery/Builder/Select.php for additional information on usage.\nwhere()\nTo add a WHERE clause to the query, use the where() method to generate the Where object, and then use method chaining with the various helper methods to add conditions. To add a\u00c2\u00a0WHERE clause for records with the\u00c2\u00a0name field containing\u00c2\u00a0the letter \"I\", you could add\u00c2\u00a0the following code.\u00c2\u00a0\n//add the where clause\n$sugarQuery->where()->contains('name', 'I');\nArguments\nNone\nReturns\nSugarQuery_Builder_Where Object", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/index.html"}
{"id": "6ba0a71f4c57-2", "text": "Arguments\nNone\nReturns\nSugarQuery_Builder_Where Object\nAllows for method chaining on the Where object as shown above.\u00c2\u00a0Review the SugarQuery Conditions documentation for a\u00c2\u00a0full spectrum of where() method usage.\nRelationships\njoin()\nTo add data from a related module to the SugarQuery, use the join() method. Adding to the same SugarQuery code example in this page, the\u00c2\u00a0following code would\u00c2\u00a0add the JOIN from Accounts module tables to Contacts table:\n//add join\n$sugarQuery->join('contacts');\nArguments\nName\nType\nRequired\nDescription\n$link_name\nString\ntrue\nThe name of the relationship\n$options\nArray\nfalse\n\u00c2\u00a0\nAn associative array that can specify any\u00c2\u00a0of the following options:\nalias - string -\u00c2\u00a0The alias for the module table in the generated SQL query\nrelatedJoin -\u00c2\u00a0string\u00c2\u00a0- If joining to a secondary table (related to a related module), such as joining on Opportunities related to Contacts, when querying from Accounts, you can specify either the name of the relationship or the alias you specified for that relationship table.\nReturns\nSugarQuery_Builder_Join Object\nAllows for method chaining on the SugarQuery_Builder_Join Object, to add additional conditions to the WHERE clause of the SQL condition.\u00c2\u00a0\njoinTable()\nIf you were using the joinRaw() method in previous versions of Sugar, this is the replacement method which allows for joining to a\u00c2\u00a0related table in SugarQuery. Adding to the same SugarQuery code example in this page, the\u00c2\u00a0following code would\u00c2\u00a0add the JOIN from Accounts module tables to the\u00c2\u00a0accounts_contacts\u00c2\u00a0table:\n//add join\n$sugarQuery->joinTable('accounts_contacts', array('alias' => 'ac'))->on()\n    ->equalsField('accounts.id','ac.account_id')", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/index.html"}
{"id": "6ba0a71f4c57-3", "text": "->equalsField('accounts.id','ac.account_id')\n    ->equals('ac.primary_account',1);\nArguments\nName\nType\nRequired\nDescription\n$table_name\nString\ntrue\nThe name of the database table to join.\u00c2\u00a0\n$options\nArray\nfalse\n\u00c2\u00a0\nAn associative array that can specify any\u00c2\u00a0of the following options:\nalias - string -\u00c2\u00a0The alias for the module table in the generated SQL query\nReturns\nSugarQuery_Builder_Join Object\nAllows for method chaining on the SugarQuery_Builder_Join Object, to add additional conditions to the ON\u00c2\u00a0clause using the on() method.\u00c2\u00a0\nAltering Results\nAltering\u00c2\u00a0the result set of a query can help the performance, as well as be crucial to finding the correct data. The following methods provide ways to limit the result set and change the order.\ndistinct()\nTo group the query on a field, you can use the corresponding distinct() method.\n//add group by\n$sugarQuery->distinct(true);\nArguments\nName\nType\nRequired\nDescription\n$value\nBoolean\ntrue\nSet whether or not the DISTINCT statement should be added to the query\nReturns\nCurrent SugarQuery Object\nAllows for method chaining on the SugarQuery Object.\nlimit()\nTo limit the results of the query, you can use the limit() method.\u00c2\u00a0\n//set the limit \n$sugarQuery->limit(10);\nArguments\nName\nType\nRequired\nDescription\n$number\nInteger\ntrue\nThe max amount of rows that should be returned by the query\nReturns\nCurrent SugarQuery Object\nAllows for method chaining on the SugarQuery Object.\noffset()", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/index.html"}
{"id": "6ba0a71f4c57-4", "text": "Current SugarQuery Object\nAllows for method chaining on the SugarQuery Object.\noffset()\nAdding a limit to the query limits the rows returned, however when doing so, you may need to alter the offset of the query to account for pagination or access other portions of the result set. To set an offset, you can use the offset() method.\n//set the offset\n$sugarQuery->offset(5);\nArguments\nName\nType\nRequired\nDescription\n$number\nInteger\ntrue\nThe\u00c2\u00a0offset amount of rows, or starting point, of the result\nReturns\nCurrent SugarQuery Object\nAllows for method chaining on the SugarQuery Object.\norderBy()\nTo order\u00c2\u00a0the query on a field, you can use the corresponding orderBy() method. This method can be called multiple times, to add multiple fields to the order by clause\u00c2\u00a0of the query.\n//add group by\n$sugarQuery->orderBy('account_type');\nArguments\nName\nType\nRequired\nDescription\n$column\nString\ntrue\nThe\u00c2\u00a0field you want the query to be grouped on\n$direction\nString\nfalse\nSets the direction of sorting. Must be 'ASC' or 'DESC'. The default is 'DESC'.\nReturns\nCurrent SugarQuery Object\nAllows for method chaining on the SugarQuery Object.\nExecution\nOnce you have the SugarQuery object setup and configured for your statement, you will want to retrieve the results of the query, or simply get the generated query for the object. The following methods are used for executing the SugarQuery object.\nexecute()\nTo query the database for a result set, you will use the execute() method. The execute() method will retrieve the results and return them as a raw string, db object, json, or an array depending on the $type parameter. By default, results are returned as an array. An example of fetching records from an account is below:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/index.html"}
{"id": "6ba0a71f4c57-5", "text": "//fetch the result\n$result = $sugarQuery->execute();\nThe execute() function will return an array of results that you can iterate through as shown below:\nArray\n(\n    [0] => Array\n    (\n        [id] => f39593da-3f88-3059-4f18-524b4d23d07b\n        [name] => International Art Inc\n    )\n)\nNote:\u00c2\u00a0An empty resultset will return an empty array.\nArguments\nName\nType\nRequired\nDescription\n$type\nString\nfalse\nHow you want the results of the Query returned. Can be one of the following options:\ndb\u00c2\u00a0- Returns the result directly from the DatabaseManager resource\narray\u00c2\u00a0-\u00c2\u00a0Default\u00c2\u00a0- Returns the results as a formatted array\njson - Returns the results encoded as JSON\nReturns\nDefault:\u00c2\u00a0Array.\u00c2\u00a0See above argument details for details on other Return options.\ncompile()\nIf you want to log the query being generated or want to output the query without running it during development, the compile() method is what should be used retrieve the Prepared Statement. You can then retrieve the Prepared Statement Object to retrieve the Parameterized SQL and the Parameters. For further information on Prepared Statement usage, see our Database documentation.\n//get the compiled prepared statement\n$preparedStmt = $sugarQuery->compile();\n//Retrieve the Parameterized SQL\n$sql = $preparedStmt->getSQL();\n//Retrieve the parameters as an array\n$parameters = $preparedStmt->getParameters();\nArguments\nNo arguments\nReturns\nObject\nThe compiled SQL Query built by the SugarQuery object.\nTopicsSugarQuery ConditionsLearn about the various methods that can be utilized with SugarQuery to add conditional statements to a query.Advanced TechniquesLearn about some of the advanced methods that SugarQuery has to offer, that are not as commonly used.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/index.html"}
{"id": "6ba0a71f4c57-6", "text": "Last modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/index.html"}
{"id": "c07c7ba83dd9-0", "text": "SugarQuery Conditions\nOverview\nLearn about the various methods that can be utilized with SugarQuery to add conditional statements to a query.\u00c2\u00a0\nWhere Clause\nManipulating, the WHERE clause of a SugarQuery object is crucial for getting the correct results. To create a WHERE clause on the query, use the where() method on the SugarQuery object, as outlined in the SugarQuery documentation. Once you have the Where object, you can utilize the following methods on the Where object to add conditional statements.\nequals() | notEquals()\nUsed to equate a field to a given value. Wildcards will not work with this function, as it is looking for an exact match.\n//add equals\n$SugarQuery->where()->equals('name','Test');\n//add Not Equals\n$SugarQuery->where()->notEquals('name','Tester');\nArguments\nName\nType\nRequired\nDescription\n$field\nString\ntrue\nThe\u00c2\u00a0field you are checking against\u00c2\u00a0\n$value\nString\ntrue\nThe value the field should be equal to\nReturns\nSugarQuery_Builder_Where Object\nAllows for method chaining on the Where object to add additional conditions.\nequalsField() | notEqualsField()\nUsed to equate a field to another field in the result set.\n//add an Equals Field statement\n$SugarQuery->where()->equalsField('industry','account_type');\n//add a Not Equals Field statement\n$SugarQuery->where()->notEqualsField('name','account_type');\nArguments\nName\nType\nRequired\nDescription\n$field\nString\ntrue\nThe\u00c2\u00a0field you are checking against\u00c2\u00a0\n$field\nString\ntrue\nThe other field you want the first field to be equal to\nReturns\nSugarQuery_Builder_Where Object\nAllows for method chaining on the Where object to add additional conditions.\u00c2\u00a0\nisEmpty() | isNotEmpty()", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/SugarQuery_Conditions/index.html"}
{"id": "c07c7ba83dd9-1", "text": "isEmpty() | isNotEmpty()\nUsed to check if a field is or isn't empty.\n//add an isEmpty statement \n$SugarQuery->where()->isEmpty('industry'); \n//add an isNotEmpty statement \n$SugarQuery->where()->isNotEmpty('name');\nArguments\nName\nType\nRequired\nDescription\n$field\nString\ntrue\nThe\u00c2\u00a0field you are checking against\u00c2\u00a0\nReturns\nSugarQuery_Builder_Where Object\nAllows for method chaining on the Where object to add additional conditions.\u00c2\u00a0\nisNull() | notNull()\nUsed to check if a field is or isn't equal to NULL.\n//add an isNull statement \n$SugarQuery->where()->isNull('industry');\n \n//add a notNull statement \n$SugarQuery->where()->notNull('name');\nArguments\nName\nType\nRequired\nDescription\n$field\nString\ntrue\nThe\u00c2\u00a0field you are checking against\u00c2\u00a0\nReturns\nSugarQuery_Builder_Where Object\nAllows for method chaining on the Where object to add additional conditions.\u00c2\u00a0\ncontains() | notContains()\nUsed to check if a field has or doesn't have a specified string in its value. Utilizes the LIKE statement, and wildcards on both sides of the provided string.\n//add an isNull statement \n$SugarQuery->where()->contains('name','Test');\n//add a notNull statement \n$SugarQuery->where()->notContains('industry','Test');\nArguments\nName\nType\nRequired\nDescription\n$field\nString\ntrue\nThe\u00c2\u00a0field you are checking against\u00c2\u00a0\n$value\nString\ntrue\nThe string\u00c2\u00a0being searched for in the value of the field\nReturns\nSugarQuery_Builder_Where Object\nAllows for method chaining on the Where\u00c2\u00a0Object to add additional conditions.\u00c2\u00a0\nstarts() | ends()", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/SugarQuery_Conditions/index.html"}
{"id": "c07c7ba83dd9-2", "text": "starts() | ends()\nSimilar to the above contains() method, these\u00c2\u00a0methods use the LIKE statement in the SQL query and wildcards for searching for a specified string in the field's value. However,\u00c2\u00a0the starts() and ends() methods only wildcard the right side and the left side, respectively. The following example demonstrates searching for records where the Name field starts with A, and ends with E.\n//add an starts and ends statement \n$SugarQuery->where()->starts('name','A')->ends('name','e');\nArguments\nName\nType\nRequired\nDescription\n$field\nString\ntrue\nThe\u00c2\u00a0field you are checking against\u00c2\u00a0\n$value\nString\ntrue\nThe string\u00c2\u00a0being searched for in the value of the field\nReturns\nSugarQuery_Builder_Where Object\nAllows for method chaining on the Where object to add additional conditions.\u00c2\u00a0\nin() | notIn()\nUsed to check if a field's value is or isn't one of a set of specified values. The following examples look\u00c2\u00a0for records where the industry field\u00c2\u00a0is in a list of values, and not in a separate list of values.\n$values = array(\n    'Support',\n    'Sales',\n    'Engineering'\n);\n//add in statement\n$SugarQuery->where()->in('industry',$values);\n$values = array(\n    'Marketing',\n    'Accounting'\n);\n//add NotIn Statement\n$SugarQuery->where()->notIn('industry',$values);\nArguments\nName\nType\nRequired\nDescription\n$field\nString\ntrue\nThe\u00c2\u00a0field you are checking\u00c2\u00a0\n$values\nArray\ntrue\nThe array of values which the field is being checked against\nReturns\nSugarQuery_Builder_Where Object\nAllows for method chaining on the Where object to add additional conditions.\u00c2\u00a0\nbetween()", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/SugarQuery_Conditions/index.html"}
{"id": "c07c7ba83dd9-3", "text": "Allows for method chaining on the Where object to add additional conditions.\u00c2\u00a0\nbetween()\nUsed primarily for numeric type fields, to check if the value is greater than the minimum number specified\u00c2\u00a0and less than the maximum number specified. The following code would check for records where the employees field is between 50 and 1000.\n//add Between statement\n$SugarQuery->where()->between('employees',50,1000);\nArguments\nName\nType\nRequired\nDescription\n$field\nString\ntrue\nThe\u00c2\u00a0field you are checking against\u00c2\u00a0\n$min\nNumber\ntrue\nThe lowest number the field's value should be\n$max\nNumber\ntrue\nThe highest number the field's value should be\nReturns\nSugarQuery_Builder_Where Object\nAllows for method chaining on the Where object to add additional conditions.\u00c2\u00a0\nlt() | lte() | gt() | gte()\nThese methods\u00c2\u00a0are primarily for numeric fields, to check if a field's value is less than (<), less than or equal (<=), greater than (>), or greater than or equal (>=) to a specified value.\n//Add Less Than Statement\n$SugarQuery->where()->lt('gross_revenue',1000000);\n//Add Less Than or Equal to Statement\n$SugarQuery->where()->lte('net_revenue','500000');\n//Add Greater Than Statement\n$SugarQuery->where()->gt('gross_revenue',500000);\n//Add Greater Than or Equal to Statement\n$SugarQuery->where()->gte('net_revenue',100000);\nArguments\nName\nType\nRequired\nDescription\n$field\nString\ntrue\nThe\u00c2\u00a0field you are checking against\u00c2\u00a0\n$value\nNumber\ntrue\nThe numeric value for comparison\u00c2\u00a0\nReturns\nSugarQuery_Builder_Where Object\nAllows for method chaining on the Where object to add additional conditions.\u00c2", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/SugarQuery_Conditions/index.html"}
{"id": "c07c7ba83dd9-4", "text": "Allows for method chaining on the Where object to add additional conditions.\u00c2\u00a0\ndateRange()\nUsed to check if a field's value is between\u00c2\u00a0a preset date range from the current time. See the TimeDate documentation on the available date range keys.\n//add DateRange statement\n$SugarQuery->where()->dateRange('date_modified','last_30_days');\nArguments\nName\nType\nRequired\nDescription\n$field\nString\ntrue\nThe\u00c2\u00a0field you are checking against\u00c2\u00a0\n$value\nString\ntrue\nThe string\u00c2\u00a0specifying the date range key that will be used for comparison. Example\u00c2\u00a0'next_7_days'\nReturns\nSugarQuery_Builder_Where Object\nAllows for method chaining on the Where object to add additional conditions.\u00c2\u00a0\ndateBetween()\nTo group the query on a field, you can use the corresponding groupBy() method. This method can be called multiple times, to add multiple fields to the grouping of the query.\n//add group by\n$SugarQuery->where()->dateBetween('date_created',array('2016-01-01','2016-03-01'));\nArguments\nName\nType\nRequired\nDescription\n$field\nString\ntrue\nThe\u00c2\u00a0field you are checking against\u00c2\u00a0\n$value\nArray\ntrue\nAn array containing the minimum date in the first key, and the maximum date in the second.\nReturns\nSugarQuery_Builder_Where Object\nAllows for method chaining on the Where\u00c2\u00a0Object to add additional conditions.\u00c2\u00a0\nCombinations", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/SugarQuery_Conditions/index.html"}
{"id": "c07c7ba83dd9-5", "text": "Combinations\nNow that you have reviewed all of the available conditional statements for SugarQuery, you may want to combine them using AND and OR all within the same query. By default when the where() method is called, chained conditional methods will be added with AND to the where clause. You can specify an OR where clause on the main SugarQuery object by using the orWhere() method, which works the same as the where() method, just adds conditional statements with OR instead. The following methods allow for adding internal AND and OR logic to conditional statements on the Where object.\nqueryAnd()\nTo start a group of conditional statements that should all\u00c2\u00a0evaluate to True, use the queryAnd() method.\u00c2\u00a0For example, if you want to query for Accounts, where the name contains 'Test' AND description contains 'Test', you might use the following code:\n$SugarQuery = new SugarQuery();\n$SugarQuery->select(array('name'));\n$SugarQuery->from(BeanFactory::newBean('Accounts'));\n//Using queryAnd \n$SugarQuery->where()->queryAnd()->contains('name','Test')->contains('description','Test');\nThe above use of queryAnd() method isn't entirely needed, as the main Where object would be using AND for all conditions anyway, but it does group the two conditions inside of their own parenthesis in the compiled query, as shown below, to demonstrate how it can be used for altering query logic.\nSELECT  accounts.name name FROM accounts WHERE accounts.deleted = 0 AND (accounts.name LIKE '%Test%' AND accounts.description LIKE '%Test%')\nqueryOr()\nTo start a group of conditional statements that should evaluate to true, if any condition is true, you can use the queryOr() method. For example, if you want to query for Accounts, where the name contains 'Test' or where the description contains 'Test', you might use the following code:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/SugarQuery_Conditions/index.html"}
{"id": "c07c7ba83dd9-6", "text": "$SugarQuery = new SugarQuery(); \n$SugarQuery->select(array('name')); \n$SugarQuery->from(BeanFactory::newBean('Accounts')); \n//Using queryOr \n$SugarQuery->where()->queryOr()->contains('name','Test')->contains('description','Test');\nThis will group the two conditions inside of their own parenthesis in the compiled query.\u00c2\u00a0If either\u00c2\u00a0of the conditions is\u00c2\u00a0True, it will return a record. An example is shown below.\nSELECT  accounts.name name FROM accounts WHERE accounts.deleted = 0 AND (accounts.name LIKE '%Test%' OR accounts.description LIKE '%Test%')\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/SugarQuery_Conditions/index.html"}
{"id": "5e4d4d2e78f6-0", "text": "Advanced Techniques\nOverview\nLearn about some of the advanced methods that SugarQuery has to offer, that are not as commonly used.\nGet First Record\nGetting the first record in a result set, can be accomplished by using the limit() method. The getOne() method is similar in that it gets the first record, but it also returns the first piece of data for that record.\u00c2\u00a0\ngetOne()\nGet the first piece of data on the first record returned by the generated query. In this example, we want the 'name' from the Account with a given ID.\n$SugarQuery = new SugarQuery();\n$SugarQuery->select(array('name'));\n$SugarQuery->from(BeanFactory::newBean('Accounts'));\n$SugarQuery->where()->equals('id',$id);\n//Get the Name of the account\n$accountName = $SugarQuery->getOne();\nAggregates\nsetCountQuery()\nCurrently, the only method available for creating an aggregate column, is the setCountQuery() method on the SugarQuery_Builder_Select Object. You can add this method to your select() method chain, to add count(0) as record_count to the SQL SELECT statement.\n$SugarQuery = new SugarQuery();\n$SugarQuery->select(array('name'))->setCountQuery();\n$SugarQuery->from(BeanFactory::newBean('Accounts'));\n$SugarQuery->groupByRaw('accounts.name');\nThe above example will output the following prepared statement when using compile():\nSELECT accounts.name, COUNT(0) AS record_count FROM accounts WHERE accounts.deleted = ? GROUP BY accounts.name, accounts.name\nParameters\narray (\n    [1] => 0\n)\nArguments\nNo arguments\nReturns\nSugarQuery_Builder_Select Object\nAllows for method chaining on the Select\u00c2\u00a0Object.\nJoins", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/Advanced_Techniques/index.html"}
{"id": "5e4d4d2e78f6-1", "text": "Allows for method chaining on the Select\u00c2\u00a0Object.\nJoins\nJoining to tables and joining via SugarBean relationships is outlined in the SugarQuery documentation, however the SugarQuery_Builder_Join Object has a few helpful methods not mentioned there.\njoinName()\nIf you are not using a custom alias for the relationship or table, you may want to retrieve the generated name used by SugarQuery to add a conditions or join to.\n$SugarQuery = new SugarQuery();\n$SugarQuery->from(BeanFactory::getBean('Accounts'));\n$contacts = $SugarQuery->join('contacts')->joinName();\n$SugarQuery->select(array(\"$contacts.full_name\"));\n$SugarQuery->where()->equals('industry', 'Media');\nThe above example will output the following prepared statement when using compile():\nSELECT jt0_contacts.salutation rel_full_name_salutation, jt0_contacts.first_name rel_full_name_first_name, jt0_contacts.last_name rel_full_name_last_name FROM accounts INNER JOIN accounts_contacts jt1_accounts_contacts ON (accounts.id = jt1_accounts_contacts.account_id) AND (jt1_accounts_contacts.deleted = ?) INNER JOIN contacts jt0_contacts ON (jt0_contacts.id = jt1_accounts_contacts.contact_id) AND (jt0_contacts.deleted = ?) WHERE (accounts.industry = ?) AND (accounts.deleted = ?)\nParameters:\narray (\n    [1] => 0\n    [2] => 0\n    [3] => Media\n    [4] => 0\n)\n\u00c2\u00a0\nArguments\nNo arguments\nReturns\nstring\nThe name used in Query to identify the joined table\nUnions\nUnions allow joining multiple queries with the same selected fields to be combined during output. You can use Unions in SugarQuery by using the union() method.\nunion()", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/Advanced_Techniques/index.html"}
{"id": "5e4d4d2e78f6-2", "text": "union()\nTo add a union, you can use the corresponding union() method. The example below will join two SQL queries:\n//Fetch the bean of the module to query\n$bean = BeanFactory::newBean('Accounts');\n//Specify fields to fetch\n$fields = array(\n    'id',\n    'name'\n);\n//Create first query\n$sq1 = new SugarQuery();\n$sq1->select($fields);\n$sq1->from($bean, array('team_security' => false));\n$sq1->Where()->in('account_type', array('Customer'));\n//Create second query\n$sq2 = new SugarQuery();\n$sq2->select($fields);\n$sq2->from($bean, array('team_security' => false));\n$sq2->Where()->in('account_type', array('Investor'));\n//Create union\n$sqUnion = new SugarQuery();\n$sqUnion->union($sq1);\n$sqUnion->union($sq2);\n$sqUnion->limit(5);\nThe above example will output the following prepared statement when using compile():\nSELECT accounts.id, accounts.name FROM accounts WHERE (accounts.account_type IN (?)) AND (accounts.deleted = ?) UNION ALL SELECT accounts.id, accounts.name FROM accounts WHERE (accounts.account_type IN (?)) AND (accounts.deleted = ?) LIMIT 5\nParameters:\narray (\n    [1] => Customer\n    [2] => 0\n    [3] => Investor\n    [4] => 0\n)\nArguments\nName\nType\nRequired\nDescription\n$select\u00c2\u00a0\nSugarQuery\ntrue\nThe SugarQuery Object you wish to add to the UNION query\n$all\nBoolean\nfalse\nWhether to use UNION ALL or just UNION in the query. The default value is TRUE.\nReturns\nSugarQuery_Builder_Union Object", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/Advanced_Techniques/index.html"}
{"id": "5e4d4d2e78f6-3", "text": "Returns\nSugarQuery_Builder_Union Object\nAllows for method chaining on the Union\u00c2\u00a0Object.\nHaving\nWhen using aggregates in a query, you might want to filter out values based on a condition. SugarQuery provides the having() method for adding HAVING clause to the query.\nhaving()\nTo use the having() method, you have to build a SugarQuery_Builder_Condition Object and set the field, operator, and value that condition is based on.\n$SugarQuery = new SugarQuery();\n$SugarQuery->from(BeanFactory::getBean('Accounts'));\n$SugarQuery->join('contacts', array('alias' => 'industryContacts'));\n$SugarQuery->join('opportunities', array('relatedJoin' => 'industryContacts', 'alias' => 'contactsOpportunities'));\n$SugarQuery->select()->setCountQuery();\n$SugarQuery->where()->equals('contactsOpportunities.sales_stage', 'closed');\n$havingCondition = new SugarQuery_Builder_Condition($SugarQuery);\n$havingCondition->setField('contactsOpportunities.amount')->setOperator('>')->setValues('1000');\n$SugarQuery->having($havingCondition);\nThe above example will output the following prepared statement when using compile():", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/Advanced_Techniques/index.html"}
{"id": "5e4d4d2e78f6-4", "text": "The above example will output the following prepared statement when using compile():\nSELECT COUNT(0) AS record_count FROM accounts INNER JOIN accounts_contacts jt0_accounts_contacts ON (accounts.id = jt0_accounts_contacts.account_id) AND (jt0_accounts_contacts.deleted = ?) INNER JOIN contacts industryContacts ON (industryContacts.id = jt0_accounts_contacts.contact_id) AND (industryContacts.deleted = ?) INNER JOIN opportunities_contacts jt1_opportunities_contacts ON jt1_opportunities_contacts.deleted = ? INNER JOIN opportunities contactsOpportunities ON (contactsOpportunities.id = jt1_opportunities_contacts.opportunity_id) AND (contactsOpportunities.deleted = ?) WHERE (contactsOpportunities.sales_stage = ?) AND (accounts.deleted = ?) HAVING contactsOpportunities.amount > ?\nParameters:\narray (\n    [1] => 0\n    [2] => 0\n    [3] => 0\n    [4] => 0\n    [5] => closed\n    [6] => 0\n    [7] => 1000\n)\nArguments\nName\nType\nRequired\nDescription\n$condition\u00c2\u00a0\nSugarQuery_Builder_Condition\ntrue\nThe conditional object used to generate the HAVING clause\nReturns\nSugarQuery_Builder_Having Object\nAllows for method chaining on the Having\u00c2\u00a0Object to add additional conditions.\nRaw Methods\nThe SugarQuery Object has a few helper methods that allow raw SQL statement parts to be passed into. This allows for more complex statements or edge case scenarios where a helper function may not have met the requirements for the query.\u00c2\u00a0\nwhereRaw()", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/Advanced_Techniques/index.html"}
{"id": "5e4d4d2e78f6-5", "text": "whereRaw()\nTo add to the WHERE clause of SugarQuery Object with raw SQL syntax, you can utilize the whereRaw() method. This method will append the specified statement, to the WHERE clause using an AND operator, and will wrap the entire statement in parenthesis. The following is an example use with the output:\n$SugarQuery = new SugarQuery();\n$SugarQuery->select(array('name'));\n$SugarQuery->from(BeanFactory::newBean('Accounts'));\n$SugarQuery->whereRaw(\"name LIKE '%T%'\");\nThe above example will output the following prepared statement when using compile():\nSELECT accounts.name FROM accounts WHERE (name LIKE '%T%') AND (accounts.deleted = ?)\nParameters:\narray (\n    [1] => 0\n)\nArguments\nName\nType\nRequired\nDescription\n$sql\nString\ntrue\nThe\u00c2\u00a0WHERE clause SQL\u00c2\u00a0to be appended to the where clause on the SugarQuery object. All conditions passed in are wrapped in parenthesis and appended using AND (if other conditions exist on where clause).\nReturns\nSugarQuery_Builder_Where Object\nAllows for method chaining on the Where object.\ngroupByRaw()\nTo add multiple fields to the GROUP BY statement on the SugarQuery Object, it may be easiest to use the groupByRaw() method.\n$SugarQuery = new SugarQuery(); \n$SugarQuery->select(array('account_type', 'industry')); \n$SugarQuery->from(BeanFactory::newBean('Accounts'));\n$SugarQuery->groupByRaw(\"accounts.account_type,accounts.industry\");\nThe above example will output the following prepared statement when using compile():\nSELECT accounts.account_type, accounts.industry FROM accounts WHERE accounts.deleted = ? GROUP BY accounts.account_type,accounts.industry\nParameters:\narray (\n    [1] => 0\n)\nArguments\nName\nType\nRequired\nDescription\n$sql", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/Advanced_Techniques/index.html"}
{"id": "5e4d4d2e78f6-6", "text": ")\nArguments\nName\nType\nRequired\nDescription\n$sql\nString\ntrue\nThe GROUP BY statement, without the GROUP BY keyword.\u00c2\u00a0\nReturns\nSugarQuery Object\nAllows for method chaining on the SugarQuery Object.\norderByRaw()\nUsing the oderBy() method only allows for adding a single field to the SugarQuery object at a time. In some cases, you might consider using the orderByRaw() method to add multiple fields or the entire ORDER BY statement to the SugarQuery object.\u00c2\u00a0\n$SugarQuery = new SugarQuery();\n$SugarQuery->select(array('name'));\n$SugarQuery->from(BeanFactory::newBean('Accounts'));\n$SugarQuery->orderByRaw(\"accounts.name DESC, accounts.date_modified\");\nThe above example will output the following prepared statement when using compile():\nSELECT accounts.name FROM accounts WHERE accounts.deleted = ? ORDER BY accounts.name DESC, accounts.date_modified DESC, accounts.id DESC\nParameters:\narray (\n    [1] => 0\n)\nArguments\nName\nType\nRequired\nDescription\n$sql\nString\ntrue\nThe ORDER BY statement, without the ORDER BY keyword.\nReturns\nSugarQuery Object\nAllows for method chaining on the SugarQuery Object.\nhavingRaw()\nUsing the havingRaw() method allows for adding a having statement\u00c2\u00a0to the SugarQuery object.\u00c2\u00a0\n$SugarQuery = new SugarQuery();\n$SugarQuery->from(BeanFactory::getBean('Accounts'));\n$SugarQuery->join('contacts', array('alias' => 'industryContacts'));\n$SugarQuery->join('opportunities', array('relatedJoin' => 'industryContacts', 'alias' => 'contactsOpportunities'));\n$SugarQuery->select()->setCountQuery();\n$SugarQuery->where()->equals('contactsOpportunities.sales_stage', 'closed');", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/Advanced_Techniques/index.html"}
{"id": "5e4d4d2e78f6-7", "text": "$SugarQuery->where()->equals('contactsOpportunities.sales_stage', 'closed');\n$SugarQuery->havingRaw(\"contactsOpportunities.amount > 1000\");\nThe above example will output the following prepared statement when using compile():\nSELECT COUNT(0) AS record_count FROM accounts INNER JOIN accounts_contacts jt0_accounts_contacts ON (accounts.id = jt0_accounts_contacts.account_id) AND (jt0_accounts_contacts.deleted = ?) INNER JOIN contacts industryContacts ON (industryContacts.id = jt0_accounts_contacts.contact_id) AND (industryContacts.deleted = ?) INNER JOIN opportunities_contacts jt1_opportunities_contacts ON jt1_opportunities_contacts.deleted = ? INNER JOIN opportunities contactsOpportunities ON (contactsOpportunities.id = jt1_opportunities_contacts.opportunity_id) AND (contactsOpportunities.deleted = ?) WHERE (contactsOpportunities.sales_stage = ?) AND (accounts.deleted = ?) HAVING contactsOpportunities.amount > 1000\nParameters:\narray (\n    [1] => 0\n    [2] => 0\n    [3] => 0\n    [4] => 0\n    [5] => closed\n    [6] => 0\n)\nArguments\nName\nType\nRequired\nDescription\n$sql\nString\ntrue\nThe HAVING\u00c2\u00a0statement, without the HAVING\u00c2\u00a0keyword.\nReturns\nSugarQuery Object\nAllows for method chaining on the SugarQuery Object.\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Database/SugarQuery/Advanced_Techniques/index.html"}
{"id": "bea6643217df-0", "text": "Subpanels\nOverview\nFor Sidecar, Sugar's subpanel layouts have been modified to work as simplified metadata.\u00c2\u00a0This page is an\u00c2\u00a0overview of the metadata framework for subpanels.\u00c2\u00a0\nThe reason for this change is that previous versions of Sugar generated the metadata from various sources such as the SubPanelLayout and MetaDataManager classes. This eliminates the need for generating and processing the layouts and allows the metadata to be easily loaded to Sidecar.\nNote:\u00c2\u00a0Modules running in backward compatibility mode do not use the Sidecar subpanel layouts as they use the legacy MVC framework.\nHierarchy Diagram\nWhen loading the Sidecar subpanel layouts, the system processes the layout in the following manner:\nNote: The Sugar application's client type is \"base\". For more information on the various client types, please refer to\u00c2\u00a0the User Interface page.\nSubpanels and Subpanel Layouts\nSugar contains both a subpanels (plural) layout and a subpanel (singular) layout. The subpanels layout contains the collection of subpanels,\u00c2\u00a0whereas\u00c2\u00a0the subpanel layout renders the actual subpanel widget.\nAn example of a stock module's subpanels layout is:\n./modules/Bugs/clients/base/layouts/subpanels/subpanels.php\n<?php\n$viewdefs['Bugs']['base']['layout']['subpanels'] = array (\n  'components' => array (\n      array (\n          'layout' => 'subpanel',\n          'label' => 'LBL_DOCUMENTS_SUBPANEL_TITLE',\n          'context' => array (\n              'link' => 'documents',\n          ),\n      ),\n      array (\n          'layout' => 'subpanel',\n          'label' => 'LBL_CONTACTS_SUBPANEL_TITLE',\n          'context' => array (\n              'link' => 'contacts',\n          ),\n      ),\n      array (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Subpanels/index.html"}
{"id": "bea6643217df-1", "text": "'link' => 'contacts',\n          ),\n      ),\n      array (\n          'layout' => 'subpanel',\n          'label' => 'LBL_ACCOUNTS_SUBPANEL_TITLE',\n          'context' => array (\n              'link' => 'accounts',\n          ),\n      ),\n      array (\n          'layout' => 'subpanel',\n          'label' => 'LBL_CASES_SUBPANEL_TITLE',\n          'context' => array (\n              'link' => 'cases',\n          ),\n      ),\n  ),\n  'type' => 'subpanels',\n  'span' => 12,\n);\nYou can see that the layout incorporates the use of the subpanel layout for each module. As most of the subpanel data is similar, this approach allows us to use less duplicate code. The subpanel layout, shown below, shows the three views that make up the subpanel widgets users see.\n./clients/base/layouts/subpanel/subpanel.php\n<?php\n$viewdefs['base']['layout']['subpanel']  = array (\n    'components' => array (\n        array (\n            'view' => 'panel-top',\n        )\n        array (\n            'view' => 'subpanel-list',\n        ),\n        array (\n            'view' => 'list-bottom',\n        ),\n    ),\n    'span' => 12,\n    'last_state' => array(\n        'id' => 'subpanel'\n    ),\n);\nAdding Subpanel Layouts", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Subpanels/index.html"}
{"id": "bea6643217df-2", "text": "),\n);\nAdding Subpanel Layouts\nWhen a new relationship is deployed from Studio, the relationship creation process will generate the layouts using the extension framework. You should note that for stock relationships and custom deployed relationships, layouts are generated for both Sidecar and Legacy MVC Subpanel formats. This is done to ensure that any related modules, whether in Sidecar or Backward Compatibility mode, display a related subpanel as expected.\nSidecar Layouts\nCustom Sidecar layouts, located in ./custom/Extension/modules/<module>/Ext/clients/<client>/layouts/subpanels/, are compiled into ./custom/modules/<module>/Ext/clients/<client>/layouts/subpanels/subpanels.ext.php using the extension framework. When a relationship is saved, layout files are created for both the \"base\" and \"mobile\" client types.\nFor example, deploying a 1:M relationship from Bugs to Leads will generate the following Sidecar files:\n./custom/Extension/modules/Bugs/Ext/clients/base/layouts/subpanels/bugs_leads_1_Bugs.php\n<?php\n$viewdefs['Bugs']['base']['layout']['subpanels']['components'][] = array (\n  'layout' => 'subpanel',\n  'label' => 'LBL_BUGS_LEADS_1_FROM_LEADS_TITLE',\n  'context' =>\n  array (\n    'link' => 'bugs_leads_1',\n  ),\n);\n./custom/Extension/modules/Bugs/Ext/clients/mobile/layouts/subpanels/bugs_leads_1_Bugs.php\n<?php\n$viewdefs['Bugs']['mobile']['layout']['subpanels']['components'][] = array (\n  'layout' => 'subpanel',\n  'label' => 'LBL_BUGS_LEADS_1_FROM_LEADS_TITLE',\n  'context' =>\n  array (\n    'link' => 'bugs_leads_1',\n  ),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Subpanels/index.html"}
{"id": "bea6643217df-3", "text": "array (\n    'link' => 'bugs_leads_1',\n  ),\n);\nNote: The additional legacy MVC layouts generated by a relationships deployment are described below.\nLegacy MVC Subpanel Layouts\nCustom Legacy MVC Subpanel layouts, located in ./custom/Extension/modules/<module>/Ext/Layoutdefs/, are compiled into ./custom/modules/<module>/Ext/Layoutdefs/layoutdefs.ext.php using the extension framework. You should also note that when a relationship is saved, wireless layouts, located in ./custom/Extension/modules/<module>/Ext/WirelessLayoutdefs/, are created and compiled into ./custom/modules/<module>/Ext/Layoutdefs/layoutdefs.ext.php.\nAn example of this is when deploying a 1-M relationship from Bugs to Leads, the following layoutdef files are generated:\n./custom/Extension/modules/Bugs/Ext/Layoutdefs/bugs_leads_1_Bugs.php\n<?php\n$layout_defs[\"Bugs\"][\"subpanel_setup\"]['bugs_leads_1'] = array (\n  'order' => 100,\n  'module' => 'Leads',\n  'subpanel_name' => 'default',\n  'sort_order' => 'asc',\n  'sort_by' => 'id',\n  'title_key' => 'LBL_BUGS_LEADS_1_FROM_LEADS_TITLE',\n  'get_subpanel_data' => 'bugs_leads_1',\n  'top_buttons' =>\n  array (\n    0 =>\n    array (\n      'widget_class' => 'SubPanelTopButtonQuickCreate',\n    ),\n    1 =>\n    array (\n      'widget_class' => 'SubPanelTopSelectButton',\n      'mode' => 'MultiSelect',\n    ),\n  ),\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Subpanels/index.html"}
{"id": "bea6643217df-4", "text": "'mode' => 'MultiSelect',\n    ),\n  ),\n);\n./custom/Extension/modules/Bugs/Ext/WirelessLayoutdefs/bugs_leads_1_Bugs.php\n<?php\n$layout_defs[\"Bugs\"][\"subpanel_setup\"]['bugs_leads_1'] = array (\n  'order' => 100,\n  'module' => 'Leads',\n  'subpanel_name' => 'default',\n  'title_key' => 'LBL_BUGS_LEADS_1_FROM_LEADS_TITLE',\n  'get_subpanel_data' => 'bugs_leads_1',\n);\nFields Metadata\nSidecar's subpanel field layouts are initially defined by the subpanel list-view metadata.\nHierarchy Diagram\nThe subpanel list metadata is loaded in the following manner:\nNote: The Sugar application's client type is \"base\". For more information on the various client types, please refer to\u00c2\u00a0the User Interface page.\nSubpanel List Views\nBy default, all modules come with a default set of subpanel fields for when they are rendered as a subpanel. An example of this is can be found in the Bugs module:\n./modules/Bugs/clients/base/views/subpanel-list/subpanel-list.php\n<?php\n$subpanel_layout['list_fields'] = array (\n  'full_name' =>\n  array (\n    'type' => 'fullname',\n    'link' => true,\n    'studio' =>\n    array (\n      'listview' => false,\n    ),\n    'vname' => 'LBL_NAME',\n    'width' => '10%',\n    'default' => true,\n  ),\n  'date_entered' =>\n  array (\n    'type' => 'datetime',\n    'studio' =>\n    array (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Subpanels/index.html"}
{"id": "bea6643217df-5", "text": "'type' => 'datetime',\n    'studio' =>\n    array (\n      'portaleditview' => false,\n    ),\n    'readonly' => true,\n    'vname' => 'LBL_DATE_ENTERED',\n    'width' => '10%',\n    'default' => true,\n  ),\n  'refered_by' =>\n  array (\n    'vname' => 'LBL_LIST_REFERED_BY',\n    'width' => '10%',\n    'default' => true,\n  ),\n  'lead_source' =>\n  array (\n    'vname' => 'LBL_LIST_LEAD_SOURCE',\n    'width' => '10%',\n    'default' => true,\n  ),\n  'phone_work' =>\n  array (\n    'vname' => 'LBL_LIST_PHONE',\n    'width' => '10%',\n    'default' => true,\n  ),\n  'lead_source_description' =>\n  array (\n    'name' => 'lead_source_description',\n    'vname' => 'LBL_LIST_LEAD_SOURCE_DESCRIPTION',\n    'width' => '10%',\n    'sortable' => false,\n    'default' => true,\n  ),\n  'assigned_user_name' =>\n  array (\n    'name' => 'assigned_user_name',\n    'vname' => 'LBL_LIST_ASSIGNED_TO_NAME',\n    'widget_class' => 'SubPanelDetailViewLink',\n    'target_record_key' => 'assigned_user_id',\n    'target_module' => 'Employees',\n    'width' => '10%',\n    'default' => true,\n  ),\n  'first_name' =>\n  array (\n    'usage' => 'query_only',\n  ),\n  'last_name' =>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Subpanels/index.html"}
{"id": "bea6643217df-6", "text": "'usage' => 'query_only',\n  ),\n  'last_name' =>\n  array (\n    'usage' => 'query_only',\n  ),\n  'salutation' =>\n  array (\n    'name' => 'salutation',\n    'usage' => 'query_only',\n  ),\n);\nTo modify this layout, navigate to Admin > Studio > {Parent Module} > Subpanels > Bugs and make your changes. Once saved, Sugar will generate ./custom/modules/Bugs/clients/<client>/views/subpanel-for-<link>/subpanel-for-<link>.php which will be used for rendering the fields you selected.\nYou should note that, just as Sugar mimics the Sidecar layouts in the legacy MVC framework for modules in backward compatibility, it also mimics the field list in ./modules/<module>/metadata/subpanels/default.php and ./custom/modules/<module>/metadata/subpanels/default.php. This is done to ensure that any related modules, whether in Sidecar or Backward Compatibility mode, display the same field list as expected.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Subpanels/index.html"}
{"id": "4d892d78da0b-0", "text": "Models\nOverview\nEach module in Sugar is extending the\u00c2\u00a0Sugar Model. This model is determined by the SugarBean, which contains methods to create, read/retrieve, update, and delete records in the database and any subclass of the SugarBean. Many of the common Sugar modules also use the SugarObjects class, which is explained in the next section.\nSugarObject Templates\nSugar objects extend the concept of subclassing a step further and allow you to subclass the vardefs. This includes inheriting of fields, relationships, indexes, and language files. However, unlike subclassing, you are not limited to a single inheritance. For example, if there were a Sugar object for fields used in every module (e.g. id, deleted, or date_modified), you could have the module inherit from both the Basic Sugar object and the Person Sugar object.\nTo further illustrate this, let's say the Basic object type has a field 'name' with length 10 and the Company object has a field 'name' with length 20. If you inherit from Basic first and then Company, your field will inherit the Company object's length of 20. However, the module-level setting always overrides any values provided by Sugar objects, so, if the field 'name' in your module has been set to length 60, then the field's length will ultimately be 60.\nThere are six types of SugarObject templates:\nBasic : Contains the basic fields required by all Sugar modules\nPerson : Based on the Contacts, Prospects, and Leads modules\nIssue : Based on the Bugs and Cases modules\nCompany : Based on the Accounts module\nFile : Based on the Documents module\nSale : Based on the Opportunities module\nSugarObject Interfaces", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/index.html"}
{"id": "4d892d78da0b-1", "text": "File : Based on the Documents module\nSale : Based on the Opportunities module\nSugarObject Interfaces\nIn addition to the object templates above, \"assignable\" object templates can be\u00c2\u00a0used for modules with records that should contain an Assigned To field. Although every module does not use this, most modules allow assignment of records to users. SugarObject interfaces allow us to add the assignable attribute to these modules.\nSugarObject interfaces and SugarObject templates are very similar to one another, but the main distinction is that templates have a base class you can subclass while interfaces do not. If you look into the file structure, templates include many additional files, including a full metadata directory. This is used primarily for Module Builder.\nFile Structure\n./include/SugarObjects/interfaces\n./include/SugarObjects/templates\nImplementation\nThere are two things you need to do to take advantage of Sugar\u00c2\u00a0objects:\nSubclass the SugarObject class you wish to extend for your class:class MyClass extends Person\n{\n    function MyClass()\n    {\n        parent::Person();\n    }\n}\nAdd the following line to the end of the\u00c2\u00a0vardefs.php file:VardefManager::createVardef('Contacts', 'Contact', array('default', 'assignable', 'team_security', 'person'));\nThis snippet tells the VardefManager to create a cache of the Contacts vardefs with the addition of all the default fields, assignable fields, team security fields, and all fields from the person class.\nPerformance Considerations\nVardefManager caches the generated vardefs into a single file that is loaded at runtime. If that file is not found, Sugar\u00c2\u00a0loads the vardefs.php file, located in your module's directory. The same is true for language files. This caching also includes data for custom fields and any vardef or language extensions that are dropped into the extension framework.\nCache Files", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/index.html"}
{"id": "4d892d78da0b-2", "text": "Cache Files\n./cache/modules/<module>/<object_name>vardefs.php\n./cache/modules/<module>/languages/en_us.lang.php\nTopicsSugarBean$bean = BeanFactory::retrieveBean($module, $id);BeanFactoryThe BeanFactory class, located in ./data/BeanFactory.php, is used for loading an instance of a SugarBean. This class should be used any time you are creating or retrieving bean objects. It will automatically handle any classes required for the bean.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/index.html"}
{"id": "de30369e5c75-0", "text": "SugarBean\n//Retrieve bean\n$bean = BeanFactory::retrieveBean($module, $id);\n//Set deleted to true\n$bean->mark_deleted($bean->id);\n//Save\n$bean->save();\nOverview\nThe SugarBean class supports all the model operations to and from the database. Any module that interacts with the database utilizes the SugarBean class, which contains methods to create, read/retrieve, update, and delete records in the database (CRUD), as well as fetch related records.\nCRUD Handling\nThe SugarBean handles the most basic functions of the Sugar database, allowing you to create, retrieve, update, and delete data.\u00c2\u00a0\nCreating and Retrieving Records\nThe BeanFactory class is used for bean loading. The class should be used whenever\u00c2\u00a0you are creating or retrieving bean objects. It will automatically handle any classes required for the bean. More information on this can be found in the BeanFactory section.\nObtaining the Id of a Recently Saved Bean\nFor new records, a GUID is generated and assigned to the record id field. Saving new or existing records returns a single value to the calling routine, which is the id attribute of the saved record. The id has the following format:\naaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\nYou can retrieve a newly created record's id with the following:\n//Create bean\n$bean = BeanFactory::newBean($module);\n//Populate bean fields\n$bean->name = 'Example Record';\n//Save\n$bean->save();\n//Retrieve the bean id\n$record_id = $bean->id;\nSaving a Bean with a Specific ID", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/index.html"}
{"id": "de30369e5c75-1", "text": "$record_id = $bean->id;\nSaving a Bean with a Specific ID\nSaving a record with a specific id requires the id and new_with_id attribute of the bean to be set. When doing so, it is important that you use a globally unique identifier. Failing to do so may result in unexpected behavior in the system. An example setting an id is shown below:\n//Create bean\n$bean = BeanFactory::newBean($module);\n//set the new flag\n$bean->new_with_id = true;\n//Set the record id with a static id\n$id = '38c90c70-7788-13a2-668d-513e2b8df5e1';\n$bean->id = $id;\n//or have the system generate an id for you\n//$id = Sugarcrm\\Sugarcrm\\Util\\Uuid::uuid1()\n//$bean->id = $id;\n//Populate bean fields\n$bean->name = 'Example Record';\n//Save\n$bean->save();\nSetting new_with_id to true prevents the save method from creating a new id value and uses the assigned id attribute. If the id attribute is empty and the new_with_id attribute is set to true, the save will fail. If you would like for the system to generate an id for you, you can use Sugarcrm\\Sugarcrm\\Util\\Uuid::uuid1().\nDistinguishing New from Existing Records\nTo identify whether or not a record is new or existing, you can check the fetched_rows property. If the $bean has a fetched_row, it was loaded from the database. An example is shown below:\nif (!isset($bean->fetched_row['id'])) {\n    //new record\n} else {\n    //existing record\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/index.html"}
{"id": "de30369e5c75-2", "text": "//new record\n} else {\n    //existing record\n}\nIf you are working with a logic hook such as before_save or after_save, you should check the arguments.isUpdate property to determine this as shown below:\n<?php\nif (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nclass logic_hooks_class\n{\n    function hook_method($bean, $event, $arguments)\n    {\n        if (isset($arguments['isUpdate']) && $arguments['isUpdate'] == false) {\n            //new record\n        } else {\n            //existing record\n        }\n    }\n}\n?>\nRetrieving a Bean by Unique Field\nSometimes developers have a need to fetch a record based on a unique field other than the id. In previous versions you were able to use the\u00c2\u00a0retrieve_by_string_fields()\u00c2\u00a0method to accomplish\u00c2\u00a0this, however, that has now been deprecated. To search and\u00c2\u00a0fetch records,\u00c2\u00a0you should\u00c2\u00a0use the SugarQuery\u00c2\u00a0builder. An example of this is shown below:\nrequire_once('include/SugarQuery/SugarQuery.php');\n$sugarQuery = new SugarQuery();\n//fetch the bean of the module to query\n$bean = BeanFactory::newBean('<modules>');\n//create first query\n$sql = new SugarQuery();\n$sql->select('id');\n$sql->from($bean);\n$sql->Where()->equals('<field>', '<unique value>');\n$result = $sql->execute();\n$count = count($result);\nif ($count == 0) {\n    //no results were found\n} elseif ($count == 1) {\n    //one result was found\n    $bean = BeanFactory::getBean('<module>', $result[0]['id']);\n} else {\n    //multiple results were found\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/index.html"}
{"id": "de30369e5c75-3", "text": "} else {\n    //multiple results were found\n}\nUpdating a Bean\nYou can update\u00c2\u00a0a bean by fetching a record and then updating the property:\n//Retrieve bean\n$bean = BeanFactory::retrieveBean($module, $id);\n//Fields to update\n$bean->name = 'Updated Name';\n//Save\n$bean->save();\nNote: Disabling row-level security when accessing a bean should be set to true\u00c2\u00a0only when it is absolutely necessary to bypass security, for example, when updating a Lead record from a custom Entry Point.\u00c2\u00a0An example of accessing the bean while bypassing row security is:\n$bean = BeanFactory::retrieveBean($module, $record_id, array('disable_row_level_security' => true));\nUpdating a Bean Without Changing the Date Modified\nThe SugarBean class contains an attribute called update_date_modified, which is set to true when the class is instantiated and means that the date_modified attribute is updated to the current database date timestamp. Setting\u00c2\u00a0update_date_modified to false would result in the date_modified attribute not being set with the current database date timestamp.\n//Retrieve bean\n$bean = BeanFactory::retrieveBean($module, $id);\n//Set modified flag\n$bean->update_date_modified = false;\n//Fields to update\n$bean->name = 'Updated Name';\n//Save\n$bean->save();\nNote: Disabling row-level security when accessing a bean should be set to true\u00c2\u00a0only when it is absolutely necessary to bypass security, for example, when updating a Lead record from a custom Entry Point.\u00c2\u00a0An example of accessing the bean while bypassing row security is:\n$bean = BeanFactory::retrieveBean($module, $record_id, array('disable_row_level_security' => true));\nDeleting a Bean", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/index.html"}
{"id": "de30369e5c75-4", "text": "Deleting a Bean\nDeleting a bean can be done by fetching it then calling the\u00c2\u00a0mark_deleted()\u00c2\u00a0method which makes sure any relationships with related records are removed\u00c2\u00a0as well:\n//Retrieve bean\n$bean = BeanFactory::retrieveBean($module, $id);\n//Set deleted to true\n$bean->mark_deleted($id);\n//Save\n$bean->save();\nNote: Disabling row-level security when accessing a bean should be set to true\u00c2\u00a0only when it is absolutely necessary to bypass security, for example, when updating a Lead record from a custom Entry Point.\u00c2\u00a0An example of accessing the bean while bypassing row security is:\n$bean = BeanFactory::retrieveBean($module, $record_id, array('disable_row_level_security' => true));\nFetching Relationships\nThis section\u00c2\u00a0explains how the\u00c2\u00a0SugarBean class can be used to fetch related information from the database.\nFetching Related Records\nTo fetch related records, load the relationship using the link:\n//If relationship is loaded\nif ($bean->load_relationship($link)) {\n    //Fetch related beans\n    $relatedBeans = $bean->$link->getBeans();\n}\nAn example of this is to load the contacts related to an account:\n//Load Account\n$bean = BeanFactory::getBean('Accounts', $id);\n//If relationship is loaded\nif ($bean->load_relationship('contacts')) {\n    //Fetch related beans\n    $relatedBeans = $bean->contacts->getBeans();\n}\nFetching Related Record IDs\nTo fetch only related record IDs, load the relationship using the link:\n//If relationship is loaded\nif ($bean->load_relationship($link)) {\n    //Fetch related record IDs\n    $relatedBeans = $bean->$link->get();\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/index.html"}
{"id": "de30369e5c75-5", "text": "$relatedBeans = $bean->$link->get();\n}\nAn example of this is to load the record IDs of contacts related to an account:\n//Load Account\n$bean = BeanFactory::getBean('Accounts', $id);\n//If relationship is loaded\nif ($bean->load_relationship('contacts')) {\n    //Fetch related beans\n    $relatedBeans = $bean->contacts->get();\n}\nFetching a Parent Record\nFetching a parent record is similar to fetching child records in that you will still need to load the relationship using the link:\n//If relationship is loaded\nif ($bean->load_relationship($link)) {\n    //Fetch related beans\n    $relatedBeans = $bean->$link->getBeans();\n    $parentBean = false;\n    if (!empty($relatedBeans)) {\n        //order the results\n        reset($relatedBeans);\n        //first record in the list is the parent\n        $parentBean = current($relatedBeans);\n    }\n}\nAn example of this is to load a contact and fetch its parent account:\n//Load Contact\n$bean = BeanFactory::getBean('Contacts', $id);\n//If relationship is loaded\nif ($bean->load_relationship('accounts')) {\n    //Fetch related beans\n    $relatedBeans = $bean->accounts->getBeans();\n    $parentBean = false;\n    if (!empty($relatedBeans)) {\n        //order the results\n        reset($relatedBeans);\n        //first record in the list is the parent\n        $parentBean = current($relatedBeans);\n    }\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/index.html"}
{"id": "de30369e5c75-6", "text": "$parentBean = current($relatedBeans);\n    }\n}\nTopicsCustomizing Core SugarBeansThis article covers how to extend core SugarBean objects to implement custom code. This can be used to alter the stock assignment notification message or to add logic to change the default modules behavior.Implementing Custom SugarBean TemplatesThis article covers how to implement custom SugarBean templates, which can then be extended by custom modules. It also covers vardef templates, which can more portable and used by multiple modules. By default, Sugar comes with a few templates such as Company, Person, Issue, and File templates.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/index.html"}
{"id": "940b70070615-0", "text": "Customizing Core SugarBeans\nOverview\nThis article covers how to extend core SugarBean objects to implement custom code. This can be used to alter the stock assignment notification message or to\u00c2\u00a0add logic to change the\u00c2\u00a0default modules behavior.\nCustomizing a Core Module\nThe best approach to customizing a core SugarBean object is to become familiar with how the core Bean operates and only modify the bean logic where absolutely necessary. After understanding where you wish to make your customization in the module Bean class, you can extend the class in the custom directory.\u00c2\u00a0In order to avoid duplicating code from the core Bean class, it is always best to extend the class rather than duplicate the class to the custom directory.\u00c2\u00a0\nExtending the SugarBean\nFor this example, we will look at modifying the Leads SugarBean object. To extend the core Leads bean, create the following file:\n./custom/modules/Leads/CustomLead.php\n<?php\nrequire_once 'modules/Leads/Lead.php';\nclass CustomLead extends Lead\n{\n    /**\n     * Saves the record\n     * - You can use this method to implement before save or after save logic\n     *\n     * @param bool $check_notify\n     * @return string\n     */\n    function save($check_notify = FALSE)\n    {\n        $id = parent::save($check_notify);\n        return $id;\n    }\n    /**\n     * Retrieves a record\n     * - You can use this method to set properties when fetching a bean\n     *\n     * @param string $id\n     * @param bool $encode\n     * @param bool $deleted\n     * @return $this\n     */\n    function retrieve($id = '-1', $encode = true, $deleted = true)\n    {\n        return parent::retrieve($id, $encode, $deleted);\n    }", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/Customizing_Core_SugarBeans/index.html"}
{"id": "940b70070615-1", "text": "return parent::retrieve($id, $encode, $deleted);\n    }\n    /**\n     * Calls custom logic events\n     * - You can use this method to watch for specific logic hook events\n     *\n     * @param $event\n     * @param array $arguments\n     */\n    function call_custom_logic($event, $arguments = array())\n    {\n        parent::call_custom_logic($event, $arguments);\n    }\n}\nRegister the Custom Class\nOnce the custom SugarBean class file has been created, register that class to be used by the module so that the BeanFactory knows which class to use. To register the class you will create the following file in the ./custom/Extension/ directory:\n./custom/Extension/application/Ext/Include/customLead.php\n<?php\n/**\n* The $objectList array, maps the module name to the Vardef property\n* By default only a few core modules have this defined, since their Class/Object names differs from their Vardef Property\n**/\n$objectList['Leads'] = 'Lead';\n// $beanList maps the Bean/Module name to the Class name\n$beanList['Leads'] = 'CustomLead';\n// $beanFiles maps the Class name to the PHP Class file\n$beanFiles['CustomLead'] = 'custom/modules/Leads/CustomLead.php';\nNote:\u00c2\u00a0The $objectList\u00c2\u00a0array only needs to be set on those modules that do not have it set already. You can view ./include/modules.php to see the core modules that have it defined already.\nOnce the registration file is in place, go to Admin > Repairs, and run a Quick Repair and Rebuild so that the system starts using the custom class.\nThings to Note\nOverriding a core SugarBean class comes with some caveats:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/Customizing_Core_SugarBeans/index.html"}
{"id": "940b70070615-2", "text": "Things to Note\nOverriding a core SugarBean class comes with some caveats:\nThe custom class is only used when the product core code uses the\u00c2\u00a0BeanFactory.\u00c2\u00a0\nFor most circumstances, Sugar is set up to use BeanFactory, however, legacy code or specific logic that is pairs core modules together may use direct calls to a core SugarBean class, which would then cause the custom class to not be used. In those scenarios,\u00c2\u00a0it is recommended to use a logic look instead.\nExtending the Cases module doesn't affect the email Import process.\nIf the\u00c2\u00a0$objectList\u00c2\u00a0property is not defined for the module, the custom object will be used, however, things like Studio will no longer work correctly.\nFor the example above, we defined the $objectList property for the Leads module to make sure that Studio continued working as expected. Without this definition, if you navigate to Admin > Studio, fields and relationships will not render properly.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/Customizing_Core_SugarBeans/index.html"}
{"id": "8964a443506b-0", "text": "Implementing Custom SugarBean Templates\nOverview\nThis article covers how to implement custom SugarBean templates, which can then be extended by custom modules. It also covers vardef templates, which can more portable and used by multiple modules. By default, Sugar comes with a few templates such as Company, Person, Issue, and File templates.\nCreating a Custom SugarBean Template\nThe following example will create a custom Bean template that can be used by custom modules to shrink down the overall size of the Bean model, by only implementing the two fields required by all modules, the id field and the deleted field. In order to do this, we will have to override some core SugarBean methods, as the base SugarBean is statically configured to do things like Save/Delete the model with the date_entered, date_modified, modified_user_id and created_user_id fields. In order to accommodate custom Beans that wish to use those fields, this template will also have properties for configuring those types of fields so that they are populated using the default SugarBean logic.\nTo create a template for use by custom modules, you create a class that extends from SugarBean in\u00c2\u00a0./custom/include/SugarObjects/templates/<template_name>/<class_name>.php. For this example, we will create the \"bare\" template with the following file:\n./custom/include/SugarObjects/templates/bare/BareBean.php\n<?php\nclass BareBean extends SugarBean\n{\n    /**\n     * The configured modified date field\n     * @var string|false\n     */\n    protected $_modified_date_field = false;\n    /**\n     * The configured modified user field\n     * @var string|false\n     */\n    protected $_modified_user_field = false;\n    /**\n     * The configured created date field\n     * @var string|false\n     */\n    protected $_created_date_field = false;\n    /**\n     * The configured created user field", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/Implementing_Custom_SugarBean_Templates/index.html"}
{"id": "8964a443506b-1", "text": "/**\n     * The configured created user field\n     * @var string|false\n     */\n    protected $_created_user_field = false;\n    /**\n     * Get the field name where modified date is stored, if in use by Module\n     * @return string|false\n     */\n    public function getModifiedDateField()\n    {\n        if ($this->_modified_date_field !== FALSE){\n            $field = $this->_modified_date_field;\n            if (isset($this->field_defs[$field]) && $this->field_defs[$field]['type'] == 'datetime'){\n                return $field;\n            }\n        }\n        return FALSE;\n    }\n    /**\n     * Override the stock setModifiedDate method\n     *  - Check that field is in use by this Module\n     *  - If in use, set the configured field to current time\n     * @inheritdoc\n     **/\n    public function setModifiedDate($date = '')\n    {\n        global $timedate;\n        $field = $this->getModifiedDateField();\n        if ($field !== FALSE){\n            // This code was duplicated from the stock SugarBean::setModifiedDate\n            if ($this->update_date_modified || empty($this->$field)) {\n                // This only needs to be calculated if it is going to be used\n                if (empty($date)) {\n                    $date = $timedate->nowDb();\n                }\n                $this->$field = $date;\n            }\n        }\n    }\n    /**\n     * Get the field name where modified user ID is stored, if in use by Module\n     * @return string|false\n     **/\n    public function getModifiedUserField()\n    {\n        if ($this->_modified_user_field !== FALSE){", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/Implementing_Custom_SugarBean_Templates/index.html"}
{"id": "8964a443506b-2", "text": "{\n        if ($this->_modified_user_field !== FALSE){\n            $field = $this->_modified_user_field;\n            if (isset($this->field_defs[$field]) && $this->field_defs[$field]['type'] == 'assigned_user_name'){\n                return $field;\n            }\n        }\n        return FALSE;\n    }\n    /**\n     * Override the stock setModifiedUser Method\n     * - Check that field is in use by this Module\n     * - If in use, set the configured field to user_id\n     * @inheritdoc\n     * @param User|null $user [description]\n     */\n    public function setModifiedUser(User $user = null)\n    {\n        global $current_user;\n        $field = $this->getModifiedUserField();\n        if ($field !== FALSE){\n            // If the update date modified by flag is set then carry out this directive\n            if ($this->update_modified_by) {\n                // Default the modified user id to the default\n                $this->$field = 1;\n                // If a user was not presented, default to the current user\n                if (empty($user)) {\n                    $user = $current_user;\n                }\n                // If the user is set, use it\n                if (!empty($user)) {\n                    $this->$field = $user->id;\n                }\n            }\n        }\n    }\n    /**\n     * Get the field name where created date is stored, if in use by Module\n     * @return string|false\n     */\n    public function getCreatedDateField()\n    {\n        if ($this->_created_date_field !== FALSE){\n            $field = $this->_created_date_field;", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/Implementing_Custom_SugarBean_Templates/index.html"}
{"id": "8964a443506b-3", "text": "$field = $this->_created_date_field;\n            if (isset($this->field_defs[$field]) && $this->field_defs[$field]['type'] == 'datetime'){\n                return $field;\n            }\n        }\n        return FALSE;\n    }\n    /**\n     * Get the field name where created user ID is stored, if in use by Module\n     * @return string|false\n     */\n    public function getCreatedUserField()\n    {\n        if ($this->_created_user_field !== FALSE){\n            $field = $this->_created_user_field;\n            if (isset($this->field_defs[$field]) && $this->field_defs[$field]['type'] == 'assigned_user_name'){\n                return $field;\n            }\n        }\n        return FALSE;\n    }\n    /**\n     * Override the stock setCreateData method\n     * - Code was duplicated from stock, to accommodate not having created date or created user fields\n     * @inheritdoc\n     */\n    public function setCreateData($isUpdate, User $user = null)\n    {\n        if (!$isUpdate) {\n            global $current_user;\n            $field = $this->getCreatedDateField();\n            if ($field !== FALSE){\n                //Duplicated from SugarBean::setCreateData with modifications for dynamic field name\n                if (empty($this->$field)) {\n                    $this->$field = $this->getDateModified();\n                }\n                if (empty($this->$field)){\n                    global $timedate;\n                    $this->$field = $timedate->nowDb();\n                }\n            }\n            $field = $this->getCreatedUserField();\n            if ($field !== FALSE){\n                //Duplicated from SugarBean::setCreateData with modifications for dynamic field name", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/Implementing_Custom_SugarBean_Templates/index.html"}
{"id": "8964a443506b-4", "text": "//Duplicated from SugarBean::setCreateData with modifications for dynamic field name\n                if ($this->set_created_by == true) {\n                    // created by should always be this user\n                    // unless it was set outside of the bean\n                    if ($user) {\n                        $this->$field = $user->id;\n                    } else {\n                        $this->$field = isset($current_user) ? $current_user->id : \"\";\n                    }\n                }\n            }\n            if ($this->new_with_id == false) {\n                $this->id = Sugarcrm\\Sugarcrm\\Util\\Uuid::uuid1();\n            }\n        }\n    }\n    /**\n     * Get the Date Modified fields value\n     * @return mixed|false\n     */\n    public function getDateModified()\n    {\n        if ($this->_modified_date_field !== FALSE){\n            $field = $this->_modified_date_field;\n            return $this->$field;\n        }\n        return FALSE;\n    }\n    /**\n     * Get the Date Created Fields value\n     * @return mixed|false\n     */\n    public function getDateCreated()\n    {\n        if ($this->_created_date_field !== FALSE){\n            $field = $this->_created_date_field;\n            return $this->$field;\n        }\n        return FALSE;\n    }\n    /**\n     * @inheritdoc\n     */\n    public function mark_deleted($id)\n    {\n        $date_modified = $GLOBALS['timedate']->nowDb();\n        if (isset($_SESSION['show_deleted'])) {\n            $this->mark_undeleted($id);\n        } else {\n            // Ensure that Activity Messages do not occur in the context of a Delete action (e.g. unlink)", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/Implementing_Custom_SugarBean_Templates/index.html"}
{"id": "8964a443506b-5", "text": "// and do so for all nested calls within the Top Level Delete Context\n            $opflag = static::enterOperation('delete');\n            $aflag = Activity::isEnabled();\n            Activity::disable();\n            // call the custom business logic\n            $custom_logic_arguments['id'] = $id;\n            $this->call_custom_logic(\"before_delete\", $custom_logic_arguments);\n            $this->deleted = 1;\n            if (isset($this->field_defs['team_id'])) {\n                if (empty($this->teams)) {\n                    $this->load_relationship('teams');\n                }\n                if (!empty($this->teams)) {\n                    $this->teams->removeTeamSetModule();\n                }\n            }\n            $this->mark_relationships_deleted($id);\n            $updateFields = array('deleted' => 1);\n            $field = $this->getModifiedDateField();\n            if ($field !== FALSE){\n                $this->setModifiedDate();\n                $updateFields[$field] = $this->$field;\n            }\n            $field = $this->getModifiedUserField();\n            if ($field !== FALSE){\n                $this->setModifiedUser();\n                $updateFields[$field] = $this->$field;\n            }\n            $this->db->updateParams(\n                $this->table_name,\n                $this->field_defs,\n                $updateFields,\n                array('id' => $id)\n            );\n            if ($this->isFavoritesEnabled()) {\n                SugarFavorites::markRecordDeletedInFavorites($id, $date_modified);\n            }\n            // Take the item off the recently viewed lists\n            $tracker = BeanFactory::newBean('Trackers');\n            $tracker->makeInvisibleForAll($id);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/Implementing_Custom_SugarBean_Templates/index.html"}
{"id": "8964a443506b-6", "text": "$tracker->makeInvisibleForAll($id);\n            SugarRelationship::resaveRelatedBeans();\n            // call the custom business logic\n            $this->call_custom_logic(\"after_delete\", $custom_logic_arguments);\n            if(static::leaveOperation('delete', $opflag) && $aflag) {\n                Activity::enable();\n            }\n        }\n    }\n    /**\n     * @inheritdoc\n     */\n    public function mark_undeleted($id)\n    {\n        // call the custom business logic\n        $custom_logic_arguments['id'] = $id;\n        $this->call_custom_logic(\"before_restore\", $custom_logic_arguments);\n        $this->deleted = 0;\n        $modified_date_field = $this->getModifiedDateField();\n        if ($modified_date_field !== FALSE){\n            $this->setModifiedDate();\n        }\n        $query = \"UPDATE {$this->table_name} SET deleted = ?\".(!$modified_date_field?\"\":\",$modified_date_field = ?\").\" WHERE id = ?\";\n        $conn = $this->db->getConnection();\n        $params = array($this->deleted);\n        if ($modified_date_field){\n            $params[] = $this->$modified_date_field;\n        }\n        $params[] = $id;\n        $conn->executeQuery($query, $params);\n        // call the custom business logic\n        $this->call_custom_logic(\"after_restore\", $custom_logic_arguments);\n    }\n}\nWith the Bean template in place, we can define the default vardefs for the template by creating the following file:\n./custom/include/SugarObjects/templates/bare/vardefs.php\n<?php\n$vardefs = array(\n    'audited' => false,\n    'favorites' => false,\n    'activity_enabled' => false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/Implementing_Custom_SugarBean_Templates/index.html"}
{"id": "8964a443506b-7", "text": "'favorites' => false,\n    'activity_enabled' => false,\n    'fields' => array(\n        'id' => array(\n            'name' => 'id',\n            'vname' => 'LBL_ID',\n            'type' => 'id',\n            'required' => true,\n            'reportable' => true,\n            'duplicate_on_record_copy' => 'no',\n            'comment' => 'Unique identifier',\n            'mandatory_fetch' => true,\n        ),\n        'deleted' => array(\n            'name' => 'deleted',\n            'vname' => 'LBL_DELETED',\n            'type' => 'bool',\n            'default' => '0',\n            'reportable' => false,\n            'duplicate_on_record_copy' => 'no',\n            'comment' => 'Record deletion indicator'\n        )\n    ),\n    'indices' => array(\n        'id' => array(\n            'name' => 'idx_' . preg_replace('/[^a-z0-9_\\-]/i', '', strtolower($module)) . '_pk',\n            'type' => 'primary',\n            'fields' => array('id')\n        ),\n        'deleted' => array(\n            'name' => 'idx_' . strtolower($table_name) . '_id_del',\n            'type' => 'index',\n            'fields' => array('id', 'deleted')\n        )\n    ),\n    'duplicate_check' => array(\n        'enabled' => false\n    )\n);\nNote: This vardef template also shrinks the SugarBean template down even further, by defaulting auditing, favorites, and activity stream to false.\nUsing a Custom Bean Template", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/Implementing_Custom_SugarBean_Templates/index.html"}
{"id": "8964a443506b-8", "text": "Using a Custom Bean Template\nWith the custom SugarBean template in place, we can now implement the template on a custom module. Typically if you deployed a module from Module Builder, there would be two classes generated by Sugar, \"custom_Module_sugar\" and \"custom_Module\". The \"_sugar\" generated class extends from the Bean template that was selected in Module Builder, and the primary Bean class is what is utilized in the system and where your development would take place. For the above example template that is created, the assumption is that you are writing the Bean class, rather than using the generated classes by Module Builder, or at the very least removing the intermediary \"_sugar\" class generated by Module Builder and extending from the desired template. If you deployed a module via Module Builder, and are going to switch to a custom template, please note that some of the stock templates contain internal logic for the setup of fields for that template and that would need to be duplicated if you intend to continue using those fields. The stock templates, located in\u00c2\u00a0./include/SugarObjects/templates/, are available for your reference to copy over any of the required logic to your custom Bean class. With all that being said, let us take a look at a custom Bean class that extends from our custom template.\nThis example will use the \"custom_Module\" module which is a module that will be used for Tagging records. Since the module is just storing tags, a slimmed down Bean works well as we only need a \"name\" field to store those tags. The following class would implement the custom Bean template created above.\n./modules/custom_Module/custom_Module.php\n<?php\nrequire_once 'custom/include/SugarObjects/templates/bare/BareBean.php';\nclass custom_Module extends BareBean {\n    public $new_schema = true;\n    public $module_dir = 'custom_Module';\n    public $object_name = 'custom_Module';", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/Implementing_Custom_SugarBean_Templates/index.html"}
{"id": "8964a443506b-9", "text": "public $object_name = 'custom_Module';\n    public $table_name = 'custom_Module';\n    public $importable = true;\n    public $id;\n    public $name;\n    public $deleted;\n    public function __construct(){\n        parent::__construct();\n    }\n    public function bean_implements($interface){\n        switch($interface){\n            case 'ACL': return true;\n        }\n        return false;\n    }\n}\nWith the modules SugarBean class created, the other thing that needs to be implemented is the vardefs.php file:\n./modules/custom_Module/vardefs.php\n<?php\n$module = 'custom_Module';\n$table_name = strtolower($module);\n$dictionary[$module] = array(\n    'table' => $table_name,\n    'fields' => array(\n        'name' => array(\n            'name' => 'name',\n            'vname' => 'LBL_NAME',\n            'type' => 'username',\n            'link' => true,\n            'dbType' => 'varchar',\n            'len' => 255,\n            'unified_search' => true,\n            'full_text_search' => array(),\n            'required' => true,\n            'importable' => 'required',\n            'duplicate_merge' => 'enabled',\n            //'duplicate_merge_dom_value' => '3',\n            'merge_filter' => 'selected',\n            'duplicate_on_record_copy' => 'always',\n        ),\n    ),\n    'relationships' => array (\n    ),\n    'optimistic_locking' => false,\n    'unified_search' => false,\n);\nVardefManager::createVardef(\n    $module,\n    $module,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/Implementing_Custom_SugarBean_Templates/index.html"}
{"id": "8964a443506b-10", "text": "VardefManager::createVardef(\n    $module,\n    $module,\n    //Specify the bare template to be used to create the vardefs\n    array('bare')\n);\nWith these files implemented, the \"custom_Module\" module would implement the \"bare\" template we created.\nCreating Custom Vardef Templates\nFor some customizations, you might not need a SugarBean template as you may not be implementing logic that needs to be shared across multiple module's Bean classes. However, you may have field definitions that are common across multiple modules that would be beneficial for implementing as Vardef Templates. To create a vardef template, a file as follows, ./custom/include/SugarObjects/implements/<template_name>/vardefs.php.\nContinuing on with our example custom_Module module from above, we might want to have a creation date on this custom tags module since our 'bare' SugarBean template does not come with one by default. We could easily just add one in the modules vardef file, but for our example purposes, we know that we will use our 'bare' SugarBean template on other customizations, and on some of those we might also want to include a creation date. To implement the vardef template for the creation date field, we create the following:\n./custom/include/SugarObjects/implements/date_entered/vardefs.php\n<?php\n$vardefs = array(\n    'fields' => array(\n        'date_entered' => array(\n            'name' => 'date_entered',\n            'vname' => 'LBL_DATE_ENTERED',\n            'type' => 'datetime',\n            'group' => 'created_by_name',\n            'comment' => 'Date record created',\n            'enable_range_search' => true,\n            'options' => 'date_range_search_dom',\n            'studio' => array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/Implementing_Custom_SugarBean_Templates/index.html"}
{"id": "8964a443506b-11", "text": "'options' => 'date_range_search_dom',\n            'studio' => array(\n                'portaleditview' => false,\n            ),\n            'duplicate_on_record_copy' => 'no',\n            'readonly' => true,\n            'massupdate' => false,\n            'full_text_search' => array(\n                'enabled' => true,\n                'searchable' => false\n            ),\n        )\n    ),\n    'indices' => array(\n        'date_entered' => array(\n            'name' => 'idx_' . strtolower($table_name) . '_date_entered',\n            'type' => 'index',\n            'fields' => array('date_entered')\n        )\n    )\n);\nUsing a Custom Vardef Template\nOnce the vardef template is in place, you can use the template by adding it to the 'uses' array property of your module vardefs. Continuing with our example module custom_Module, we can update the vardefs file as follows:\n./modules/custom_Module/vardefs.php\n<?php\n$module = 'custom_Module';\n$table_name = strtolower($module);\n$dictionary[$module] = array(\n    'table' => $table_name,\n    'fields' => array(\n        'name' => array(\n            'name' => 'name',\n            'vname' => 'LBL_NAME',\n            'type' => 'username',\n            'link' => true,\n            'dbType' => 'varchar',\n            'len' => 255,\n            'unified_search' => true,\n            'full_text_search' => array(),\n            'required' => true,\n            'importable' => 'required',\n            'duplicate_merge' => 'enabled',\n            //'duplicate_merge_dom_value' => '3',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/Implementing_Custom_SugarBean_Templates/index.html"}
{"id": "8964a443506b-12", "text": "//'duplicate_merge_dom_value' => '3',\n            'merge_filter' => 'selected',\n            'duplicate_on_record_copy' => 'always',\n        ),\n    ),\n    'relationships' => array (\n    ),\n    //Add the desired vardef templates to this list\n    'uses' => array(\n        'date_entered'\n    ),\n    'optimistic_locking' => false,\n    'unified_search' => false,\n);\nVardefManager::createVardef(\n    $module,\n    $module,\n    //Specify the bare template to be used to create the vardefs\n    array('bare')\n);\nAfter a Quick Repair and Rebuild, a SQL statement should be generated to update the table of the module with the new date_entered field that was added to the vardefs using the vardef template.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/SugarBean/Implementing_Custom_SugarBean_Templates/index.html"}
{"id": "e62207531ec6-0", "text": "BeanFactory\nOverview\nThe BeanFactory class, located in ./data/BeanFactory.php, is used for loading an instance of a SugarBean. This class should be used any time you are creating or retrieving bean objects. It will automatically handle any classes required for the bean.\nCreating a SugarBean Object\nnewBean()\nTo create a new, empty SugarBean, use the newBean() method. This method is typically used when creating a new record for a module or to call properties of the module's bean object.\n$bean = BeanFactory::newBean($module);\nnewBeanByName()\nUsed to fetch a bean by its beanList name.\n$bean = BeanFactory::newBeanByName($name);\nRetrieving a SugarBean Object\ngetBean()\nThe getBean() method can be used to retrieve a specific record from the database. If a record id is not passed, a new bean object will be created.\n$bean = BeanFactory::getBean($module, $record_id);\nNote: Disabling row-level security when accessing a bean should be set to true\u00c2\u00a0only when it is absolutely necessary to bypass security, for example when updating a Lead record from a custom Entry Point.\u00c2\u00a0An example of accessing the bean while bypassing row security is:\n$bean = BeanFactory::getBean($module, $record_id, array('disable_row_level_security' => true));\nretrieveBean()\nThe retrieveBean() method can also be used to retrieve a specific record from the database. The difference between this method and getBean() is that null will be returned instead of an empty bean object if the retrieve fails.\n$bean = BeanFactory::retrieveBean($module, $record_id);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/BeanFactory/index.html"}
{"id": "e62207531ec6-1", "text": "$bean = BeanFactory::retrieveBean($module, $record_id);\nNote: Disabling row-level security when accessing a bean should be set to true only when it is absolutely necessary to bypass security, for example, when updating a Lead record from a custom Entry Point.\u00c2\u00a0An example of accessing the bean while bypassing row security is:\n$bean = BeanFactory::retrieveBean($module, $record_id, array('disable_row_level_security' => true));\nRetrieving Module Keys\ngetObjectName()\nThe getObjectName() method will return the object name / dictionary key for a given module. This is normally the same as the bean name, but may not be for some modules such as Cases which has a key of 'aCase' and a name of 'Case'.\n$moduleKey = BeanFactory::getObjectName($moduleName);\ngetBeanName()\nThe getBeanName() method will retrieve the bean class name given a module name.\n$moduleClass = BeanFactory::getBeanName($module);\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Models/BeanFactory/index.html"}
{"id": "ceaaded7b31f-0", "text": "Vardefs\nOverview\nVardefs (Variable Definitions) provide the Sugar application with information about SugarBeans. Vardefs specify information on the individual fields, relationships between beans, and the indexes for a given bean.\u00c2\u00a0\nEach module that contains a SugarBean file has a vardefs.php file located in it, which specifies the fields for that SugarBean. For example, the vardefs for the Contact bean are located in ./modules/Contacts/vardefs.php.\nDictionary Array\nVardef files create an array called $dictionary, which contains several entries including tables, fields, indices, and relationships.\ntable : The name of the database table (usually, the name of the module) for this bean that contains the fields\naudited : Specifies whether the module has field-level auditing enabled\nduplicate_check\u00c2\u00a0: Determines if duplicate checking is enabled on the module, and what duplicate check strategy will be used if enabled.\u00c2\u00a0\nfields : A list of fields and their attributes\nindices : A list of indexes that should be created in the database\noptimistic_locking : Determines whether the module has optimistic locking enabled\nOptimistic locking prevents loss of data by using the bean's modified date to ensure that it is not being modified simultaneously by more than one person or process.\nunified_search : Determines whether the module can\u00c2\u00a0be searched via Global Search\u00c2\u00a0This setting defaults to false and has no effect if all of the fields in the fields array have the 'unified_search' field attribute set to false.\nunified_search_default_enabled : Determines whether the module should be searched by default for new users via Global Search\nThis setting defaults to true but has no effect if\u00c2\u00a0unified_search is set to false.\nvisibility\u00c2\u00a0: A list of visibility classes enabled on the module\nDuplicate Check Array", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/index.html"}
{"id": "ceaaded7b31f-1", "text": "visibility\u00c2\u00a0: A list of visibility classes enabled on the module\nDuplicate Check Array\nThe duplicate_check\u00c2\u00a0array contains two properties, that control if duplicate checking is enabled on the module, and which duplicate check strategy will be used to check for duplicates.\nThe two properties for the array are as follows:\nName\nType\nDescription\nenabled\nBoolean\nSpecifies whether or not the Bean is utilizing the duplicate check framework\n<class_name>\nArray\n<class_name> is the name of the duplicate check strategy class that is handling the duplicate checking. It is set to an array of Metadata, specific to the strategy defined in\u00c2\u00a0the key. Review the Duplicate Check Framework for further information.\nFields Array\nThe fields array contains one array for each field in the SugarBean. At the top level of this array, the key is the name of the field, and the value is an array of attributes about that field.\nThe list of possible attributes are as follows:\nname : The name of the field\nvname : The language pack ID for the label of this field\ntype : The type of the attribute\nassigned_user_name : A linked user name\nbool : A boolean value\nchar : A character array\ndate : A date value with no time\ndatetime : A date and time\nemail : An email address field\nenum : An enumeration (dropdown list from the language pack)\nid : A database GUID\nimage : A photo-type field\nlink : A link through an explicit relationship. This attribute should only be used when working with related fields. It does not make the field render as a link.\nname : A non-database field type that concatenates other field values\nphone : A phone number field to utilize with callto:// links\nrelate : Related bean\nteam_list : A team-based ID\ntext : A text area field\nurl : A hyperlinked field on the detail view\nvarchar : A variable-sized string", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/index.html"}
{"id": "ceaaded7b31f-2", "text": "url : A hyperlinked field on the detail view\nvarchar : A variable-sized string\ntable : The database table the field comes from.\nThe table attribute is only needed\u00c2\u00a0to join fields from another table outside of the module in focus.\nisnull : Whether the field can contain a null value\nlen : The length of the field (number of characters if a string)\noptions : The name of the enumeration (dropdown list) in the language pack for the field\ndbtype : The database type of the field (if different than the type)\nreportable : Determines whether the field will be available in the Reports and Workflow modules\ndefault :\u00c2\u00a0The default value for this field.\u00c2\u00a0Default values for the record are populated by default on create for the record view (for Sidecar modules) and edit view (for Legacy modules) layout but can be modified by users. The Default Value option is available for all data type fields except HTML, Image, Flex Relate, and Relate.\nmassupdate : Determines whether the field\u00c2\u00a0will show up in the mass-update panel on its module's list view\nSome field types are restricted from mass update regardless of this setting.\nrname : For relate-type fields, the field from the related variable that contains\u00c2\u00a0the text\nid_name : For relate-type fields, the field from the bean that stores the ID for the related bean\nsource : Set to 'non-db' if the field value does not come from the database\nThe source attribute can be used for calculated values or values retrieved in some other way.\nsort_on : The field to sort by if multiple fields are used in the presentation of field's information\nfields : For concatenated values, an array containing the fields that are concatenated\ndb_concat_fields : For concatenated values, an array containing the fields to concatenate in the database\nunified_search : Determines whether the field\u00c2\u00a0can\u00c2\u00a0be searched via Global Search", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/index.html"}
{"id": "ceaaded7b31f-3", "text": "unified_search : Determines whether the field\u00c2\u00a0can\u00c2\u00a0be searched via Global Search\nThis has no effect if the dictionary array setting 'unified_search' is not set to true.\nenable_range_search : For date, datetime, and numeric fields, determines if this field should be searchable by range in module searches\ndependency : Allows a field to have a predefined formula to control the field's visibility\nstudio : Controls the visibility of the field in the Studio editor\nIf set to false, then the field will not appear in any studio screens for the module. Otherwise, you may specify an Array of view keys from which the field's visibility should be removed (e.g.\u00c2\u00a0array('listview'=>false) will hide the field in the listview layout screen).\nThe following example illustrates a standard ID field for a bean:\n'id' => array (\n    'name' => 'id',\n    'vname' => 'LBL_ID',\n    'type' => 'id',\n    'required' => true,\n),\nIndices Array\nThis array contains a list of arrays that are used to create indices in the database. The fields in this array are:\nname : The unique name of the index\ntype : The type of index (primary, unique, or index)\nfields : An ordered array of the fields to index\nsource : Set to 'non-db' if you are creating an index for added application functionality such as duplication checking on imports\nThe following example\u00c2\u00a0creates a primary index called 'userspk' on the 'id' column:\narray(\n    'name' => 'userspk', \n    'type' => 'primary', \n    'fields'=> array('id')\n),\nRelationships Array\nThe relationships array specifies relationships between beans. Like the indices array entries, it is a list of names with array values.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/index.html"}
{"id": "ceaaded7b31f-4", "text": "lhs_module : The module on the left-hand side of the relationship\nlhs_table : The table on the left-hand side of the relationship\nlhs_key : The primary key column of the left-hand side of the relationship\nrhs_module : The module on the right-hand side of the relationship\nrhs_table : The table on the right-hand side of the relationship\nrhs_key : The primary key column of the right-hand side of the relationship\nrelationship_type : The type of relationship (e.g. one-to-many,\u00c2\u00a0many-to-many)\nrelationship_role_column : The type of relationship role\nrelationship_role_column_value : Defines the unique identifier for the relationship role\nThe following example creates a relationship between a contact and the contact that they report to. The reports_to_id field maps to the id of the record that belongs to the higher-ranked contact. This is a one-to-many relationship in that a contact may only report to one person, but many people may report to the same contact.\n'contact_direct_reports' => array(\n    'lhs_module' => 'Contacts',\n    'lhs_table' => 'contacts',\n    'lhs_key' => 'id',\n    'rhs_module' => 'Contacts',\n    'rhs_table' => 'contacts',\n    'rhs_key' => 'reports_to_id',\n    'relationship_type' => 'one-to-many'\n),\nVisibility Array\nThe visibility\u00c2\u00a0array specifies the row level visibility classes that are enabled on the bean. Each entry in the array, is a key-value pair, where the key is the name of the Visibility class and the value is set to boolean True. More information on configuring custom Visibility strategies can be found in the Architecture section under Visibility Framework.\nExtending Vardefs\nMore information about extending and overriding vardefs can be found in the Extensions Framework documentation under Vardefs.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/index.html"}
{"id": "ceaaded7b31f-5", "text": "TopicsManually Creating Custom FieldsThe most common way to create custom fields in Sugar is via Studio inside the application. This page describes how to use the ModuleInstaller class or vardef extensions as alternative methods of creating custom fields.Specifying Custom Indexes for Import Duplicate CheckingWhen importing records to Sugar via the Import Wizard, users can select which of the mapped fields they would like to use to perform a duplicate check and thereby avoid creating duplicate records. This article explains how to enable an additional field or set of fields for selection in this step.Working With IndexesSugar provides a simple method for creating custom indexes through the vardef framework. Indexes can be built on one or more fields within a module. Indexes can be saved down to the database level or made available only in the application for functions such as Import Duplicate Checking.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/index.html"}
{"id": "868da64eb622-0", "text": "Working With Indexes\nOverview\nSugar provides a simple method for creating custom indexes through the vardef framework. Indexes can be built on one or more fields within a module. Indexes can be saved down to the database level or made available only in the application for functions such as Import Duplicate Checking.\nIndex Metadata\nIndexes have the following\u00c2\u00a0metadata options that can be configured per index:\nKey\nValue\nDescription\u00c2\u00a0\nname\nstring\nA Unique identifier to define the index. Best practices recommend indexes start with idx and contain the suffix cstm to avoid conflicting with a stock index.\u00c2\u00a0\nNote : Some databases have restrictions on the length of index names. Please check with your database vendor to avoid any issues.\ntype\nstring\u00c2\u00a0\n\u00c2\u00a0All indexes should use the type of \"index\"\nfields\narray\nA PHP array of the fields for the index to utilize\u00c2\u00a0\nsource\nstring\nSpecify as \"non-db\" to avoid creating the index in the database\nCreating Indexes\nStock indexes are initially defined in the module's vardefs file under the indices array. For reference, you can find them using the vardef path\u00c2\u00a0of your module. The path will be \u00c2\u00a0./modules/<module>/vardefs.php.\nCustom indexes\u00c2\u00a0should \u00c2\u00a0be created using the Extension Framework.\u00c2\u00a0First, create a PHP\u00c2\u00a0file in the extension directory of your\u00c2\u00a0desired module. The path should similar to\u00c2\u00a0./custom/Extension/modules/<module>/Ext/Vardefs/<name>.php.\nIn the new file, add the appropriate $dictionary reference to define the custom index:\n<?php\n$dictionary['<module>']['indices'][] = array(\n\t'name' => '<index name>',\n\t'type' => 'index',\n\t'fields' => array(\n\t\t'field1',\n\t\t'field2',\n\t)\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/Working_With_Indexes/index.html"}
{"id": "868da64eb622-1", "text": "'field1',\n\t\t'field2',\n\t)\n);\nNote : For performance reasons, it is not recommended to create an index on a single field unless the source is set to non-db.\nOnce installed,you will need to navigate\u00c2\u00a0to Admin > Repair > Quick Repair and Rebuild to enable the custom index. You will need to execute any scripts generated by the rebuild process.\nRemoving Indexes\nStock indexes are initially defined in the module's vardefs file under the indices array. For reference, you can find them using the vardef path of your module. The path will be ./modules/<module>/vardefs.php.\nStock indexes should be removed using the Extension Framework. First, create a PHP file in the extension directory of your desired module. The path should similar to ./custom/Extension/modules/<module>/Ext/Vardefs/<name>.php.\nIn the new file, loop through the existing 'indices' sub-array of the $dictionary to locate the stock index to remove, and use unset() to remove it from the array.\nExample\nThe following is an example to remove the idx_calls_date_start index from the Call module's vardefs.\nFirst, create ./custom/Extension/modules/Calls/Ext/Vardefs/remove_idx_calls_date_start.php\u00c2\u00a0from the root directory of your Sugar installation on the web server. When creating the file, keep in mind the following requirements:\nThe name of the file is not important, as long as it ends with a .php extension.\nThe rest of the directory path is case sensitive so be sure to create the directories as shown.\nIf you are removing the index for a module other than Calls, then substitute the corresponding directory name with that module.\nEnsure that the entire directory path and file have the correct ownership and sufficient permissions for the web server to access the file.\nThe contents of the file should look similar to the following code:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/Working_With_Indexes/index.html"}
{"id": "868da64eb622-2", "text": "The contents of the file should look similar to the following code:\n<?php\n$call_indexes = $dictionary['Call']['indices'];\n$remove_index = \"idx_calls_date_start\";\nforeach($call_indexes as $index_key => $index_item) {\n    if( $index_item['name'] == $remove_index ) {\n        unset($dictionary['Call']['indices'][$index_key]);\n    }\n}\nNote : Removing the reference to the index from the module's indices array does not actually remove the index from the module's database table. Removing the reference from the indices array ensures that the index is not added back to the module's database table when performing any future Quick Repair and Rebuilds. The database index must be removed directly at the database level. On MySQL, with the current example, this could be done with a query like:\nALTER TABLE calls DROP INDEX idx_calls_date_start;\nOnce installed,you will need to navigate to Admin > Repair > Quick Repair and Rebuild to remove the index from the $dictionary array. You will need to execute any scripts generated by the rebuilding process.\nCreating Indexes for Import Duplicate Checking\nWhen importing records to Sugar via the Import Wizard, users can select which of the mapped fields they\u00c2\u00a0would like to use to perform a duplicate check\u00c2\u00a0and thereby avoid creating duplicate records. The following instructions\u00c2\u00a0explain how to enable an additional field or set of fields for selection in this step.\nExample\nThe following is an example to add the home phone field to the Contact module's duplicate check.\nFirst, create ./custom/Extension/modules/Contacts/Ext/Vardefs/custom_import_index.php\u00c2\u00a0from the root directory of your Sugar installation on the\u00c2\u00a0web server. When creating the file, keep in mind the following requirements:\nThe name of the file is not important, as long as it ends with a .php extension.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/Working_With_Indexes/index.html"}
{"id": "868da64eb622-3", "text": "The rest of the directory path is case sensitive so be sure to create the directories as shown.\nIf you are creating the import index for a module other than Contacts, then substitute the corresponding directory name with that module.\nEnsure that the entire directory path and file have the correct ownership and sufficient permissions for the web server to access the file.\nThe contents of the file should look similar to the following code:\n<?php\n$dictionary['Contact']['indices'][] = array(\n     'name' => 'idx_home_phone_cstm',\n     'type' => 'index',\n     'fields' => array(\n         0 => 'phone_home',\n     ),\n     'source' => 'non-db',\n);\nPlease\u00c2\u00a0note that the module name in line 2 of the code is singular (i.e. Contact, not Contacts). If you are unsure of what to enter for the module name, you can verify the name by opening the ./cache/modules/<module_name>/<module_name>vardefs.php file. The second line of that file will have text like the following:\n$GLOBALS[\"dictionary\"][\"Contact\"] = array (...);\nThe parameter following \"dictionary\" is the same parameter you should use in the file defining the\u00c2\u00a0custom index. To verify duplicates against a combination of fields (i.e. duplicates will only be flagged if the values of multiple fields match those of an existing record), then simply\u00c2\u00a0add the desired fields to the 'fields' array in the code example.\nFinally, navigate\u00c2\u00a0to Admin > Repair > Quick Repair and Rebuild to enable the custom index for duplicate verification when importing records in the\u00c2\u00a0module.\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/Working_With_Indexes/index.html"}
{"id": "195edd6f1e4c-0", "text": "Manually Creating Custom Fields\nOverview\nThe most common way to create custom fields in Sugar is via Studio inside the application. This page describes how to use the ModuleInstaller class\u00c2\u00a0or vardef extensions as alternative methods of\u00c2\u00a0creating custom fields.\nNote: Sugar Sell Essentials customers do not have the ability to upload custom file packages to Sugar using Module Loader.\nUsing ModuleInstaller to Create Custom Fields\nThere are two ways to create a field using the ModuleInstaller class: via installer package or\u00c2\u00a0programmatically. An example of creating a field from a module-loadable package is explained in the Module Loader documentation,,\u00c2\u00a0Creating an Installable Package that Creates New Fields. The following example shows how to\u00c2\u00a0programmatically add custom fields using the ModuleInstaller class with the install_custom_fields() method:\n<?php\n    $fields = array (\n        //Text\n        array(\n            'name' => 'text_field_example',\n            'label' => 'LBL_TEXT_FIELD_EXAMPLE',\n            'type' => 'varchar',\n            'module' => 'Accounts',\n            'help' => 'Text Field Help Text',\n            'comment' => 'Text Field Comment Text',\n            'default_value' => '',\n            'max_size' => 255,\n            'required' => false, // true or false\n            'reportable' => true, // true or false\n            'audited' => false, // true or false\n            'importable' => 'true', // 'true', 'false', 'required'\n            'duplicate_merge' => false, // true or false\n        ),\n        //DropDown\n        array(\n            'name' => 'dropdown_field_example',\n            'label' => 'LBL_DROPDOWN_FIELD_EXAMPLE',\n            'type' => 'enum',\n            'module' => 'Accounts',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/Manually_Creating_Custom_Fields/index.html"}
{"id": "195edd6f1e4c-1", "text": "'type' => 'enum',\n            'module' => 'Accounts',\n            'help' => 'Enum Field Help Text',\n            'comment' => 'Enum Field Comment Text',\n            'ext1' => 'account_type_dom', //maps to options - specify list name\n            'default_value' => 'Analyst', //key of entry in specified list\n            'mass_update' => false, // true or false\n            'required' => false, // true or false\n            'reportable' => true, // true or false\n            'audited' => false, // true or false\n            'importable' => 'true', // 'true', 'false' or 'required'\n            'duplicate_merge' => false, // true or false\n        ),\n        //MultiSelect\n        array(\n            'name' => 'multiselect_field_example',\n            'label' => 'LBL_MULTISELECT_FIELD_EXAMPLE',\n            'type' => 'multienum',\n            'module' => 'Accounts',\n            'help' => 'Multi-Enum Field Help Text',\n            'comment' => 'Multi-Enum Field Comment Text',\n            'ext1' => 'account_type_dom', //maps to options - specify list name\n            'default_value' => 'Analyst', //key of entry in specified list\n            'mass_update' => false, // true or false\n            'required' => false, // true or false\n            'reportable' => true, // true or false\n            'audited' => false, // true or false\n            'importable' => 'true', // 'true', 'false' or 'required'\n            'duplicate_merge' => false, // true or false\n        ),\n        //Checkbox\n        array(\n            'name' => 'checkbox_field_example',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/Manually_Creating_Custom_Fields/index.html"}
{"id": "195edd6f1e4c-2", "text": "//Checkbox\n        array(\n            'name' => 'checkbox_field_example',\n            'label' => 'LBL_CHECKBOX_FIELD_EXAMPLE',\n            'type' => 'bool',\n            'module' => 'Accounts',\n            'default_value' => true, // true or false\n            'help' => 'Bool Field Help Text',\n            'comment' => 'Bool Field Comment',\n            'audited' => false, // true or false\n            'mass_update' => false, // true or false\n            'duplicate_merge' => false, // true or false\n            'reportable' => true, // true or false\n            'importable' => 'true', // 'true', 'false' or 'required'\n        ),\n        //Date\n        array(\n            'name' => 'date_field_example',\n            'label' => 'LBL_DATE_FIELD_EXAMPLE',\n            'type' => 'date',\n            'module' => 'Accounts',\n            'default_value' => '',\n            'help' => 'Date Field Help Text',\n            'comment' => 'Date Field Comment',\n            'mass_update' => false, // true or false\n            'required' => false, // true or false\n            'reportable' => true, // true or false\n            'audited' => false, // true or false\n            'duplicate_merge' => false, // true or false\n            'importable' => 'true', // 'true', 'false' or 'required'\n        ),\n        //DateTime\n        array(\n            'name' => 'datetime_field_example',\n            'label' => 'LBL_DATETIME_FIELD_EXAMPLE',\n            'type' => 'datetime',\n            'module' => 'Accounts',\n            'default_value' => '',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/Manually_Creating_Custom_Fields/index.html"}
{"id": "195edd6f1e4c-3", "text": "'module' => 'Accounts',\n            'default_value' => '',\n            'help' => 'DateTime Field Help Text',\n            'comment' => 'DateTime Field Comment',\n            'mass_update' => false, // true or false\n            'enable_range_search' => false, // true or false\n            'required' => false, // true or false\n            'reportable' => true, // true or false\n            'audited' => false, // true or false\n            'duplicate_merge' => false, // true or false\n            'importable' => 'true', // 'true', 'false' or 'required'\n        ),\n        //Encrypt\n        array(\n            'name' => 'encrypt_field_example',\n            'label' => 'LBL_ENCRYPT_FIELD_EXAMPLE',\n            'type' => 'encrypt',\n            'module' => 'Accounts',\n            'default_value' => '',\n            'help' => 'Encrypt Field Help Text',\n            'comment' => 'Encrypt Field Comment',\n            'reportable' => true, // true or false\n            'audited' => false, // true or false\n            'duplicate_merge' => false, // true or false\n            'importable' => 'true', // 'true', 'false' or 'required'\n        ),\n    );\n    require_once('ModuleInstall/ModuleInstaller.php');\n    $moduleInstaller = new ModuleInstaller();\n    $moduleInstaller->install_custom_fields($fields);\nAdd\u00c2\u00a0labels for custom fields by creating a corresponding language extension file:\n./custom/Extension/modules/Accounts/Ext/Language/en_us.<name>.php\n<?php\n    $mod_strings['LBL_TEXT_FIELD_EXAMPLE'] = 'Text Field Example';\n    $mod_strings['LBL_DROPDOWN_FIELD_EXAMPLE'] = 'DropDown Field Example';", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/Manually_Creating_Custom_Fields/index.html"}
{"id": "195edd6f1e4c-4", "text": "$mod_strings['LBL_DROPDOWN_FIELD_EXAMPLE'] = 'DropDown Field Example';\n    $mod_strings['LBL_CHECKBOX_FIELD_EXAMPLE'] = 'Checkbox Field Example';\n    $mod_strings['LBL_MULTISELECT_FIELD_EXAMPLE'] = 'Multi-Select Field Example';\n    $mod_strings['LBL_DATE_FIELD_EXAMPLE'] = 'Date Field Example';\n    $mod_strings['LBL_DATETIME_FIELD_EXAMPLE'] = 'DateTime Field Example';\n    $mod_strings['LBL_ENCRYPT_FIELD_EXAMPLE'] = 'Encrypt Field Example';\nFinally, navigate to Admin > Repair > Quick Repair and Rebuild to make the new field available for users.\nUsing the Vardef Extensions\nYou should try to avoid creating your own custom fields using the vardefs as there are several caveats:\nIf your installation does not already contain custom fields, you must manually create the custom table. Otherwise, the system will not recognize your field's custom vardef. This situation is outlined in the following section.\nYou must\u00c2\u00a0run a Quick Repair and Rebuild and then execute the generated SQL after the vardef is installed.\nYou must correctly define the properties of a vardef. If you miss any, the field may not work properly.\nYour field name must end with \"_c\" and have the property 'source' set to 'custom_fields'. This is required as you should not modify core tables in Sugar and it is not permitted on\u00c2\u00a0Sugar's cloud service.\nYour vardef must specify the exact indexes of the properties you want to set. For example, use: \u00c2\u00a0$dictionary['<module singular>']['fields']['example_c']['name'] = 'myfield_c';\u00c2\u00a0instead of $dictionary['<module singular>']['fields']['example_c'] = array(['name' => 'myfield_c');. This will help prevent the system from losing any properties when loading from the extension framework.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/Manually_Creating_Custom_Fields/index.html"}
{"id": "195edd6f1e4c-5", "text": "The initial challenge when creating your own custom vardef is getting the system to recognize the vardef and generate the database field. This\u00c2\u00a0issue\u00c2\u00a0is illustrated with the example below:\n./custom/Extension/modules/<module>/Ext/Vardefs/<file>.php\n<?php\n$dictionary['<module singular>']['fields']['example_c']['name'] = 'example_c';\n$dictionary['<module singular>']['fields']['example_c']['vname'] = 'LBL_EXAMPLE_C';\n$dictionary['<module singular>']['fields']['example_c']['type'] = 'varchar';\n$dictionary['<module singular>']['fields']['example_c']['enforced'] = '';\n$dictionary['<module singular>']['fields']['example_c']['dependency'] = '';\n$dictionary['<module singular>']['fields']['example_c']['required'] = false;\n$dictionary['<module singular>']['fields']['example_c']['massupdate'] = '0';\n$dictionary['<module singular>']['fields']['example_c']['default'] = '';\n$dictionary['<module singular>']['fields']['example_c']['no_default'] = false;\n$dictionary['<module singular>']['fields']['example_c']['comments'] = 'Example Varchar Vardef';\n$dictionary['<module singular>']['fields']['example_c']['help'] = '';\n$dictionary['<module singular>']['fields']['example_c']['importable'] = 'true';\n$dictionary['<module singular>']['fields']['example_c']['duplicate_merge'] = 'disabled';\n$dictionary['<module singular>']['fields']['example_c']['duplicate_merge_dom_value'] = '0';\n$dictionary['<module singular>']['fields']['example_c']['audited'] = false;\n$dictionary['<module singular>']['fields']['example_c']['reportable'] = true;", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/Manually_Creating_Custom_Fields/index.html"}
{"id": "195edd6f1e4c-6", "text": "$dictionary['<module singular>']['fields']['example_c']['reportable'] = true;\n$dictionary['<module singular>']['fields']['example_c']['unified_search'] = false;\n$dictionary['<module singular>']['fields']['example_c']['merge_filter'] = 'disabled';\n$dictionary['<module singular>']['fields']['example_c']['calculated'] = false;\n$dictionary['<module singular>']['fields']['example_c']['len'] = '255';\n$dictionary['<module singular>']['fields']['example_c']['size'] = '20';\n$dictionary['<module singular>']['fields']['example_c']['id'] = 'example_c';\n$dictionary['<module singular>']['fields']['example_c']['custom_module'] = '';\n//required to create the field in the _cstm table\n$dictionary['<module singular>']['fields']['example_c']['source'] = 'custom_fields';\nOnce the vardef is in place, determine whether the custom field's module already contains any other custom fields. If there are not any existing custom fields, create a corresponding record in fields_meta_data that will trigger the comparison process.\nINSERT INTO fields_meta_data (id, name, vname, comments, custom_module, type, len, required, deleted, audited, massupdate, duplicate_merge, reportable, importable) VALUES ('<module>example_c', 'example_c', 'LBL_EXAMPLE_C', 'Example Varchar Vardef', '<module>', 'varchar', 255, 0, 0, 0, 0, 0, 1, 'true');", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/Manually_Creating_Custom_Fields/index.html"}
{"id": "195edd6f1e4c-7", "text": "Finally, navigate to Admin > Repair > Quick Repair and Rebuild. The system will then rebuild the extensions. After the repair, you will notice a section at the bottom stating that there are differences between the database and vardefs. Execute the scripts generated to create theSave\u00c2\u00a0custom field:\nMissing <module>_cstm Table:\n/*Checking Custom Fields for module : <module>*/\nCREATE TABLE <module>_cstm (id_c char(36)  NOT NULL  , PRIMARY KEY (id_c)) CHARACTER SET utf8 COLLATE utf8_general_ci;\nMissing Columns:\n/*MISSING IN DATABASE - example_c -  ROW*/\nALTER TABLE <module>_cstm add COLUMN example_c varchar(255)  NULL ;\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/Manually_Creating_Custom_Fields/index.html"}
{"id": "f11c0c9b2d3c-0", "text": "Specifying Custom Indexes for Import Duplicate Checking\nOverview\nWhen importing records to Sugar via the Import Wizard, users can select which of the mapped fields they\u00c2\u00a0would like to use to perform a duplicate check\u00c2\u00a0and thereby avoid creating duplicate records. This article explains how to enable an additional field or set of fields for selection in this step.\nResolution\nThe import wizard's duplicate check operates based on indices defined for that module. You can create a non-database index to check for a field. It is important that it is non-database as single column indices on your database can hamper overall performance. The following is an example to add the home phone field to the Contact module's duplicate check.\nFirst, create the following file from the root directory of your Sugar installation on the\u00c2\u00a0web server:\n./custom/Extension/modules/Contacts/Ext/Vardefs/custom_import_index.php\nWhen creating the file, keep in mind the following requirements:\nThe name of the file is not important, as long as it ends with a .php extension.\nThe rest of the directory path is case sensitive so be sure to create the directories as shown.\nIf you are creating the import index for a module other than Contacts, then substitute the corresponding directory name with that module.\nEnsure that the entire directory path and file have the correct ownership and sufficient permissions for the web server to access the file.\nThe contents of the file should look similar to the following code:\n<?php\n$dictionary['Contact']['indices'][] = array(\n     'name' => 'idx_home_phone_cstm',\n     'type' => 'index',\n     'fields' => array(\n         0 => 'phone_home',\n     ),\n     'source' => 'non-db',\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/Specifying_Custom_Indexes_for_Import_Duplicate_Checking/index.html"}
{"id": "f11c0c9b2d3c-1", "text": "),\n     'source' => 'non-db',\n);\nPlease\u00c2\u00a0note that the module name in line 2 of the code is singular (i.e. Contact, not Contacts). If you are unsure of what to enter for the module name, you can verify the name by opening the ./cache/modules/<module_name>/<module_name>vardefs.php file. The second line of that file will have text like the following:\n$GLOBALS[\"dictionary\"][\"Contact\"] = array (\nThe parameter following \"dictionary\" is the same parameter you should use in the file defining the\u00c2\u00a0custom index. To verify duplicates against a combination of fields (i.e. duplicates will only be flagged if the values of multiple fields match those of an existing record), then simply\u00c2\u00a0add the desired fields to the 'fields' array in the code example.\nFinally, navigate\u00c2\u00a0to Admin > Repair > Quick Repair and Rebuild to enable the custom index for duplicate verification when importing records in the\u00c2\u00a0module.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Vardefs/Specifying_Custom_Indexes_for_Import_Duplicate_Checking/index.html"}
{"id": "3781bc5b50ec-0", "text": "Fields\nOverview\nHow fields interact with the various aspects of Sugar.\u00c2\u00a0\nSugarField Widgets\nThe SugarField widgets, located in ./include/SugarFields/Fields/\u00c2\u00a0,\u00c2\u00a0define\u00c2\u00a0the data\u00c2\u00a0formatting and search query structure for the various field types. They also define the rendering of fields for modules running in backward compatibility mode. When creating or overriding\u00c2\u00a0field widgets, developers should place their customization in ./custom/include/SugarFields/Fields/. For information on how Sidecar renders fields, please refer to the fields section in our user interface\u00c2\u00a0documentation.\u00c2\u00a0Creating Custom Fields\nImplementation\nAll fields for a module are defined within\u00c2\u00a0vardefs. Within this definition, the\u00c2\u00a0type attribute will determine all of the logic applied to the field. For example, the Contacts module\u00c2\u00a0has a\u00c2\u00a0 'Do Not Call' field. In the vardefs, this\u00c2\u00a0field is defined as follows:\n'do_not_call' => array (\n    'name' => 'do_not_call', // the name of the field\n    'vname' => 'LBL_DO_NOT_CALL', // the label for the field name\n    'type' => 'bool', // the fields type\n    'default' => '0', // the fields default value\n    'audited'=>true, // whether the field is audited\n    'duplicate_on_record_copy' => 'always', // whether to duplicate the fields value when being copied\n    'comment' => 'An indicator of whether contact can be called' // admin context of the field\n),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Fields/index.html"}
{"id": "3781bc5b50ec-1", "text": "),\n\u00c2\u00a0The bool\u00c2\u00a0type field is rendered in the UI from the ./clients/base/fields/bool/bool.js field controller which renders\u00c2\u00a0the appropriate handlebars template as defined by the users current view for sidecar enabled modules. When the user saves data, the controller formats the data for the API and passes it to an endpoint. Once the data is received by the\u00c2\u00a0server, The SugarField\u00c2\u00a0definition calls any additional logic in the apiSave function to format the data for saving to the database.\u00c2\u00a0The same concept is applied in the apiFormatField function when retrieving data from the database to be passed back to the user interface through\u00c2\u00a0the API. For modules running in backward compatibility mode, the bool field is rendered using the Smarty .tpl) templates located in ./include/SugarFields/Fields/Bool/.\nWhile the vardefs\u00c2\u00a0define the default type for a field, this value can be overridden in the metadata of the view rendering the field. The example being that in ./custom/modules/Contacts/clients/base/views/record/record.php, you can modify the\u00c2\u00a0do_not_call field array to point to a custom field type you have created. For more information on creating custom field types, please refer to Creating Custom Fields documentation.\u00c2\u00a0\u00c2\u00a0\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Data_Framework/Fields/index.html"}
{"id": "7a1f35b2e450-0", "text": "Introduction\nOverview\nThe Sugar Developer Guide is an essential resource for developers who are new to Sugar or to CRM and web-based applications. It\u00c2\u00a0describes how to configure and customize the Sugar platform for a broad range of tasks applicable to any organization that has a need to manage business relationships with people.\nPrerequisites\nUsing and understanding the\u00c2\u00a0documentation contained in the Sugar Developer Guide requires basic programming and software development knowledge. Specifically, you should be familiar with the PHP general-purpose scripting language and the SQL programming language for accessing databases.\nUnderstanding Sugar's Framework\nDesigned as the most modern web-based CRM platform available today, Sugar has quickly become the business application standard for companies around the world.\u00c2\u00a0The Sugar application framework has a sophisticated extension model built into it, allowing developers to make significant customizations to the application in an upgrade-safe and modular manner. It is easy to modify the core files in the distribution; you should always check for an upgrade-safe way to make changes. Educating developers on how to make upgrade-safe customizations is one of the key goals of this Developer Guide. For more information on Sugar's structure, please review the architecture section.\nSupported Platforms\nOriginally, Sugar\u00c2\u00ae was written on the LAMP stack (i.e. Linux, Apache, MySQL, and PHP), but has since\u00c2\u00a0added support for every operating system on which the PHP programming language runs, for the Microsoft IIS web server, and for the Microsoft SQL Server, IBM\u00c2\u00ae DB2\u00c2\u00ae, and Oracle databases.\u00c2\u00a0For more information about\u00c2\u00a0supported software versions and recommended stacks, please refer to the main\u00c2\u00a0Supported Platforms page.\nSugar Products", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/index.html"}
{"id": "7a1f35b2e450-1", "text": "Sugar Products\nSugar has several CRM products available: Sugar Sell, Sugar Serve, and Sugar Enterprise, which are all sold under a commercial subscription agreement. These\u00c2\u00a0products are developed by the same development team using the same source tree with different modules and features available depending on the product. A comparison of each product's features is available in the License Types section of the User Management documentation in the Administration Guide.\nBasic Development Rules for Sugar Products\nUnless SugarCRM has given you express permission to do so, the following are what not to do when you are configuring, customizing or modifying this Sugar product:\nDo not remove or alter any SugarCRM or Sugar copyright, trademark or proprietary notices that appear in the Sugar products.\nDo not \"fork\" the Sugar software (e.g., take a copy of source code from this product and start independent development on it, creating a distinct and separate piece of software).\nDo not modify, remove or disable any portion of SugarCRM's \"Critical Control Software.\"\nDo not combine or use the Sugar products with any code that is licensed under a prohibited license (e.g., AGPL, GPL v3, Creative Commons or another similar license that would \"taint\" the Sugar products and require you to share the source code for this product with a third party).\nDo not use any part of the Sugar products for the purpose of building a competitive product or service or copying its features or user interface.\nDevelopment Tools\nSugar has a set of built-in tools that you can use to your advantage when troubleshooting or developing.\nDeveloper Mode\nDeveloper Mode will allow for Sugar to recompile cached files when the page is reloaded. The following file types are rebuilt:\nHandlebar Templates (.hbt)\nSmarty Templates (.tpl)\nJavaScript Controllers\u00c2\u00a0(.js)", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/index.html"}
{"id": "7a1f35b2e450-2", "text": "Smarty Templates (.tpl)\nJavaScript Controllers\u00c2\u00a0(.js)\nWhen Developer Mode is enabled, The Sidecar\u00c2\u00a0JavaScript library references the full JavaScript\u00c2\u00a0files located in ./sidecar/ rather than the concatenated and\u00c2\u00a0minified cached versions. You can turn on Developer Mode by navigating to Admin > System Settings. For more information, please refer to the System documentation.\nNote: This setting should remain off unless developing because it will degrade system performance.\nDiagnostic Tool\nWhen troubleshooting issues, you may find the diagnostic tool to be helpful. This tool will export a zipped package containing the requested diagnostics and is available even if you are hosting your instance on Sugar's cloud service.\nThe diagnostic tool has the ability to export the following:\nSugarCRM config.php\nSugarCRM Custom directory\nphpinfo()\nMySQL - Configuration Table Dumps\nMySQL - All Tables Schema\nMySQL - General Information\nMD5 info\nCopy files.md5\nCopy MD5 Calculated array\nBeanList/BeanFiles files exist\nSugarCRM Log File\nSugar schema output (VARDEFS)\nYou can use the diagnostic tool by navigating to Admin > Diagnostic Tool.\u00c2\u00a0For more information, please refer to the System documentation\u00c2\u00a0in the Administration Guide.\nComposer\nWhen building applications, some developers prefer to use Composer to manage their external dependencies\u00c2\u00a0and make them more intuitive. For more information, please refer to the Composer documentation.\n\u00c2\u00a0\nTopicsDevelopment MethodologyAn overview of code development methodologies for Sugar platform customizationsComposerUsing Composer as a dependency management system for third party libraries.Delivery and Deployment Guide for EnterprisesGuide to customization deployment steps used by Sugar Professional Services when engaged in CRM projects.Sugar 12.3 to 13.0 Migration GuideThe purpose of this document is to provide insight to Sugar Developers for upgrading custom Sugar code, extensions, and integrations to the Sugar 13.0 (Q2 2023) release.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/index.html"}
{"id": "7a1f35b2e450-3", "text": "Last modified: 2023-05-23 16:27:13", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/index.html"}
{"id": "606cd4176aa6-0", "text": "Composer\nOverview\nComposer dependency management\u00c2\u00a0is the de facto standard for managing PHP dependencies. Sugar platform ships with all required code bundled and optimied together for our developers. The installer will, however,\u00c2\u00a0deploy both composer.json and composer.lock in the web root directory as a reference of all dependencies which are controlled by Composer.\nAutoloader\nSugar has a custom autoloader that is\u00c2\u00a0PSR-0 and PSR-4\u00c2\u00a0compliant and integrates with Composer's mapping definitions.\nIntegrations\nWhen updating the Composer configuration, Composer will generate different mappings based on the settings of every dependency:\nClass map\nPSR-0 map\nPSR-4 map\nInclude paths (deprecated)\nSugarCRM's autoloader uses those generated maps directly to initialize itself and to figure out how to load different classes.\nInternals\nTo prevent endless file stats, Sugar's autoloader maintains a full list of all files at its disposal. This list is only generated once and is maintained in ./cache/file_map.php. Most of the Sugar\u00c2\u00a0codebase uses the autoloader to determine whether a file is available rather than performing expensive file_exists calls.\nA second file,\u00c2\u00a0stored\u00c2\u00a0in\u00c2\u00a0./cache/class_map.php\u00c2\u00a0, maintains a flat list of class-name-to-file mappings. When you make any changes to the file system, clear both files before testing new code.\nOptimization\nWhen updating dependencies through Composer, Sugar team uses the optimize flag: composer update --optimize-autoloader --no-dev\". \u00c2\u00a0By doing so, Composer will scan all files in the packages it manages and create a full list of PSR-0 and PSR-4 class name to file mappings, instead of performing this lookup on the fly by the autoloader itself on runtime.\nFrequently Asked Questions\nIs the composer package required to install a Sugar instance?", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Composer/index.html"}
{"id": "606cd4176aa6-1", "text": "Frequently Asked Questions\nIs the composer package required to install a Sugar instance?\nNo. The Sugar installer ships with all required code bundled together. The installer process does not execute any Composer commands. The installer will deploy both composer.json and composer.lock in the web root directory as a reference of all dependencies which are controlled by Composer.\nWhy does Sugar ship ./composer.json and ./composer.lock\u00c2\u00a0if the installer doesn't rely on them?\nComposer is\u00c2\u00a0used\u00c2\u00a0internally\u00c2\u00a0during development to manage Sugar's dependencies on third-party libraries and packages. The Composer files are shipped during development to manage Sugar's dependencies on third-party libraries and packages. The composer files are shipped with the product to give our customers the ability to expand from them.\nIs the Composer package required to upgrade a Sugar instance?\nNo. The Sugar upgrader ships, just like the installer, with all required code bundled together. The upgrade process will validate the present Composer configuration and verify if it is compatible with the upgrade. In the case of a custom configuration, the upgrade process will report any issues which need to be resolved\u00c2\u00a0by the\u00c2\u00a0system administrator\u00c2\u00a0before the upgrade can proceed.\nWhy are there no wildcards in the version constraints? Doesn't composer.lock keep track of exact version numbers?\nThe lock file is designed to lock the dependencies to a specific version, but to protect our customers from unintentionally pulling in newer versions of dependencies owned by SugarCRM, we have chosen to use explicit version numbers in the composer.json file too.\nMay I change the version number of a package?\nYou cannot change version numbers for packages added by Sugar. Sugar will always configure exact version numbers for all of its dependencies. Changing these version numbers will result in an unsupported platform. The version constraints of packages not owned by Sugar may be modified at the developer's discretion.\nCan I use Composer's autoloader?", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Composer/index.html"}
{"id": "606cd4176aa6-2", "text": "Can I use Composer's autoloader?\nWe strongly recommend against using Composer's autoloader. The Sugar autoloader is fully compatible with the PSR-0 and PSR-4 autoloading recommendations from PHP-FIG, which makes the registration of an additional autoloader like the one from Composer redundant. Sugar's autoloader consumes the different mappings which are generated by Composer directly.\nHow can I optimize the autoloader?\nSugar ships with an optimized class map out of the box, which is pre-generated through Composer. This class map contains all different class to file mappings known to the dependencies managed by Composer. When customizing the Composer configuration, it is sufficient to run composer update --optimize-autoloader which will refresh the class map. SugarCRM's autoloader takes full advantage of this optimization.\nCan I load customizations in Sugar through Composer?\nAlthough not yet available out of the box,\u00c2\u00a0we are investigating this as a future capability.\nCan I move the vendor directory out of the web root?\nYou cannot currently move the vendor directory, but we are investigating this as a future capability.\nThe Composer integration in Sugar is not flexible enough for me. What can I do?\nWe continuously strive to make our platform better and to facilitate both end users and developers. Our goal is to deliver a state-of-the-art environment. Do not hesitate to reach out to Sugar Support if we have overlooked your use case\u00c2\u00a0or if there too many constraints in the current implementation to make this a useful feature.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Composer/index.html"}
{"id": "6c6a0dcec1d5-0", "text": "Delivery and Deployment Guide for Enterprises\nOverview\nSugarCRM Professional Services has a set of best practices for managing instances, delivering upgraded customizations, and deploying those upgraded customizations into Sugar on-site for our Enterprise customers. The following is an example of deployment practices used by SugarCRM Professional Services team when engaged on Enterprise Sugar development projects. It does not list all possible customizations that can be made in the system, it is intended to be used as a guide for how to automate the deployment of certain types of customizations into an on-premise Sugar instance. The techniques below\u00c2\u00a0cannot be used with\u00c2\u00a0Sugar's cloud service.\nDeploying Application Configuration and Metadata\nUse Case: Deployment of System Settings\nSystem settings are stored in various places. In this section, we will address each type of storage for settings, and how to migrate each.\n Storage types: \nconfig_override.php\nThis is a file stored in the Sugar root directory that allows for overriding core config values (found in config.php). In the UI, the main place to make changes to this is via Admin -> System Settings\ndatabase 'config' table\nIt is loaded, used, and accessible throughout the Sugar application through the Config API.\nSystem Tab Settings\nForecasting Settings\nPortal Settings\nThis is a simple key/value/category store. There aren't too many components that use this. Here are some:\n\u00c2\u00a0\nconfig_override.php\n System considerations: \nFile System:\nconfig_override.php is placed in Sugar web root directory\u00c2\u00a0\nScripts required\nPHP\nYou will need to write a script to read the current config_override.php and merge the existing array with the new values you'd like to change. This can be done one time, and re-used for all future config_override.php changes\n\u00c2\u00a0\n Steps to migrate: \nAssess the values to be changed, added, or removed", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Delivery_and_Deployment_Guide_for_Enterprises/index.html"}
{"id": "6c6a0dcec1d5-1", "text": "Steps to migrate: \nAssess the values to be changed, added, or removed\nWrite a script to read the existing config_override.php, make the changes to the array, and re-write the file back to the system.\n\u00c2\u00a0\ndatabase 'config' table\n System considerations:\nDatabase:\nThe 'config' table stores all these values. They are stored in a very simple table schema.\nScripts required\nPHP\nWrite a simple PHP script to use Sugar object API. See Figure 1\n\u00c2\u00a0\n Steps to migrate: \nWrite script to use our object API for config table changes (See Figure 1)\nCopy script to Sugar root directory\nExecute the script\nRemove the script\u00c2\u00a0\n Screenshots: \nFigure 1:\n\u00c2\u00a0\n\u00c2\u00a0\nUse Case: Deployment of Reports\nThe customer creates a report in the Reports module. They would like to deploy that report so that end users can all access and run it.\n System considerations:\nDatabase\nRow is inserted into the Reports module (saved_reports table)\n(For new team combinations) Row is inserted into the team_sets table\n(For new team combinations) Rows are inserted into the team_sets_teams table\nScripts required\nSQL\nRetrieve the relevant rows (saved_reports, team_sets, team_sets_teams) and create a SQL script to insert them.\n Additional notes: \nIn the System considerations section, \"new combination of teams\" means that when creating the report, the end user created the Report with a set of teams that doesn't exist on any other record. This results in new entries in the team_sets and team_sets_teams tables.\n Steps to migrate: \nBuild a report in the dev instance\nSelect the database rows associated with that report (saved_reports, possibly team_sets and team_sets_teams tables)\nexample: \"SELECT * FROM saved_reports WHERE id = 'REPORT_ID'\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Delivery_and_Deployment_Guide_for_Enterprises/index.html"}
{"id": "6c6a0dcec1d5-2", "text": "example: \"SELECT * FROM saved_reports WHERE id = 'REPORT_ID'\"\nExport the row/rows into a SQL file\nExecute on the next system\n\u00c2\u00a0\nUse Case: Deployment of Dashboards\nThe customer wants to deploy the pre-built dashboards in an automated way. See Figure 1 below. This example has two dashboards, \"Help Dashboard\" and \"My Dashboard\". Each dashboard has zero or more dashlets.\n System considerations:\nDatabase:\nRow is inserted into the dashboards table for each user dashboard. The metadata column stores all the dashlets associated with that dashboard, and the assigned_user_id column stores the user who will see this dashboard.\nScripts required\nPHP\nAfter deploying the dashboards you will need to run the Quick Repair and Rebuild script found in the admin section.\nCustom scripts: YES (if applying to multiple users)\nBecause users and id are dynamic, if applying to multiple users, you will need a custom script to retrieve those user ids and set them for each sql insert.\nSQL\nScript required to import the entry from the dashboards table.\n Steps to migrate: \nBuild a dashlet against a specific user\nSelect the database rows associated with that user\nexample: \"SELECT * FROM dashlets WHERE assigned_user_id = 'USER_ID'\"\nPick the dashboard you'd like to apply to other users, and export it into a SQL file\nDecide what set of users you need to create the dashboard for.\nWrite a script to pull that list of users, dynamically set the assigned_user_id and id (id must be unique) with the insert query you exported in step 3, and run for each one of those users.\n\u00c2\u00a0\n Screenshots: \nFigure 1\n\u00c2\u00a0\nUse Case: Deployment of Roles\nThe customer wants to deploy the roles in an automated way. This includes creating new roles and updating previously existing roles.\n System considerations:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Delivery_and_Deployment_Guide_for_Enterprises/index.html"}
{"id": "6c6a0dcec1d5-3", "text": "System considerations:\nDatabase:\nRow is inserted into the acl_roles table for each role setting. Depending on how specific the role is, we might have acl_fields and acl_actions mapped to roles through acl_roles_actions\nScripts required\nPHP\nSugar has a SugarACL object API that can be used to create, read, and write roles and role definitions.\u00c2\u00a0\n Steps to migrate: \nWrite a script using our object API to create or write roles\nDefine the metadata for the changes or additions to be made\nWrite logic to add/update based on metadata\nExecute script on dev instance and confirm changes\nUse script to promote to next instance\nNote: See functional sample script below\nhttps://gist.github.com/sadekbaroudi/3191513e2bbce2170326\n\u00c2\u00a0\nUse Case: Deployment of Teams\nThe customer wants to deploy the teams in an automated way. This should be done via the Sugar object API.\n System considerations:\nScripts required\nPHP\nFollow steps in \"Additional Notes\" section below for details on building Team scripts.\nTeamSets are cached per user by SugarCache. \u00c2\u00a0SugarCache should be cleared after installing new teams.\n Additional notes: \nTo build a script to do this, see the following:\nmodules/Teams/Save.php\nThis file is called when a user posts data through the form in the UI. This code should be replicated (until the Teams module is refactored).\nmodules/Teams/Team.php\nfunction save() - this should be called as part of the save\nfunction mark_deleted() - this should be called on the object when you want to delete a team, be sure to make sure there are no related users before doing so.\n Steps to migrate: \nWrite a script using our Teams object API\nCreate needed team object\nSet appropriate data on object and/or POST data\nAfter saving, potentially add users to the team", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Delivery_and_Deployment_Guide_for_Enterprises/index.html"}
{"id": "6c6a0dcec1d5-4", "text": "Set appropriate data on object and/or POST data\nAfter saving, potentially add users to the team\nExecute script on dev instance and confirm changes\nUse script to promote to next instance\n\u00c2\u00a0\nUse Case: Deployment of User Settings\nThe customer wants to deploy the user settings in an automated way. There are a couple of places where we store User settings.\n Storage types: \nUser Preferences\nThis is a key value pair with a serialized and then base64 encoded value. We store many user preferences, all encoded. These are non-critical settings, and can be blown away. However, doing so will require the user to reconfigure their preferences. The data is stored in the user_preferences table. This includes data such as: \u00c2\u00a0Subpanel display order,\u00c2\u00a0Timezone preferences, etc.\nUsers module settings\n\u00c2\u00a0These are direct values on the Users module (users table). Here we track persistent User attributes such as:\u00c2\u00a0Address,\u00c2\u00a0Phone number,\u00c2\u00a0etc\u00c2\u00a0\nUser preferences\n System considerations:\nDatabase:\nRow is inserted into the user_preferences table for each user setting change.\nScripts required\nPHP\u00c2\u00a0\nIn order to update values with a user's preferences, you would need to write a custom script to read, update, and rewrite to the user_preferences table\u00c2\u00a0\n Steps to Migrate: \nWrite a script using our User Preferences API\nQuery the database to retrieve the row for a given user\nbase64 decode the value\nunserialize the value\nupdate the data required\nserialize the data\nbase64 encode\nrewrite the row to the database\n(repeat for all applicable users)\n(See modules/UserPreferences/UserPreference.php or modules/Users/User.php, specifically getPreference() and setPreference())\nLoad the User object\nCall getPreference for the specified value\nMake changes\nCall setPreference for the specified value\nBetter performance method (direct database queries and updates):", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Delivery_and_Deployment_Guide_for_Enterprises/index.html"}
{"id": "6c6a0dcec1d5-5", "text": "Call setPreference for the specified value\nBetter performance method (direct database queries and updates):\nMore robust, but slower performance method (API):\n\u00c2\u00a0\nUser table\n\u00c2\u00a0\n System considerations:\nDatabase:\nUsers table is updated\nScripts required:\nSQL\nYou can directly update the Users table directly, provided the data is not encoded or encrypted (like password).\n\u00c2\u00a0\n Steps to Migrate: \nWrite a SQL script to update values in the users table based on need\nExecute script on dev instance and confirm changes\nUse script to promote to next instance\n\u00c2\u00a0\nUse Case: Deployment of custom fields\nA user wants to deploy custom fields created in an automated way. This includes anything created through Studio.\n System considerations: \nFile System:\nFiles are potentially created in the following directories:\nCustom field vardef:custom/Extension/modules/<module_name>/Ext/Vardefs/sugarfield_<field_name>.php\nCustom field label (and app_list_string if necessary): ./custom/Extension/modules/Accounts/Ext/Language/en_us.lang.php\nDatabase:\nThe <module_name>_cstm table is created, if it doesn't already exist.\nThe field <field_name>_c is created against that table\nScripts required\nA Quick Repair and Rebuild is required after copying the files and fields_meta_data table values.\nSQL\nYou will need to insert the relevant entries from the fields_meta_data table\n Steps to migrate: \nExport the fields_meta_data entries for the custom fields into a script\nCopy the files for the custom fields\nApply #1 and #2 to another system, and execute a Quick Repair and Rebuild\nExecute the DDL generated by the QRR above\n\u00c2\u00a0\nUse Case: Deployment of custom modules", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Delivery_and_Deployment_Guide_for_Enterprises/index.html"}
{"id": "6c6a0dcec1d5-6", "text": "\u00c2\u00a0\nUse Case: Deployment of custom modules\nA developer creates a custom module and wants to deploy it, this use case refers to a basic module, because each additional feature (logic hooks, relationships,dependencies, etc) has its\u00c2\u00a0 own deployment scenario.\n System considerations: \nFile System:\n./custom/Extension/application/Ext/Include/<package_name>.php\n./modules/<new_module>/*\n./custom/modules/<new_module>/*\n./custom/themes/default/images/*<new_module>*.(gif/png)\n./custom/Extension/modules/<new_module>/*\nDatabase:\nnew tables <new_module> and <new_module>_audit\nNote: the DDL gets generated by the Quick Repair and Rebuild script, at which point you can execute manually or automatically\nfields_meta_data table\nNote: this stores all the custom fields built through Studio (not Module Builder) after the module is deployed. Make sure you retrieve all rows from this table that apply to this module and create a SQL script to insert into the next system\nScripts required\nAfter deploying the custom module, you will need to run the Quick Repair and Rebuild script found in the admin section.\nSQL\nScript required to import the entry from the <new_module> and <new_module>_audit table.\nScript required to import fields_meta_data table entries for this module (if there are any)\n Additional notes: \nFor a full custom module deployment scenario, this deployment scenario should be ran first then all of the extended module features deployment scenarios should be run:\n Steps to migrate: \nCopy all files listed in file system section above\nExport fields_meta_data table entries as apply to the custom module (if any)\nRun Quick Repair and Rebuild\nEither manually or automatically run the DDL output from QRR\nTest functionality\u00c2\u00a0\nUse Case: Deployment of custom Relationships", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Delivery_and_Deployment_Guide_for_Enterprises/index.html"}
{"id": "6c6a0dcec1d5-7", "text": "Test functionality\u00c2\u00a0\nUse Case: Deployment of custom Relationships\nA user wants to deploy custom relationships created in an automated way. This includes anything created through Studio.\u00c2\u00a0\nFollow the same instructions as for Custom\u00c2\u00a0Fields, but:\nIgnore the fields_meta_data table\nBe sure to consider the following:\ncustom/Extension/modules/<side_1_of_relationship>/Ext/\ncustom/Extension/modules/<side_2_of_relationship>/Ext/\ncustom/Extension/modules/relationships/\nOtherwise, the same process applies.\nUse Case: Deployment of custom View or Layout metadata (Web)\nThe user creates custom layouts and views for web from studio and wants to deploy them.\n System considerations: \nFile System:\nLayouts:\n./custom/modules/<module>/clients/<platform>/layouts/<layout>/ <layout>.php\nViews\nCreating a layout from Studio actually augments the Sidecar view metadata instead of Sidecar layout metadata\n./custom/modules/<module>/clients/<platform>/views/<layout>/ <layout>.php\nScripts required\nAfter deploying you will need to run the Quick Repair and Rebuild script found in the admin section.\u00c2\u00a0\n Additional notes: \nFor layouts(record) you have the option to simply save the modified layout. In this case the metadata for the layout can be found in ./custom/working/modules/<module>/<platform>/views/<view>/<view>.php\nLayouts created from studio create views in .custom/modules/<module>/viewsThe created views can be record | list | selection-list\nFor the two popup layouts(created from studio), extra metadata is provided in the ./custom/modules/<module>/metadata/popupdefs.php\n\u00c2\u00a0\nUse Case: Deployment of custom View or Layout metadata (mobile)\nThe user creates custom layouts and views for mobile from studio and wants to deploy them.\n System considerations: \nFile System: YES\nLayouts:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Delivery_and_Deployment_Guide_for_Enterprises/index.html"}
{"id": "6c6a0dcec1d5-8", "text": "System considerations: \nFile System: YES\nLayouts:\n./custom/modules/<module>/clients/mobile/layouts/<layout>/ <layout>.php\nViews\n./custom/modules/<module>/clients/mobile/views/<view>/ <view>.php\nDatabase: NO\nScripts required\nAfter deploying you will need to run the Quick Repair and Rebuild script found in the admin section.\n Additional notes: \nLayouts and views are handled the same as with web. From Studio, you can augment detail, edit and list views.\nDeploying Application Code and Integrations\nUse Case: Deployment of custom CSS (LESS)\n\u00c2\u00a0\nIn order to update branding, developers can deploy customized CSS.\n System considerations: \nFile System: YES\u00c2\u00a0\n./custom/themes/custom.less\nScripts required\nYou will need to run the Quick Repair and Rebuild script found in the admin section to rebuild the Sugar CSS bundles.\nUse Case: Deployment of Logic Hooks and Web Logic Hooks\nThe developer\u00c2\u00a0creates custom logic hooks, they want to deploy them.\n System considerations:\n Logic Hook: \nFile System: YES\u00c2\u00a0\napplication hooks :\n./custom/Extension/application/Ext/LogicHooks/<file>.php\nmodule specific hooks:\n./custom/Extension/modules/<module>/Ext/LogicHooks/<file>.php\nScripts required\nYou will need to run the Quick Repair and Rebuild script found in the admin section to rebuild the extensions.\n  Web Logic Hook:  \nDatabase: YES\nOnly for weblogic hooks : row is inserted into the weblogichooks table.\u00c2\u00a0\nScripts required\nAfter deploying the custom hooks and database entry in the weblogichooks table, you will need to run the Quick Repair and Rebuild script found in the admin section.\nSQL\nScript required to import the entry from the weblogichooks table.\nUse Case: Deployment of custom API endpoints", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Delivery_and_Deployment_Guide_for_Enterprises/index.html"}
{"id": "6c6a0dcec1d5-9", "text": "Use Case: Deployment of custom API endpoints\nThe user creates a custom api endpoints, he wants to deploy them.\u00c2\u00a0\n System considerations: \nFile System\nclients/<platform>/api/*\nmodules/:module/clients/<platform>/api/*\ncustom/clients/<platform>/api*\ncustom/modules/<module>/clients/<platform>/api/*\nScripts required\nAfter deploying the custom api you will need to run the Quick Repair and Rebuild script found in the admin section. This will rebuild the ./cache/file_map.php and ./cache/include/api/ServiceDictionary.rest.php files to make\u00c2\u00a0your endpoint available.\n Additional notes: \nLogic for how api endpoints are loaded, can be found in ./include/api/ServiceDictionary.php (where api endpoints are loaded from, how they are built on Quick Build and Repair, etc.)\nUse Case: Deployment of custom Administration Panels\nThe user creates custom administration panels, and wants to deploy them.\n System considerations: \nFile System:\n./custom/Extension/modules/Administration/Ext/Administration/<file>.php\n./custom/Extension/modules/Administration/Ext/Language/<langtype.name>.php\n./custom/themes/default/images/<icon_image_name>.<img_extension>\n and depending on the    admin panel url, either   : \n./custom/modules/<linkUrlModule>/*\nor\n./custom/modules/<linkUrlModule>/clients/base/layouts/<route_name>/*\n./custom/modules/<linkUrlModule>/clients/base/views/<route_name>/*\nScripts required\nAfter deploying the admin panels, you will need to run the Quick Repair and Rebuild script found in the admin section.\n Additional notes: \nThe admin url can specify new sidecar routes, old bwc routes, edit view files, plain scripts, or just open a drawer. Determining the additional resources to be copied may be impossible without a standard in place.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Delivery_and_Deployment_Guide_for_Enterprises/index.html"}
{"id": "6c6a0dcec1d5-10", "text": "Use Case: Deployment of custom Jobs / Schedulers\nThe user creates custom jobs and schedulers, and wants to deploy them.\n System considerations: \nFile System: YES:\n./custom/Extension/modules/Schedulers/Ext/ScheduledTasks/<jobname>.php\n./custom/Extension/modules/Schedulers/Ext/Language/<langtype.jobname>.php\nDatabase: YES\nRow is inserted into the schedulers table, if a job is added as a scheduled job using\u00c2\u00a0Administration > Scheduler.\nScripts required\nAfter deploying the custom jobs, you will need to run the Quick Repair and Rebuild script found in the admin section.\nSQL\nScript required to import the entry from the schedulers table.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Delivery_and_Deployment_Guide_for_Enterprises/index.html"}
{"id": "efa75352ce88-0", "text": "Sugar 12.3 to 13.0 Migration Guide\nOverview\nThe purpose of this document is to provide insight to Sugar Developers for upgrading custom Sugar code, extensions, and integrations to the Sugar 13.0 (Q2 2023) release.\u00c2\u00a0\nCloud and On-Site Sugar Release\nFor those looking to upgrade from Sugar 12.0, you will be catching up with additional content released in the 12.1 (Q3 2022), 12.2 (Q4 2022), and 12.3 (Q1 2023) cloud-only Sugar releases. In addition to this guide, please review the\u00c2\u00a0Sugar 12.1,\u00c2\u00a0Sugar 12.2, and\u00c2\u00a0Sugar 12.3\u00c2\u00a0migration guides and the release\u00c2\u00a0notes linked below to get a full view of changes since Sugar 12.0.\nREST API Version Number\nThe current version for the Sugar REST API is 11_20.\u00c2\u00a0\nChanges That May Affect Developers\nThe changes in\u00c2\u00a0Sugar 13.0 (Q2 2023) that could cause an immediate impact on customizations and integrations that were built for earlier versions of Sugar are highlighted in the following Developer Blog post in the SugarClub community:\u00c2\u00a0\nSugar 13.0 (Q2 2023) Customization Guide\nRelated Documents\nFor more information about what changed in Sugar 13.0.x, please refer to the following related documents:\nWhat to Expect When Upgrading to Sugar 13.0 (Q2 2023)\n13.0.0 Upgrade Paths\n13.0 Installation and Upgrade Guide\n13.0.x Supported Platforms\nRelease Notes\nSugar Sell 13.0.0 Release Notes\nSugar Serve 13.0.0 Release Notes\nSugar Enterprise 13.0.0 Release Notes", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Migration_Guide/index.html"}
{"id": "efa75352ce88-1", "text": "Sugar Enterprise 13.0.0 Release Notes\n  \tLast modified: 2023-04-05 00:05:28", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Migration_Guide/index.html"}
{"id": "32805dcbf4a7-0", "text": "Development Methodology\nOverview\nThis page\u00c2\u00a0discusses\u00c2\u00a0standard\u00c2\u00a0practices that we recommend for improving the success rates of\u00c2\u00a0Sugar\u00c2\u00a0development projects.\u00c2\u00a0\nDevelopment Best Practices\nWhen developing Sugar\u00c2\u00ae customizations as part of an on-site CRM project implementation, we recommended placing the entire Sugar application filesystem under source code management. Sugar developers know that customizations made to Sugar are placed under the ./custom/ directory. But during the lifecycle of a CRM implementation, you will need to upgrade Sugar versions, which will change core files. Many projects will also need to track other related project files that may not all be Sugar platform code. For example, pre-flight SQL scripts, data migration scripts, Web server configuration settings, etc.\nFor SugarCloud projects and ISVs, if you are building a custom module package or integration designed to be installed into many Sugar instances (including SugarCloud instances), then tracking only ./custom/ directory files should be enough.\nUsing .gitignore Files\nToday, many developers choose to use Git as their source control management. There are certain Sugar application files that you do not want to track; most of these are generated files that are created at runtime or are Sugar instance-specific configuration files.\nBelow is a sample .gitignore file that you can use or adapt to the source control management system of your choice.\n*.log\n/.htaccess\n/config.php\n/config_override.php\n/cache\n/upgrades/module\n/upload\n/custom/blowfish\n/custom/history\n/custom/application/Ext\n/custom/modules/*/Ext\n/custom/Extension/**/*orderMapping.php\nRecommendations for Development Teams\nCode quality is important to maintain because Sugar customizations run in the same environment as the rest of the Sugar application. Here are a few best practices to help\u00c2\u00a0development teams uphold code quality.\nAdopt an appropriate Git workflow for development. For reference, see Atlassian's tutorial on Git workflow options.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Development_Methodology/index.html"}
{"id": "32805dcbf4a7-1", "text": "Develop within feature branches that are tested before being merged back into master to keep master stable.\nAvoid workflows that involve developers committing directly into the master branch to prevent\u00c2\u00a0code destabilization.\nDevelopment teams should always perform code reviews before merging in new code.\nDeploying Sugar Code\nWhere you plan to deploy Sugar code is the biggest factor in determining how Sugar code should be deployed and how your project should be managed.\nAre you working on a Sugar project for an on-premise Sugar implementation? Are you working on a custom module that you plan on distributing through SugarExchange? Are you planning a solely REST API integration? The answers to these questions guide how you should develop and deploy Sugar code.\nSugar on-site\u00c2\u00a0projects :\u00c2\u00a0Develop these customizations using the exact version and flavor of Sugar that you plan to use in production.\nSugarCloud\u00c2\u00a0projects :\u00c2\u00a0Develop these customizations on the latest available version of Sugar for the particular flavor the customer has purchased.\nCustom modules or integrations : If you plan on distributing your customization to many Sugar customers via SugarExchange or channel partners,\u00c2\u00a0design your customization with Sugar's cloud service in mind.\nSugar's cloud service is more restrictive than our on-site installs regarding supported customizations.\nA customization designed for Sugar's cloud service can\u00c2\u00a0be supported in Sugar on-site instances, but the inverse is not always true.\nFor more information on Sugar's cloud service restrictions, please refer to the SugarCloud Policy Guide.\nPackaging\nThe packaging of customizations is not a concern for many Sugar projects. Many projects just use Git (or some other file version control) to manage the distribution and deployment of Sugar code customizations. However, there are situations where the packaging of Sugar customizations is necessary.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Development_Methodology/index.html"}
{"id": "32805dcbf4a7-2", "text": "If you plan on distributing Sugar custom code, then you must package your customization as a Module Loadable Package\u00c2\u00a0(a .zip file that includes all custom code along with a manifest file). It is easy to write a script to build a module loadable package either from custom directory content or by extracting customizations out of a development environment. See examples on Github here and here.\nNote: Sugar Sell Essentials customers do not have the ability to upload custom file packages to Sugar using Module Loader.\nIn some Enterprise environments, changes are tightly controlled, and ownership of various Sugar application components may be spread across multiple teams, requiring a coordinated deployment. For example, a Database Administrator (DBA) may be responsible for implementing database schema (DDL) changes and a System Administrator may be responsible for implementing file system changes.\nFor these situations:\nFile system changes can be accounted for using Git to determine the difference between current production state and the latest changes to be deployed.\nDDL changes can be accounted for via deploying latest file system changes on a clone of Sugar production instance and running Quick Repair command. Sugar will prompt you with any DDL changes that need to be made that you can then capture and share with your DBA.\nData Manipulation Language (DML) changes, if necessary, should be managed within SQL or PHP scripts.\nDeployment\nIf using the traditional Git-based deployment, then deploying new Sugar code is as easy as checking out the latest branch and then running Quick Repair and Rebuild. Run the quick repair from the Sugar user interface, or\u00c2\u00a0script\u00c2\u00a0it\u00c2\u00a0for fully automated deployment.\nWhen deploying to an instance on Sugar's cloud service, it is necessary to install\u00c2\u00a0the package\u00c2\u00a0manually using Module Loader. It is not possible to automate the deployment of packages into instances on Sugar's cloud service.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Development_Methodology/index.html"}
{"id": "32805dcbf4a7-3", "text": "In a coordinated deployment, database changes should be deployed first, followed by filesystem changes, followed by a Quick Repair (if permitted) to clear system caches. You can clear caches manually by deleting the contents of the ./cache/ directory and then truncate the metadata_cache table in the Sugar database. The Sugar application regenerates these caches as needed.\nUsing Sugar Studio to deploy changes into new environments (especially Production) is not recommended. Manually re-creating customizations using the Studio user interface can be error-prone. It also runs the risk of\u00c2\u00a0inadvertently\u00c2\u00a0overwriting other code customizations. It may be initially slower to create a custom field, etc.\u00c2\u00a0manually using extensions on filesystem but, in the\u00c2\u00a0long run, you benefit from better change management and automation.\nManaging Multiple Environments\nCRMs are business-critical applications so development should never be performed directly on your production environment. A typical Sugar project involves multiple staging environments as well as individual development environments that each Sugar developer uses for actual coding.\nSugarCRM recommends 4 different environments:\nProduction environment : used by real users\nUser Acceptance Test (UAT) environment : used by business stakeholders to sign off on changes that go into production\nQuality Assurance environment : used for test and validation of new features and bug fixes\nDevelopment environments : used by individual Sugar developers to create and test code (often running on a local laptop or PC)\nCode changes that flow upstream from a development environment should not be allowed into production without going through quality assurance (QA) and user acceptance testing (UAT) first. The intermediate environments serve as gates between development and production that help\u00c2\u00a0intercept problems before they reach production.\nUser and CRM data that needs to flow downstream from production environment should pass through intermediate environments as well to ensure consistency and that it is cleaned or anonymized of any personally identifiable or sensitive information.\nConsistency", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Development_Methodology/index.html"}
{"id": "32805dcbf4a7-4", "text": "Consistency\nMaintaining as much consistency as possible for each of these environments is essential. Inconsistent environments can create issues where bugs are reproducible in one environment and not others (for example, a bug that only appears in production). Many times, these bugs are traced to configuration parameters that are not directly related to Sugar or the features and customizations under development.\nTo replicate your production environment as accurately as possible,\u00c2\u00a0we recommend you use VM or container technology in your development and QA environments.\nYour UAT environment should match the infrastructure of your production environment.\nSugarCRM uses a variety of container technologies in developing the core Sugar application and for working on Sugar projects. In particular, we use Virtual Box, VMWare, Amazon AMIs, Docker containers, Vagrant, and Packer. SugarCRM Engineering also uses Puppet to centrally manage the provisioning and configuration of all these different environments.\nTesting\nSugarCRM recommends using a variety of testing methods to ensure the quality of your Sugar project. Perform unit testing, functional testing (either manual or GUI automation), system integration testing, user acceptance testing, and performance testing.\nUnit testing should be applied to ensure that even the smallest code units within your application are behaving as expected.\nFunctional testing should be performed to ensure that each feature and function behaves the way it was designed.\nSystem Integration testing should be performed to ensure that Sugar co-exists with external systems and that data flows between all these systems successfully.\nUser acceptance testing should be performed by key stakeholders to ensure that your project is meeting business requirements.\nPerformance testing should be performed to ensure that the Sugar application's responsiveness meets user expectations and that the application continues to scale.\nIn our experience, neglecting any of these tests can negatively impact a Sugar project in terms of maintainability, customer satisfaction, and business success.\u00c2\u00a0\nIn the next section, we introduce some tools and open-source resources that can help you start a QA practice for your project.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Development_Methodology/index.html"}
{"id": "32805dcbf4a7-5", "text": "Sugar Test Tools\nFor Sugar customers and partners,\u00c2\u00a0SugarCRM provides Test Tools\u00c2\u00a0that can be used to verify and perform quality assurance on Sugar customizations. Use of Sugar test technology requires familiarity with PHPUnit for PHP unit testing, Jasmine for JavaScript unit testing, and Apache JMeter for performance load testing.\nSugar Unit Tests\nThe Sugar Unit Test suites are the automated unit tests developed and maintained by SugarCRM Engineering during the process of building and releasing each new Sugar release. As part of our development process, these tests are required to run \"green\" (100% passing) at all times on each master release branch. Essentially, these tests form a regression test suite for an uncustomized version of Sugar running in our controlled build environment.\nWith that understanding, here is a recommended approach to take advantage of these unit tests.\nRun test suite against an uncustomized copy of Sugar in your development environment to establish a baseline. Not all tests may immediately pass; some may fail due to configuration differences between your development environment and SugarCRM Engineering's controlled build environment.\nCorrect any observed failures or skip/remove the failing tests to create a base test suite that is 100% passing.\nAs you develop customizations on Sugar, ensure that your base test suite continues to pass.\nCreate new tests for new code customizations that you create.\nSugar Performance Tests\nInstead of sanitizing data from a production environment for purposes of load testing, SugarCRM provides an open source tool called Tidbit that can be used to generate pseudo-random data to populate a Sugar instance with representable data.\nWe also provide Apache JMeter scenarios to Sugar customers and partners who request access. These JMeter scenarios can be used to drive a simulated load against the Sugar REST API interface used by Sugar. They can validate that your customizations have not had an unexpected impact on the performance of a Sugar instance.\nDevOps", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Development_Methodology/index.html"}
{"id": "32805dcbf4a7-6", "text": "DevOps\nIn order to facilitate and streamline development processes, Sugar recommends implementing DevOps automation. Use a tool such as Jenkins to orchestrate test automation, stage changes in any environment (dev, QA, UAT, and prod) for manual verification, and manage the promotion of changes from one environment to the next.\nPerform automated tests (e.g. unit tests) on each commit.\nStage development changes on at least a nightly basis for use by QA or demos.\nAutomate the rollback of changes in any environment as needed.\nAutomate notifications to affected and responsible parties whenever a test fails, or a build fails to deploy.\nCo-Existing with Studio Customizations\nSugar Studio and Module Builder enable administrator users to implement quick changes to a Sugar environment. But Sugar Studio lacks the rigorous change control that larger CRM projects need. Sometimes, Studio changes can even break code-level Sugar customizations. For this reason, we often discourage using Studio on heavily customized Sugar instances.\nHowever, if Sugar Studio is an important up-front requirement for a CRM project, then there are strategies you can adopt for your customizations to avoid conflicts.\nSugar Studio can be used to modify the layouts, fields, and relationships for the majority of modules in Sugar. Module Builder can be used to define new modules along with their layouts, fields, and relationships. In practice, this means that the fields and layouts for any module's record view, list view, mobile view, and subpanels can be customized using simple administration tools.\nStudio users, therefore, could potentially break code customizations that are reliant on a particular field or having a field on a particular layout or location. Here are some practices to avoid conflicts between Studio customizations and custom code:\nAvoid custom record, list, and subpanel view controllers because Studio users can change fields and layouts that affect expectations within your controller code.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Development_Methodology/index.html"}
{"id": "32805dcbf4a7-7", "text": "Avoid custom record validations because Studio users can change fields and layouts that affect expectations within your validation code.\nAvoid hard-coded integrations that rely on a particular field because Studio users can change fields that affect expectations within your integration.\nAvoid new field and relationship vardefs customizations because Studio users can create new fields and relationships.\nAvoid viewdefs\u00c2\u00a0customizations for record, list, and subpanel layouts because Studio users perform these customizations.\nMany customizations have a smaller risk of side effects related to Studio customizations. Here is a list of some changes that administrator users cannot perform via Studio:\nAdding custom dashlets\nAdding custom layouts or additions to footer or header\nAdding custom actions in record view action dropdown\nAdding metadata-aware integrations that discover fields and modules on the system\nAdding logic hooks\nConversely, certain customizations can provide Studio users with additional tools:\nAdding custom Sugar Logic functions\nAdding custom Sugar field types\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Introduction/Development_Methodology/index.html"}
{"id": "7acb3ea93bdd-0", "text": "Cookbook\nWelcome to the SugarCRM Developer Cookbook! This library is filled with real-world code examples for common Sugar customizations and best practices. Sugar's DevClub is always cooking up new ideas, so be sure to check in often and see what's new. Get started by browsing the categories below.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/index.html"}
{"id": "7acb3ea93bdd-1", "text": "TopicsAdding Buttons to the Record ViewThis example explains how to create additional buttons on the record view and add events. We will extend and override the stock Accounts record view to add a custom button. The custom button will be called \"Validate Postal Code\" and ping the Zippopotamus REST service to validate the records billing state and postal code.Adding Field Validation to the Record ViewThis page explains how to add additional field validation to the record view. In the following examples, we will extend and override the stock Accounts record view to add custom validation. The custom validation will require the Office Phone field when the account type is set to \"Customer\" and also require the user to enter at least one email address.Adding an Existing Note to an Email as AttachmentThere may be times when you want to reuse a file attached to one Note record as an attachment for an Email, similar to the ability in the Compose Email view to add an attachment using 'Sugar Document'.Adding the Email Field to a BeanThis example explains how to add an emails field for modules that don't extend the Person module template. We will create an email field and bring the email functionality module bean. The steps are applicable for stock and custom modules. In this example, we will add the email field into the Opportunities module.Converting Address' Country Field to a DropdownAddress fields in Sugar\u00c2\u00ae are normally text fields, which allow users to enter in the appropriate information (e.g. street, city, and country) for the record. However, with multiple users working in Sugar, it is possible for data (e.g. country) to be entered in a variety of different ways (e.g. USA, U.S.A, and United States) when creating or editing the record. This can cause some issues when creating a report grouped by the Billing Country field, for example, as records with the same country will be grouped separately based on the different ways the country was entered.Changing the Default Module When Logging a New", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/index.html"}
{"id": "7acb3ea93bdd-2", "text": "grouped separately based on the different ways the country was entered.Changing the Default Module When Logging a New Call or MeetingWhen creating a call or meeting directly from the Calls or Meetings module in Sugar, the default module for the Related To field is Accounts. If your sales team frequently schedules calls and meetings related to records from a module other than Accounts, it may make sense to adjust the behavior so that the Related To field defaults to a more commonly used module. This article covers how to change the default related module for calls and meetings in Sugar.Creating Custom Field TypesIn this example, we create a custom field type called \"Highlightfield\", which will mimic the base text field type with the added feature that the displayed text for the field will be highlighted in a color chosen when the field is created in Studio.Creating an Auto-Incrementing FieldThis article will cover the two approaches to creating an auto-incrementing field in Sugar.Customizing Prefill Fields When Copying RecordsThe copy action on the record view allows for users to duplicate records. This article will cover the various ways to customize the prefill fields on the copy view.Customizing the Email Editor ButtonsThe Emails module in Sugar\u00c2\u00ae displays commonly-used buttons in the HTML editor. This article explains how to modify the buttons on the editor's toolbar.Customizing the Start Speed of List View SearchWhen searching a Sidecar module's list view, Sugar\u00c2\u00ae begins returning results automatically once a predefined number of milliseconds have passed. This article covers how to customize the start speed of the list view search for Sidecar modules in Sugar.Disabling RLI Alerts on OpportunitiesHow to disable Revenue Line Item (RLI) alerts on Opportunities using a custom JavaScript controller.Disabling TooltipsThis article will demonstrate how to disable the tooltips in Sugar.Dynamically Hiding Subpanels Based on Record ValuesThis article will demonstrate how to dynamically hide subpanels that are dependent on record values by overriding the subpanels layout for a module. This example is for an account record where", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/index.html"}
{"id": "7acb3ea93bdd-3", "text": "record values by overriding the subpanels layout for a module. This example is for an account record where we will hide the Contacts subpanel when the account type is not 'Customer'.Enabling Importing for Custom ModulesWhen designing a custom module in Module Builder, you have the option to enable importing for the module. If the custom module is deployed without enabling this option, it is not recommended that you redeploy the module since any changes made in Studio and potentially other areas of the application could be lost. This article will cover how to enable importing for custom modules via a code-level change to preserve any additional configurations made to the module since being deployed from Module Builder.Increasing the Number of Dashboards Displayed in the Home MenuBy default, the \"Home Dashboard\" comes out-of-the-box with Sugar\u00c2\u00ae to display on the home page. In addition, Sugar users with a Sugar Serve and/or Sugar Sell license type will have access to specialized Home page dashboards called \"Service Console\" and \"Renewals Console\". Users have the ability to create new dashboards on their home page and build out its layout and dashlet set. Currently, Sugar imposes a limit of 50 dashboards that can be displayed under the Home module tab. So, when creating multiple dashboards, keep in mind that having more than 50 in the list of available dashboards will cause the ones in the beginning to be dropped off the list. This article covers how to increase the number of dashboards allowed in the Home menu via a code-level customization.Logic HooksThese pages demonstrate some common examples of working with logic hooks in Sugar.Modifying Calendar Item ColorsEach calendar event type (Meetings, Calls, and Tasks) has its own distinct color scheme. This article will review how to modify these colors, as well as demonstrate how to set the event color based on the event status.Modifying Layouts to Display Additional ColumnsBy default, the record view layout for each module displays two columns of fields. The number of", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/index.html"}
{"id": "7acb3ea93bdd-4", "text": "ColumnsBy default, the record view layout for each module displays two columns of fields. The number of columns to display can be customized on a per-module basis with the following steps.Modifying Subpanel ButtonsSeveral buttons exist on each subpanel by default such as \"Create\" (+ Plus symbol) and \"Link Existing Record\". These buttons are controlled by the panel-top view for each module. To make changes to the buttons included in a subpanel layout, you will need to create an override for the panel-top view in ./custom/Extension/modules/<module>/Ext/clients/base/views/panel-top/ and update the corresponding buttons property to include or exclude a button.Module Loadable PackagesExamples working with the module loadable packages.Moving Footer content to Sidebar NavThis example explains how to add additional buttons to a new section in the sidebar nav layout. You may have previously customized a button that was added to the footer layout, which can be repurposed here and added to the sidebar-nav layout. We will create a custom view and append the view component to the sidebar-nav layout metadata. The additional button will merely show an alert and a flyout menu with a link to the Accounts module but can be expanded to do much more.Passing Data to TemplatesThis page explains how to create a custom view component that passes data to the Handlebars template.Prepopulating the Compose Email ViewWhen composing an email in Sugar, it may be useful to modify the compose view to better suit your common business practices. In this article, we will use JavaScript to create a code-level customization which causes the To, CC, and Subject fields of the email to prepopulate with data from a related Opportunity.Refreshing Subpanels on the RecordViewHow to refresh specific subpanels on the Record View.Removing the Account Requirement on OpportunitiesThis article covers how to remove the Account field from being required on the Opportunities module.Web ServicesExamples when working with Sugar's web service endpoints.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/index.html"}
{"id": "7acb3ea93bdd-5", "text": "Last modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/index.html"}
{"id": "2417d3f18db5-0", "text": "Adding the Email Field to a Bean\nOverview\nThis example explains how to add an emails field for modules that don't extend the Person module template. We will create an email field and bring the email functionality module bean. The steps are applicable for stock and custom modules. In this example, we will add the email field into the Opportunities module.\nSteps to Complete\nThis tutorial requires the following steps, which are explained in the sections below:\nCreating a Custom Vardef file for email Field and Relationships\nCreating a Custom Bean and Modify the save function\nReplacing the stock bean with the custom bean\nAdding Emails Field into Record View\nCreating a Custom Vardef file for email Field and Relationships\nYou will create a file in the custom/Extension/modules/Opportunities/\u00c2\u00a0folder for the field and relationships definitions.\n./custom/Extension/modules/Opportunities/Ext/Vardefs/custom_email_field.php\n<?php\n$module = 'Opportunity';\n$table_name = 'opportunities';\n$dictionary[$module]['fields']['email'] = array(\n    'name' => 'email',\n    'type' => 'email',\n    'query_type' => 'default',\n    'source' => 'non-db',\n    'operator' => 'subquery',\n    'subquery' => 'SELECT eabr.bean_id FROM email_addr_bean_rel eabr JOIN email_addresses ea ON (ea.id = eabr.email_address_id) WHERE eabr.deleted=0 AND ea.email_address LIKE',\n    'db_field' => array(\n        'id',\n    ),\n    'vname' => 'LBL_EMAIL_ADDRESS',\n    'studio' => array(\n        'visible' => true,\n        'searchview' => true,\n        'editview' => true,\n        'editField' => true,\n    ),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_the_Email_Field_to_a_Bean/index.html"}
{"id": "2417d3f18db5-1", "text": "'editField' => true,\n    ),\n    'duplicate_on_record_copy' => 'always',\n    'len' => 100,\n    'link' => 'email_addresses_primary',\n    'rname' => 'email_address',\n    'module' => 'EmailAddresses',\n    'full_text_search' => array(\n        'enabled' => true,\n        'searchable' => true,\n        'boost' => 1.50,\n    ),\n    'audited' => true,\n    'pii' => true,\n);\n$dictionary[$module]['fields']['email1'] = array(\n    'name' => 'email1',\n    'vname' => 'LBL_EMAIL_ADDRESS',\n    'type' => 'varchar',\n    'function' => array(\n        'name' => 'getEmailAddressWidget',\n        'returns' => 'html',\n    ),\n    'source' => 'non-db',\n    'link' => 'email_addresses_primary',\n    'rname' => 'email_address',\n    'group' => 'email1',\n    'merge_filter' => 'enabled',\n    'module' => 'EmailAddresses',\n    'studio' => false,\n    'duplicate_on_record_copy' => 'always',\n    'importable' => false,\n);\n$dictionary[$module]['fields']['email2'] = array(\n    'name' => 'email2',\n    'vname' => 'LBL_OTHER_EMAIL_ADDRESS',\n    'type' => 'varchar',\n    'function' => array(\n        'name' => 'getEmailAddressWidget',\n        'returns' => 'html',\n    ),\n    'source' => 'non-db',\n    'group' => 'email2',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_the_Email_Field_to_a_Bean/index.html"}
{"id": "2417d3f18db5-2", "text": "'source' => 'non-db',\n    'group' => 'email2',\n    'merge_filter' => 'enabled',\n    'studio' => 'false',\n    'duplicate_on_record_copy' => 'always',\n    'importable' => false,\n    'workflow' => false,\n);\n$dictionary[$module]['fields']['invalid_email'] = array(\n    'name' => 'invalid_email',\n    'vname' => 'LBL_INVALID_EMAIL',\n    'source' => 'non-db',\n    'type' => 'bool',\n    'link' => 'email_addresses_primary',\n    'rname' => 'invalid_email',\n    'massupdate' => false,\n    'studio' => 'false',\n    'duplicate_on_record_copy' => 'always',\n);\n$dictionary[$module]['fields']['email_opt_out'] = array(\n    'name' => 'email_opt_out',\n    'vname' => 'LBL_EMAIL_OPT_OUT',\n    'source' => 'non-db',\n    'type' => 'bool',\n    'link' => 'email_addresses_primary',\n    'rname' => 'opt_out',\n    'massupdate' => false,\n    'studio' => 'false',\n    'duplicate_on_record_copy' => 'always',\n);\n$dictionary[$module]['fields']['email_addresses_primary'] = array(\n    'name' => 'email_addresses_primary',\n    'type' => 'link',\n    'relationship' => strtolower($table_name) . '_email_addresses_primary',\n    'source' => 'non-db',\n    'vname' => 'LBL_EMAIL_ADDRESS_PRIMARY',\n    'duplicate_merge' => 'disabled',\n    'primary_only' => true,\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_the_Email_Field_to_a_Bean/index.html"}
{"id": "2417d3f18db5-3", "text": "'primary_only' => true,\n);\n$dictionary[$module]['fields']['email_addresses'] = array(\n    'name' => 'email_addresses',\n    'type' => 'link',\n    'relationship' => strtolower($table_name) . '_email_addresses',\n    'source' => 'non-db',\n    'vname' => 'LBL_EMAIL_ADDRESSES',\n    'reportable' => false,\n    'unified_search' => true,\n    'rel_fields' => array('primary_address' => array('type' => 'bool')),\n);\n// Used for non-primary mail import\n$dictionary[$module]['fields']['email_addresses_non_primary'] = array(\n    'name' => 'email_addresses_non_primary',\n    'type' => 'varchar',\n    'source' => 'non-db',\n    'vname' => 'LBL_EMAIL_NON_PRIMARY',\n    'studio' => false,\n    'reportable' => false,\n    'massupdate' => false,\n);\n$dictionary[$module]['relationships'][strtolower($table_name) . '_email_addresses'] = array(\n    'lhs_module' => $table_name,\n    'lhs_table' => strtolower($table_name),\n    'lhs_key' => 'id',\n    'rhs_module' => 'EmailAddresses',\n    'rhs_table' => 'email_addresses',\n    'rhs_key' => 'id',\n    'relationship_type' => 'many-to-many',\n    'join_table' => 'email_addr_bean_rel',\n    'join_key_lhs' => 'bean_id',\n    'join_key_rhs' => 'email_address_id',\n    'relationship_role_column' => 'bean_module',\n    'relationship_role_column_value' => $table_name,\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_the_Email_Field_to_a_Bean/index.html"}
{"id": "2417d3f18db5-4", "text": "'relationship_role_column_value' => $table_name,\n);\n$dictionary[$module]['relationships'][strtolower($table_name) . '_email_addresses_primary'] = array(\n    'lhs_module' => $table_name,\n    'lhs_table' => strtolower($table_name),\n    'lhs_key' => 'id',\n    'rhs_module' => 'EmailAddresses',\n    'rhs_table' => 'email_addresses',\n    'rhs_key' => 'id',\n    'relationship_type' => 'many-to-many',\n    'join_table' => 'email_addr_bean_rel',\n    'join_key_lhs' => 'bean_id',\n    'join_key_rhs' => 'email_address_id',\n    'relationship_role_column' => 'bean_module',\n    'relationship_role_column_value' => $module,\n    'primary_flag_column' => 'primary_address',\n);\nCreating a Custom Bean and Modifying the Save Function\nNext step, you will need to create a custom bean that extends from the stock bean. In our example, we choose the Opportunities.\u00c2\u00a0\n./custom/modules/Opportunities/CustomOpportunity.php\n  <?php\nclass CustomOpportunity extends Opportunity\n{\n    /**\n     * Constructor\n     */\n    public function __construct()\n    {\n        parent::__construct();\n        $this->emailAddress = BeanFactory::newBean('EmailAddresses');\n    }\n    /**\n     * Populate email address fields here instead of retrieve() so that they are properly available for logic hooks\n     *\n     * @see parent::fill_in_relationship_fields()\n     */\n    public function fill_in_relationship_fields()\n    {\n        parent::fill_in_relationship_fields();\n        $this->emailAddress->handleLegacyRetrieve($this);\n    }\n    /**\n     * @see parent::get_list_view_data()", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_the_Email_Field_to_a_Bean/index.html"}
{"id": "2417d3f18db5-5", "text": "}\n    /**\n     * @see parent::get_list_view_data()\n     */\n    public function get_list_view_data()\n    {\n        global $current_user;\n        $temp_array = $this->get_list_view_array();\n        $temp_array['EMAIL'] = $this->emailAddress->getPrimaryAddress($this);\n        // Fill in the email1 field only if the user has access to it\n        // This is a special case, because getEmailLink() uses email1 field for making the link\n        // Otherwise get_list_view_data() shouldn't set any fields except fill the template data\n        if ($this->ACLFieldAccess('email1', 'read')) {\n            $this->email1 = $temp_array['EMAIL'];\n        }\n        $temp_array['EMAIL_LINK'] = $current_user->getEmailLink('email1', $this, '', '', 'ListView');\n        return $temp_array;\n    }\n    /**\n     *\n     * @see parent::save()\n     */\n    public function save($check_notify = false)\n    {\n        if (static::inOperation('saving_related')) {\n            parent::save($check_notify);\n            return $this;\n        }\n        \n        $ori_in_workflow = empty($this->in_workflow) ? false : true;\n        $this->emailAddress->handleLegacySave($this, $this->module_dir);\n        parent::save($check_notify);\n        $override_email = array();\n        if (!empty($this->email1_set_in_workflow)) {\n            $override_email['emailAddress0'] = $this->email1_set_in_workflow;\n        }\n        if (!empty($this->email2_set_in_workflow)) {\n            $override_email['emailAddress1'] = $this->email2_set_in_workflow;", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_the_Email_Field_to_a_Bean/index.html"}
{"id": "2417d3f18db5-6", "text": "$override_email['emailAddress1'] = $this->email2_set_in_workflow;\n        }\n        if (!isset($this->in_workflow)) {\n            $this->in_workflow = false;\n        }\n        if ($ori_in_workflow === false || !empty($override_email)) {\n            $result = $this->emailAddress->save($this->id, $this->module_dir, $override_email, '', '', '', '',\n                $this->in_workflow);\n        }\n        return $this;\n    }\n}\nReplacing the Stock Bean with a Custom Bean\nOnce you created the custom bean, you will need to show Sugar to use Custom bean. To do that you will create ./custom/modules/<modulename>/<modulename>.php and update the class name and file path in the $beanList and $beanFiles. (See: Modules $beanList\u00c2\u00a0and Customizing Core SugarBeans)\ncustom/Extension/application/Ext/Include/customOpportunities.php\n<?php\n$objectList['Opportunities'] = 'Opportunity';\n$beanList['Opportunities'] = 'CustomOpportunity';\n$beanFiles['CustomOpportunity'] = 'custom/modules/Opportunities/CustomOpportunity.php';\nOnce you have created these files, you will need to navigate Admin > Repairs and perform Quick Repair and Rebuild.\nAdding the Emails Field to the Record View\nAt the stage, you have already created the field and updated the bean. The last step is placing the email field to record view. You can perform this step using Studio. Once you navigate to Studio you will find an Email field on the left column where available fields are listed. After adding the field the record views of Opportunities will look like this:\n./custom/modules/Opportunities/clients/base/views/record/record.php\n<?php", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_the_Email_Field_to_a_Bean/index.html"}
{"id": "2417d3f18db5-7", "text": "./custom/modules/Opportunities/clients/base/views/record/record.php\n<?php\n$viewdefs['Opportunities'] = \narray (\n  'base' => \n  array (\n    'view' => \n    array (\n      'record' => \n      array (\n        'buttons' => \n        array (\n          0 => \n          array (\n            'type' => 'button',\n            'name' => 'cancel_button',\n            'label' => 'LBL_CANCEL_BUTTON_LABEL',\n            'css_class' => 'btn-invisible btn-link',\n            'showOn' => 'edit',\n            'events' => \n            array (\n              'click' => 'button:cancel_button:click',\n            ),\n          ),\n          1 => \n          array (\n            'type' => 'rowaction',\n            'event' => 'button:save_button:click',\n            'name' => 'save_button',\n            'label' => 'LBL_SAVE_BUTTON_LABEL',\n            'css_class' => 'btn btn-primary',\n            'showOn' => 'edit',\n            'acl_action' => 'edit',\n          ),\n          2 => \n          array (\n            'type' => 'actiondropdown',\n            'name' => 'main_dropdown',\n            'primary' => true,\n            'showOn' => 'view',\n            'buttons' => \n            array (\n              0 => \n              array (\n                'type' => 'rowaction',\n                'event' => 'button:edit_button:click',\n                'name' => 'edit_button',\n                'label' => 'LBL_EDIT_BUTTON_LABEL',\n                'acl_action' => 'edit',\n              ),\n              1 =>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_the_Email_Field_to_a_Bean/index.html"}
{"id": "2417d3f18db5-8", "text": "'acl_action' => 'edit',\n              ),\n              1 => \n              array (\n                'type' => 'shareaction',\n                'name' => 'share',\n                'label' => 'LBL_RECORD_SHARE_BUTTON',\n                'acl_action' => 'view',\n              ),\n              2 => \n              array (\n                'type' => 'pdfaction',\n                'name' => 'download-pdf',\n                'label' => 'LBL_PDF_VIEW',\n                'action' => 'download',\n                'acl_action' => 'view',\n              ),\n              3 => \n              array (\n                'type' => 'pdfaction',\n                'name' => 'email-pdf',\n                'label' => 'LBL_PDF_EMAIL',\n                'action' => 'email',\n                'acl_action' => 'view',\n              ),\n              4 => \n              array (\n                'type' => 'divider',\n              ),\n              5 => \n              array (\n                'type' => 'rowaction',\n                'event' => 'button:find_duplicates_button:click',\n                'name' => 'find_duplicates_button',\n                'label' => 'LBL_DUP_MERGE',\n                'acl_action' => 'edit',\n              ),\n              6 => \n              array (\n                'type' => 'rowaction',\n                'event' => 'button:duplicate_button:click',\n                'name' => 'duplicate_button',\n                'label' => 'LBL_DUPLICATE_BUTTON_LABEL',\n                'acl_module' => 'Opportunities',\n                'acl_action' => 'create',\n              ),\n              7 => \n              array (\n                'type' => 'rowaction',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_the_Email_Field_to_a_Bean/index.html"}
{"id": "2417d3f18db5-9", "text": "7 => \n              array (\n                'type' => 'rowaction',\n                'event' => 'button:historical_summary_button:click',\n                'name' => 'historical_summary_button',\n                'label' => 'LBL_HISTORICAL_SUMMARY',\n                'acl_action' => 'view',\n              ),\n              8 => \n              array (\n                'type' => 'rowaction',\n                'event' => 'button:audit_button:click',\n                'name' => 'audit_button',\n                'label' => 'LNK_VIEW_CHANGE_LOG',\n                'acl_action' => 'view',\n              ),\n              9 => \n              array (\n                'type' => 'divider',\n              ),\n              10 => \n              array (\n                'type' => 'rowaction',\n                'event' => 'button:delete_button:click',\n                'name' => 'delete_button',\n                'label' => 'LBL_DELETE_BUTTON_LABEL',\n                'acl_action' => 'delete',\n              ),\n            ),\n          ),\n          3 => \n          array (\n            'name' => 'sidebar_toggle',\n            'type' => 'sidebartoggle',\n          ),\n        ),\n        'panels' => \n        array (\n          0 => \n          array (\n            'name' => 'panel_header',\n            'header' => true,\n            'fields' => \n            array (\n              0 => \n              array (\n                'name' => 'picture',\n                'type' => 'avatar',\n                'size' => 'large',\n                'dismiss_label' => true,\n                'readonly' => true,\n              ),\n              1 => \n              array (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_the_Email_Field_to_a_Bean/index.html"}
{"id": "2417d3f18db5-10", "text": "),\n              1 => \n              array (\n                'name' => 'name',\n                'related_fields' => \n                array (\n                  0 => 'total_revenue_line_items',\n                  1 => 'closed_revenue_line_items',\n                  2 => 'included_revenue_line_items',\n                ),\n              ),\n              2 => \n              array (\n                'name' => 'favorite',\n                'label' => 'LBL_FAVORITE',\n                'type' => 'favorite',\n                'dismiss_label' => true,\n              ),\n              3 => \n              array (\n                'name' => 'follow',\n                'label' => 'LBL_FOLLOW',\n                'type' => 'follow',\n                'readonly' => true,\n                'dismiss_label' => true,\n              ),\n            ),\n          ),\n          1 => \n          array (\n            'name' => 'panel_body',\n            'label' => 'LBL_RECORD_BODY',\n            'columns' => 2,\n            'labels' => true,\n            'labelsOnTop' => true,\n            'placeholders' => true,\n            'newTab' => false,\n            'panelDefault' => 'expanded',\n            'fields' => \n            array (\n              0 => \n              array (\n                'name' => 'account_name',\n                'related_fields' => \n                array (\n                  0 => 'account_id',\n                ),\n              ),\n              1 => \n              array (\n                'name' => 'date_closed',\n                'related_fields' => \n                array (\n                  0 => 'date_closed_timestamp',\n                ),\n              ),\n              2 => \n              array (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_the_Email_Field_to_a_Bean/index.html"}
{"id": "2417d3f18db5-11", "text": "),\n              ),\n              2 => \n              array (\n                'name' => 'amount',\n                'type' => 'currency',\n                'label' => 'LBL_LIKELY',\n                'related_fields' => \n                array (\n                  0 => 'amount',\n                  1 => 'currency_id',\n                  2 => 'base_rate',\n                ),\n                'currency_field' => 'currency_id',\n                'base_rate_field' => 'base_rate',\n                'span' => 12,\n              ),\n              3 => \n              array (\n                'name' => 'best_case',\n                'type' => 'currency',\n                'label' => 'LBL_BEST',\n                'related_fields' => \n                array (\n                  0 => 'best_case',\n                  1 => 'currency_id',\n                  2 => 'base_rate',\n                ),\n                'currency_field' => 'currency_id',\n                'base_rate_field' => 'base_rate',\n              ),\n              4 => \n              array (\n                'name' => 'worst_case',\n                'type' => 'currency',\n                'label' => 'LBL_WORST',\n                'related_fields' => \n                array (\n                  0 => 'worst_case',\n                  1 => 'currency_id',\n                  2 => 'base_rate',\n                ),\n                'currency_field' => 'currency_id',\n                'base_rate_field' => 'base_rate',\n              ),\n              5 => \n              array (\n                'name' => 'tag',\n                'span' => 6,\n              ),\n              6 => \n              array (\n                'name' => 'sales_status',\n                'readonly' => true,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_the_Email_Field_to_a_Bean/index.html"}
{"id": "2417d3f18db5-12", "text": "'name' => 'sales_status',\n                'readonly' => true,\n                'studio' => true,\n                'label' => 'LBL_SALES_STATUS',\n                'span' => 6,\n              ),\n              7 => \n              array (\n                'name' => 'email',\n                'studio' => \n                array (\n                  'visible' => true,\n                  'searchview' => true,\n                  'editview' => true,\n                  'editField' => true,\n                ),\n                'label' => 'LBL_EMAIL_ADDRESS',\n                'span' => 12,\n              ),\n            ),\n          ),\n          2 => \n          array (\n            'name' => 'panel_hidden',\n            'label' => 'LBL_RECORD_SHOWMORE',\n            'hide' => true,\n            'labelsOnTop' => true,\n            'placeholders' => true,\n            'columns' => 2,\n            'newTab' => false,\n            'panelDefault' => 'expanded',\n            'fields' => \n            array (\n              0 => 'next_step',\n              1 => 'opportunity_type',\n              2 => 'lead_source',\n              3 => 'campaign_name',\n              4 => \n              array (\n                'name' => 'description',\n                'span' => 12,\n              ),\n              5 => 'assigned_user_name',\n              6 => 'team_name',\n              7 => \n              array (\n                'name' => 'date_entered_by',\n                'readonly' => true,\n                'type' => 'fieldset',\n                'label' => 'LBL_DATE_ENTERED',\n                'fields' => \n                array (\n                  0 =>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_the_Email_Field_to_a_Bean/index.html"}
{"id": "2417d3f18db5-13", "text": "'fields' => \n                array (\n                  0 => \n                  array (\n                    'name' => 'date_entered',\n                  ),\n                  1 => \n                  array (\n                    'type' => 'label',\n                    'default_value' => 'LBL_BY',\n                  ),\n                  2 => \n                  array (\n                    'name' => 'created_by_name',\n                  ),\n                ),\n              ),\n              8 => \n              array (\n                'name' => 'date_modified_by',\n                'readonly' => true,\n                'type' => 'fieldset',\n                'label' => 'LBL_DATE_MODIFIED',\n                'fields' => \n                array (\n                  0 => \n                  array (\n                    'name' => 'date_modified',\n                  ),\n                  1 => \n                  array (\n                    'type' => 'label',\n                    'default_value' => 'LBL_BY',\n                  ),\n                  2 => \n                  array (\n                    'name' => 'modified_by_name',\n                  ),\n                ),\n              ),\n            ),\n          ),\n        ),\n        'templateMeta' => \n        array (\n          'useTabs' => false,\n        ),\n      ),\n    ),\n  ),\n);\nOnce the files are in place, navigate to Admin > Repair > Quick Repair & Rebuild to regenerate the metadata.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_the_Email_Field_to_a_Bean/index.html"}
{"id": "2134b56d72fd-0", "text": "Enabling Importing for Custom Modules\nOverview\nWhen designing a custom module in Module Builder, you have the option to enable importing for the module. If the custom module is deployed without enabling this option, it is not recommended that you redeploy the module since any changes made in Studio and potentially other areas of the application could be lost. This article will cover how to enable importing for custom modules via a code-level change\u00c2\u00a0to preserve any additional configurations made to the module since being deployed from Module Builder.\nSteps to Complete\nTo enable importing for your custom module, you must\u00c2\u00a0modify certain PHP files depending on the version of Sugar that you have. Please note that the instructions below apply to custom modules created via Admin > Module Builder and are not applicable to any stock modules which come out-of-the-box with Sugar. All of the directory paths are relative to the root directory of Sugar on the web server and require you to replace the <module_key> and <module_name> variables with appropriate values for your situation. For instance, if your module is installed in the directory of ./modules/abc_custom_module/ then the <module_key> would be abc\u00c2\u00a0and <module_name> would be custom_module.\nEdit the ./modules/<module_key>_<module_name>/<module_key>_<module_name>_sugar.php file in your Sugar file system.\nAround line 24 of the file, locate and change\u00c2\u00a0public $importable = false;\u00c2\u00a0to\u00c2\u00a0public $importable = true;.\nSave your changes to the file.\nNext, edit the ./modules/<module_key>_<module_name>/clients/base/menus/header/header.php file which should look similar to this:$viewdefs[$moduleName]['base']['menu']['header'] = array(\n  array( \n    'route' => \"#$moduleName/create\", \n    'label' => 'LNK_NEW_RECORD',\n    'acl_action' => 'create',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Enabling_Importing_for_Custom_Modules/index.html"}
{"id": "2134b56d72fd-1", "text": "'acl_action' => 'create',\n    'acl_module' => $moduleName,\n    'icon' => 'fa-plus',\n  ),\n  array(\n    'route' => \"#$moduleName\",\n    'label' => 'LNK_LIST',\n    'acl_action' => 'list',\n    'acl_module' => $moduleName,\n    'icon' => 'fa-bars',\n  ),\n);\nAdd the following line to the end of the file after the last\u00c2\u00a0 ),\u00c2\u00a0but before the ending );:array(\n 'route' => \"#bwc/index.php?module=Import&action=Step1&import_module=$moduleName&return_module=$moduleName&return_action=index\",\n 'label' => 'LBL_IMPORT',\n 'acl_action' => 'import',\n 'acl_module' => $moduleName,\n 'icon' => 'icon-upload',\n ),\nSave your changes to the file. The updated file should then look similar to this:$viewdefs[$moduleName]['base']['menu']['header'] = array(\n  array( \n    'route' => \"#$moduleName/create\", \n    'label' => 'LNK_NEW_RECORD',\n    'acl_action' => 'create',\n    'acl_module' => $moduleName,\n    'icon' => 'fa-plus',\n  ),\n  array(\n    'route' => \"#$moduleName\",\n    'label' => 'LNK_LIST',\n    'acl_action' => 'list',\n    'acl_module' => $moduleName,\n    'icon' => 'fa-bars',\n  ),\n  array(\n    'route' => \"#bwc/index.php?module=Import&action=Step1&import_module=$moduleName&return_module=$moduleName&return_action=index\",\n    'label' => 'LBL_IMPORT',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Enabling_Importing_for_Custom_Modules/index.html"}
{"id": "2134b56d72fd-2", "text": "'label' => 'LBL_IMPORT',\n    'acl_action' => 'import',\n    'acl_module' => $moduleName,\n    'icon' => 'icon-upload',\n ),\n);\nOnce the necessary changes have been made, log into Sugar and navigate to Admin > Repair and perform a \"Quick Repair and Rebuild\". This will rebuild the cached files to fully implement\u00c2\u00a0the changes.\u00c2\u00a0\nApplication\nAfter making these\u00c2\u00a0changes, the \"Import {Module Name}\" option will appear in the Actions menu of the custom module's module tab. Simply click the triangle in the module tab, then select the Import option to create or update records for your custom module. For instructions on using Sugar's Import tool, please refer to the Import documentation.\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Enabling_Importing_for_Custom_Modules/index.html"}
{"id": "c1a45864f603-0", "text": "Modifying Layouts to Display Additional Columns\nOverview\nBy default, the record view layout for each module displays two columns of fields. The number of columns to display can be customized on a per-module basis with the following steps.\nResolution\nFirst, you will want to ensure your layouts are deployed in the custom directory. If you have not previously customized your layouts via Studio, go to Admin > Studio > {Module Name} > Layouts. From there, select each layout you wish to add additional columns to and click 'Save & Deploy'. This action will create a corresponding layout file under the ./custom/modules/{Module Name}/clients/base/views/record/ directory. The file will be named record.php.\nIn your custom record.php file, locate the maxColumns\u00c2\u00a0value under templateMeta array, and change it to the number of columns you would like to have on screen:\n'maxColumns' => '3',\nOnce that is updated, locate the widths array to define the spacing for your each column(s). You should have a label and field entry for each column in your layout:\n'widths' => array (\n    0 => array (\n        'label' => '10',\n        'field' => '30',\n    ),\n    1 => array (\n        'label' => '10',\n        'field' => '30',\n    ),\n    2 => array (\n        'label' => '10',\n        'field' => '30',\n    ),\n),\nNext, under the existing\u00c2\u00a0panels\u00c2\u00a0array, each entry will already have a columns property, with a value of 2. Update each of these to the number of columns you set for\u00c2\u00a0maxColumns\u00c2\u00a0:\n'columns' => 3,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Modifying_Layouts_to_Display_Additional_Columns/index.html"}
{"id": "c1a45864f603-1", "text": "'columns' => 3,\nOnce the file has been modified, you can navigate to Studio and add fields to your new column in the layout. For any rows that already contain two fields, the second field will automatically span the second and third column. Simply click the minus (-) icon to contract the field to one column and expose the new column space:\nAfter you have added the desired fields in Studio, click 'Save & Deploy' to finalize your changes\nColumn Widths\nStudio does not support expanding a field beyond two column-widths. If you want a field to span the full layout (all three columns), you would need to manually update this in the custom record.php like so:\narray (\n    'name' => 'description',\n    'span' => 12,\n)\nChanging the span value from 8 to 12. After saving the changes on the file, you would then run a Quick Repair and Rebuild. However, any updates in Studio will revert the span back to 8.\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Modifying_Layouts_to_Display_Additional_Columns/index.html"}
{"id": "dcd716c1355a-0", "text": "Customizing the Email Editor Buttons\nOverview\nThe Emails module in Sugar\u00c2\u00ae displays commonly-used buttons in the HTML editor. This article explains how to modify the buttons on the editor's toolbar.\nModifying The View\nThe following sections outline how to customize the button toolbar presented within the TinyMCE editor. In the example below, we will be adding buttons for Cut, Copy, and Paste to the toolbar.\nUsing Custom Module Metadata\nTo override the Emails module\u00c2\u00a0compose-email\u00c2\u00a0view, we will need to copy\u00c2\u00a0./modules/Emails/clients/base/views/compose-email/compose-email.php\u00c2\u00a0to\u00c2\u00a0./custom/modules/Emails/clients/base/views/compose-email/compose-email.php. Once completed, we will then edit the ['tinyConfig']['toolbar']\u00c2\u00a0definition\u00c2\u00a0to include\u00c2\u00a0| cut copy paste\u00c2\u00a0.\u00c2\u00a0An example of this is shown below:\n./custom/modules/Emails/clients/base/views/compose-email/compose-email.php\n$viewdefs['Emails']['base']['view']['compose-email'] = array(\n    ...\n    'panels' => array(\n        array(\n            ...\n            'fields' => array(\n            \t...\n                array(\n                    'name' => 'description_html',\n                    'dismiss_label' => true,\n                    'span' => 12,\n                    'tinyConfig' => array(\n                        'toolbar' => 'code | bold italic underline strikethrough | bullist numlist | ' .\n                            'alignleft aligncenter alignright alignjustify | forecolor backcolor | ' .\n                            'fontsizeselect | formatselect | fontselect | sugarattachment sugarsignature sugartemplate | cut copy paste',\n                    ),\n                ),\n            ),\n        ),\n        ...\n    ),\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Customizing_the_Email_Editor_Buttons/index.html"}
{"id": "dcd716c1355a-1", "text": "),\n                ),\n            ),\n        ),\n        ...\n    ),\n);\nNote:\u00c2\u00a0We recommend modifying the modules custom\u00c2\u00a0metadata for local deployments when the customization is not part of a distributed package.\nOnce this file is in place, navigate to Admin > Repair\u00c2\u00a0> Quick Repair and Rebuild. Once completed, your changes will be reflected in the system.\nUsing The Module Extension Framework\nTo extend the Emails module\u00c2\u00a0compose-email\u00c2\u00a0view\u00c2\u00a0using the extension framework, we will need to loop through the existing views array definition to find and modify the description_html\u00c2\u00a0field and update the relevant sub-array\u00c2\u00a0['tinyConfig']['toolbar']\u00c2\u00a0with the additional toolbar buttons we want to display. An example of this is shown below:\n./custom/Extension/modules/Emails/Ext/clients/base/views/compose-email/add_toolbar_buttons.php\n<?php\n$target_view = 'compose-email';\n$target_fieldname = 'description_html';\n$default_toolbar =  'code | bold italic underline strikethrough | bullist numlist | ' .\n                            'alignleft aligncenter alignright alignjustify | forecolor backcolor | ' .\n                            'fontsizeselect | formatselect | fontselect | sugarattachment sugarsignature sugartemplate';\t\t\t\t\n$custom_toolbar = ' | cut copy paste';\nif (!empty($viewdefs['Emails']['base']['view'][$target_view]['panels'])) {\n\t$panels = $viewdefs['Emails']['base']['view'][$target_view]['panels'];\n\tforeach ($panels as $i => $panel) {\n\t\tif (!empty($panel['fields'])) {\n\t\t\tforeach ($panel['fields'] as $j => $field) {\n\t\t\t\tif ($field['name'] == $target_fieldname) {\n\t\t\t\t\tif(!isset($field['tinyConfig'])){", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Customizing_the_Email_Editor_Buttons/index.html"}
{"id": "dcd716c1355a-2", "text": "if(!isset($field['tinyConfig'])){\n\t\t\t\t\t\t$field['tinyConfig'] = array();\n\t\t\t\t\t}\n\t\t\t\t\t/* If toolbar already exists, add our custom buttons to the end, \n\t\t\t\t\totherwise set it to the default and append that. */\n\t\t\t\t\tif(!isset($field['tinyConfig']['toolbar'])) {\n\t\t\t\t\t\t$field['tinyConfig']['toolbar'] = $default_toolbar;\n\t\t\t\t\t}\n\t\t\t\t\t$viewdefs['Emails']['base']['view'][$target_view]['panels'][$i]['fields'][$j]['tinyConfig']['toolbar'] = $field['tinyConfig']['toolbar'] . $custom_toolbar;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\nNote:\u00c2\u00a0We recommend using the extension framework when the code will be installed as part of a distributed package.\u00c2\u00a0\nOnce this file is in place, navigate to Admin > Repair\u00c2\u00a0> Quick Repair and Rebuild. Once completed, your changes will be reflected in the system.\nToolbar Format\nAs demonstrated in the examples above, the\u00c2\u00a0toolbar\u00c2\u00a0value is a string with the button keywords space-separated. The\u00c2\u00a0|\u00c2\u00a0indicates a divider should be shown in the editor. If the goal were to replace the toolbar buttons with only text-modifier buttons, the value for toolbar\u00c2\u00a0would be:\n'bold italic | underline strikethrough'\nThe toolbar button keywords are documented at\u00c2\u00a0TinyMCE Editor Control Identifiers. Note that at this time, only control keywords listed as \"Core\" are supported by Sugar\u00c2\u00ae.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Customizing_the_Email_Editor_Buttons/index.html"}
{"id": "d75220ed0d8d-0", "text": "Customizing Prefill Fields When Copying Records\nOverview\nThe copy action on the record view allows for users to duplicate records. This article will cover the various ways to customize the prefill fields on the copy view.\nModifying the Copy Prefill View Using the Vardefs\nThe following section will outline how to modify the fields that are prefilled when copying a Bug record from the record view using the beans Vardefs. This is helpful when the list of copied fields are static and have no dependencies.\u00c2\u00a0You can apply this to any module in the system.\n./custom/Extension/modules/Bugs/Ext/Vardefs/copyPrefill.php\n<?php\n//remove a field from copy\n$dictionary['Bug']['fields']['description']['duplicate_on_record_copy'] = 'no';\n//add a field to copy\n$dictionary['Bug']['fields']['priority']['duplicate_on_record_copy'] = 'always';\nOnce in place, navigate to Admin > Repair > Quick Repair & Rebuild.\nNote: You can name the file 'copyPrefill.php' anything you like. We advise against making these changes in the\u00c2\u00a0./custom/Extension/modules/<module>/Ext/Vardefs/sugarfield_<field>.php\u00c2\u00a0files as these changes may be removed during studio edits.\nModifying the Copy Prefill View Using JavaScript Controllers\nThe following section will outline how to modify the fields that are prefilled when copying a Bug record from the record view using the JavaScript Controller. This is helpful when you need to dependently determine the fields to copy by a field on the bean. You can apply this to any module in the system.\n./custom/modules/Bugs/clients/base/views/record/record.js\n({\n    extendsFrom: 'RecordView',\n    setupDuplicateFields: function (prefill) {\n        this._super('setupDuplicateFields', prefill);\n        var fields = [\n            'name',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Customizing_Prefill_Fields_When_Copying_Records/index.html"}
{"id": "d75220ed0d8d-1", "text": "var fields = [\n            'name',\n            'assigned_user_id',\n            'priority',\n            'type',\n            'product_category',\n            'description'\n        ];\n        //determines whether the field list above is a set of allowlisted (allowed) or denylisted (denied) fields\n        var denylist = false;\n        if (denylist) {\n            _.each(fields, function (field) {\n                if (field && prefill.has(field)) {\n                    //set denylist field to the default value if exists\n                    if (!_.isUndefined(prefill.fields[field]) && !_.isUndefined(prefill.fields[field].default)) {\n                        prefill.set(field, prefill.fields[field].default);\n                    } else {\n                        prefill.unset(field);\n                    }\n                }\n            });\n        } else {\n            _.each(prefill.fields, function (value, field) {\n                if (!_.contains(fields, field)) {\n                    if (!_.isUndefined(prefill.fields[field].default)) {\n                        prefill.set(field, prefill.fields[field].default);\n                    } else {\n                        prefill.unset(field);\n                    }\n                }\n            });\n        }\n    }\n})\nOnce in place, navigate to Admin > Repair > Quick Repair & Rebuild. The denylist variable will determine whether the list of fields are allowlisted or denylisted from the copy feature.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Customizing_Prefill_Fields_When_Copying_Records/index.html"}
{"id": "2def67946c61-0", "text": "Adding Field Validation to the Record View\nOverview\nThis page explains how to add additional field validation to the record view. In the following examples, we will extend and override the stock Accounts record view to add custom validation. The custom validation will require the Office Phone field when the account type is set to \"Customer\" and also require the user to enter at least one email address.\nError Messages\nWhen throwing a validation error, Sugar has several stock messages you may choose to use. They are shown\u00c2\u00a0below:\nError Key\nLabel\nDescription\nmaxValue\nERROR_MAXVALUE\nThis maximum value of this field\nminValue\nERROR_MINVALUE\nThis minimum value of this field\nmaxLength\nERROR_MAX_FIELD_LENGTH\nThe max length of this field\nminLength\nERROR_MIN_FIELD_LENGTH\nThe min length of this field\ndatetime\nERROR_DATETIME\nThis field requires a valid date\nrequired\nERROR_FIELD_REQUIRED\nThis field is required\nemail\nERROR_EMAIL\nThere is an invalid email address\nprimaryEmail\nERROR_PRIMARY_EMAIL\nNo primary email address is set\nduplicateEmail\nERROR_DUPLICATE_EMAIL\nThere is a duplicate email address\nnumber\nERROR_NUMBER\nThis field requires a valid number\nisBefore\nERROR_IS_BEFORE\nThe date of this field can not be after another date\nisAfter\nERROR_IS_AFTER\nThe date of this field can not be before another date\nYou also have the option of displaying multiple error messages at a time. The example below would throw an error message notifying the user that the selected field is required and that it is also not a number.\nerrors['<field name>'] = errors['<field name>'] || {};\nerrors['<field name>'].required = true;\nerrors['<field name>'].number = true;\nCustom Error Messages", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Field_Validation_to_the_Record_View/index.html"}
{"id": "2def67946c61-1", "text": "errors['<field name>'].number = true;\nCustom Error Messages\nCustom error message can be used by appending custom\u00c2\u00a0language keys to app.error.errorName2Keys when initializing an\u00c2\u00a0extended controller. To accomplish this, create a new language key in the $app_strings. An example of this is shown below:\n./custom/Extension/application/Ext/Language/en_us.error_custom_message.php\n<?php\n$app_strings['ERROR_CUSTOM_MESSAGE'] = 'My custom error message.';\nNext, you will need to update your controller to use the new language\u00c2\u00a0key. To accomplish this, add your custom language key to the\u00c2\u00a0app.error.errorName2Keys array in the initialize method:\ninitialize: function (options) {\n    this._super('initialize', [options]); \n    //add custom message key\n    app.error.errorName2Keys['custom_message'] = 'ERROR_CUSTOM_MESSAGE';\n    ....\n},\nOnce completed, you can call your custom message by setting the app.error.errorName2Keys entry to true as shown below:\nerrors['phone_office'] = errors['phone_office'] || {};\nerrors['phone_office'].custom_message = true;\nMethod 1: Extending the RecordView and CreateView Controllers\nOne way to validate fields on record view is by creating record and\u00c2\u00a0create\u00c2\u00a0view controllers. This method requires a duplication of code due to the hierarchy design, however, it does organize the code by module and extend\u00c2\u00a0the core functionality. To accomplish this, override and extend the create view controller. This handles the validation when a user is creating a new record. Once the controller has been properly\u00c2\u00a0extended, define the validation check and use the model.addValidationTask method to append your function to the save validation.\n./custom/modules/Accounts/clients/base/views/create/create.js\n({\n    extendsFrom: 'CreateView',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Field_Validation_to_the_Record_View/index.html"}
{"id": "2def67946c61-2", "text": "({\n    extendsFrom: 'CreateView',\n    initialize: function (options) {\n        this._super('initialize', [options]);\n        //add validation tasks\n        this.model.addValidationTask('check_account_type', _.bind(this._doValidateCheckType, this));\n        this.model.addValidationTask('check_email', _.bind(this._doValidateEmail, this));\n    },\n    _doValidateCheckType: function(fields, errors, callback) {\n        //validate type requirements\n        if (this.model.get('account_type') == 'Customer' && _.isEmpty(this.model.get('phone_office')))\n        {\n            errors['phone_office'] = errors['phone_office'] || {};\n            errors['phone_office'].required = true;\n        }\n        callback(null, fields, errors);\n    },\n    _doValidateEmail: function(fields, errors, callback) {\n        //validate email requirements\n        if (_.isEmpty(this.model.get('email')))\n        {\n            errors['email'] = errors['email'] || {};\n            errors['email'].required = true;\n        }\n        callback(null, fields, errors);\n    },\n})\nNext, duplicate the validation logic for the record view. This handles the validation when editing existing records.\n./custom/modules/Accounts/clients/base/views/record/record.js\n({\n    /* because 'accounts' already has a record view, we need to extend it */\n    extendsFrom: 'AccountsRecordView', \n    initialize: function (options) {\n        this._super('initialize', [options]);\n        //add validation tasks\n        this.model.addValidationTask('check_account_type', _.bind(this._doValidateCheckType, this));\n        this.model.addValidationTask('check_email', _.bind(this._doValidateEmail, this));\n    },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Field_Validation_to_the_Record_View/index.html"}
{"id": "2def67946c61-3", "text": "},\n    _doValidateCheckType: function(fields, errors, callback) {\n        //validate requirements\n        if (this.model.get('account_type') == 'Customer' && _.isEmpty(this.model.get('phone_office')))\n        {\n            errors['phone_office'] = errors['phone_office'] || {};\n            errors['phone_office'].required = true;\n        }\n        callback(null, fields, errors);\n    },\n    _doValidateEmail: function(fields, errors, callback) {\n        //validate email requirements\n        if (_.isEmpty(this.model.get('email')))\n        {\n            errors['email'] = errors['email'] || {};\n            errors['email'].required = true;\n        }\n        callback(null, fields, errors);\n    },\n})\nOnce the files are in place, navigate to Admin > Repair > Quick Repair and Rebuild. More information on displaying custom error messages can be found in the Error Messages section.\nMethod 2: Overriding the RecordView and CreateView Layouts\nAnother method for defining your own custom validation is to override a module's record and create layouts to append a new view with your logic. The benefits of this method are that you can use the single view to house the validation logic, however, this means that you will have to override the layout. When overriding a layout, verify that the layout has not changed when upgrading your instance.\u00c2\u00a0Once the layouts are overridden, define the validation check and use the\u00c2\u00a0model.addValidationTask\u00c2\u00a0method to append the function to the save validation.\u00c2\u00a0\nFirst, create the custom view. For the accounts example, create the view\u00c2\u00a0validate-account:\n./custom/modules/Accounts/clients/base/views/validate-account/validate-account.js\u00c2\u00a0\n({\n   className:\"hidden\",\n   _render: function() {\n       //No-op, Do nothing here\n   },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Field_Validation_to_the_Record_View/index.html"}
{"id": "2def67946c61-4", "text": "_render: function() {\n       //No-op, Do nothing here\n   },\n   bindDataChange: function() {\n       //add validation tasks\n       this.model.addValidationTask('check_account_type', _.bind(this._doValidateCheckType, this));\n       this.model.addValidationTask('check_email', _.bind(this._doValidateEmail, this));\n   },\n   _doValidateCheckType: function(fields, errors, callback) {\n       //validate type requirements\n       if (this.model.get('account_type') == 'Customer' && _.isEmpty(this.model.get('phone_office')))\n       {\n           errors['phone_office'] = errors['phone_office'] || {};\n           errors['phone_office'].required = true;\n       }\n       callback(null, fields, errors);\n   },\n   _doValidateEmail: function(fields, errors, callback) {\n       //validate email requirements\n       if (_.isEmpty(this.model.get('email')))\n       {\n           errors['email'] = errors['email'] || {};\n           errors['email'].required = true;\n       }\n       callback(null, fields, errors);\n   },\n})\nMore information on displaying custom error messages can be found in the Error Messages section. Next, depending on the selected module, duplicate its create\u00c2\u00a0layout to the modules\u00c2\u00a0custom folder to handle record creation. In our\u00c2\u00a0Accounts example, we have an existing ./modules/Accounts/clients/base/layouts/create/create.php file so we need to duplicate this file to ./custom/modules/Accounts/clients/base/layouts/create/create.php. After this has been completed, append the new custom view to the components. append:\narray(\n   'view' => 'validate-account',\n),\nAs shown below:\n./custom/modules/Accounts/clients/base/layouts/create/create.php\n<?php", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Field_Validation_to_the_Record_View/index.html"}
{"id": "2def67946c61-5", "text": "./custom/modules/Accounts/clients/base/layouts/create/create.php\n<?php\n$viewdefs['Accounts']['base']['layout']['create'] = array(\n    'components' =>\n        array(\n            array(\n                'layout' =>\n                    array(\n                        'components' =>\n                            array(\n                                array(\n                                    'layout' =>\n                                        array(\n                                            'components' =>\n                                                array(\n                                                    array(\n                                                        'view' => 'create',\n                                                    ),\n                                                    array(\n                                                        'view' => 'validate-account',\n                                                    ),\n                                                ),\n                                            'type' => 'simple',\n                                            'name' => 'main-pane',\n                                            'span' => 8,\n                                        ),\n                                ),\n                                array(\n                                    'layout' =>\n                                        array(\n                                            'components' =>\n                                                array(),\n                                            'type' => 'simple',\n                                            'name' => 'side-pane',\n                                            'span' => 4,\n                                        ),\n                                ),\n                                array(\n                                    'layout' =>\n                                        array(\n                                            'components' =>\n                                                array(\n                                                    array(\n                                                        'view' =>\n                                                            array (\n                                                                'name' => 'dnb-account-create',\n                                                                'label' => 'DNB Account Create',\n                                                            ),\n                                                        'width' => 12,\n                                                    ),\n                                                ),\n                                            'type' => 'simple',\n                                            'name' => 'dashboard-pane',\n                                            'span' => 4,\n                                        ),\n                                ),\n                                array(\n                                    'layout' =>\n                                        array(\n                                            'components' =>\n                                                array(\n                                                    array(\n                                                        'layout' => 'preview',\n                                                    ),\n                                                ),\n                                            'type' => 'simple',\n                                            'name' => 'preview-pane',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Field_Validation_to_the_Record_View/index.html"}
{"id": "2def67946c61-6", "text": "'type' => 'simple',\n                                            'name' => 'preview-pane',\n                                            'span' => 8,\n                                        ),\n                                ),\n                            ),\n                        'type' => 'default',\n                        'name' => 'sidebar',\n                        'span' => 12,\n                    ),\n            ),\n        ),\n    'type' => 'simple',\n    'name' => 'base',\n    'span' => 12,\n);\nLastly, depending on the selected module, duplicate its record layout to the modules\u00c2\u00a0custom folder to handle editing a record. In the accounts example, we do not have an existing ./modules/Accounts/clients/base/layouts/record/record.php file so we duplicated the core ./clients/base/layouts/record/record.php to\u00c2\u00a0./custom/modules/Accounts/clients/base/layouts/record/record.php. Since we are copying from the ./clients/ core directory, modify:\n$viewdefs['base']['layout']['record'] = array(\n    ...\n);\nTo:\n$viewdefs['Accounts']['base']['layout']['record'] = array(\n    ...\n);\nAfter this has been completed, append the new custom view to the components:\narray(\n    'view' => 'validate-account',\n),\nThe resulting file is shown below:\n./custom/modules/Accounts/clients/base/layouts/record/record.php\n<?php\n$viewdefs['Accounts']['base']['layout']['record'] = array(\n    'components' => array(\n        array(\n            'layout' => array(\n                'components' => array(\n                    array(\n                        'layout' => array(\n                            'components' => array(\n                                array(\n                                    'view' => 'record',\n                                    'primary' => true,\n                                ),\n                                array(\n                                    'view' => 'validate-account',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Field_Validation_to_the_Record_View/index.html"}
{"id": "2def67946c61-7", "text": "),\n                                array(\n                                    'view' => 'validate-account',\n                                ),\n                                array(\n                                    'layout' => 'extra-info',\n                                ),\n                                array(\n                                    'layout' => array(\n                                        'name' => 'filterpanel',\n                                        'span' => 12,\n                                        'last_state' => array(\n                                            'id' => 'record-filterpanel',\n                                            'defaults' => array(\n                                                'toggle-view' => 'subpanels',\n                                            ),\n                                        ),\n                                        'availableToggles' => array(\n                                            array(\n                                                'name' => 'subpanels',\n                                                'icon' => 'icon-table',\n                                                'label' => 'LBL_DATA_VIEW',\n                                            ),\n                                            array(\n                                                'name' => 'list',\n                                                'icon' => 'icon-table',\n                                                'label' => 'LBL_LISTVIEW',\n                                            ),\n                                            array(\n                                                'name' => 'activitystream',\n                                                'icon' => 'icon-th-list',\n                                                'label' => 'LBL_ACTIVITY_STREAM',\n                                            ),\n                                        ),\n                                        'components' => array(\n                                            array(\n                                                'layout' => 'filter',\n                                                'targetEl' => '.filter',\n                                                'position' => 'prepend'\n                                            ),\n                                            array(\n                                                'view' => 'filter-rows',\n                                                \"targetEl\" => '.filter-options'\n                                            ),\n                                            array(\n                                                'view' => 'filter-actions',\n                                                \"targetEl\" => '.filter-options'\n                                            ),\n                                            array(\n                                                'layout' => 'activitystream',\n                                                'context' =>\n                                                array(\n                                                    'module' => 'Activities',\n                                                ),\n                                            ),\n                                            array(\n                                                'layout' => 'subpanels',\n                                            ),\n                                        ),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Field_Validation_to_the_Record_View/index.html"}
{"id": "2def67946c61-8", "text": "array(\n                                                'layout' => 'subpanels',\n                                            ),\n                                        ),\n                                    ),\n                                ),\n                            ),\n                            'type' => 'simple',\n                            'name' => 'main-pane',\n                            'span' => 8,\n                        ),\n                    ),\n                    array(\n                        'layout' => array(\n                            'components' => array(\n                                array(\n                                    'layout' => 'sidebar',\n                                ),\n                            ),\n                            'type' => 'simple',\n                            'name' => 'side-pane',\n                            'span' => 4,\n                        ),\n                    ),\n                    array(\n                        'layout' => array(\n                            'components' => array(\n                                array(\n                                    'layout' => array(\n                                        'type' => 'dashboard',\n                                        'last_state' => array(\n                                            'id' => 'last-visit',\n                                        )\n                                    ),\n                                    'context' => array(\n                                        'forceNew' => true,\n                                        'module' => 'Home',\n                                    ),\n                                ),\n                            ),\n                            'type' => 'simple',\n                            'name' => 'dashboard-pane',\n                            'span' => 4,\n                        ),\n                    ),\n                    array(\n                        'layout' => array(\n                            'components' => array(\n                                array(\n                                    'layout' => 'preview',\n                                ),\n                            ),\n                            'type' => 'simple',\n                            'name' => 'preview-pane',\n                            'span' => 8,\n                        ),\n                    ),\n                ),\n                'type' => 'default',\n                'name' => 'sidebar',\n                'span' => 12,\n            ),\n        ),\n    ),\n    'type' => 'simple',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Field_Validation_to_the_Record_View/index.html"}
{"id": "2def67946c61-9", "text": "),\n        ),\n    ),\n    'type' => 'simple',\n    'name' => 'base',\n    'span' => 12,\n);\nOnce the files are in place, navigate to Admin > Repair > Quick Repair and Rebuild.\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Field_Validation_to_the_Record_View/index.html"}
{"id": "0ec6164df28b-0", "text": "Disabling RLI Alerts on Opportunities\nOverview\nHow to disable Revenue Line Item (RLI) alerts on Opportunities using a custom JavaScript controller.\nOverriding the Record View\nFirst, we must override\u00c2\u00a0the stock opportunities record view. This will handle the RLI alerts when navigating to an existing record. This can be done by creating:\n./custom/modules/Opportunities/clients/base/views/record/record.js\n({\n    extendsFrom: 'OpportunitiesRecordView',\n    initialize: function (options) {\n        this._super('initialize', [options]);\n    },\n    /**\n     * Hide the warning message about missing RLIs\n     * @param string module     The module that we are currently on.\n     */\n    showRLIWarningMessage: function(module) {\n        //here we create an empty override function\n    },\n    /**\n     * @inheritdoc\n     */\n    _dispose: function() {\n        this._super('_dispose', []);\n    }\n})\nAs you can see, this file extends from 'OpportunitiesRecordView' which points our code to extend the stock ./modules/Opportunities/clients/base/views/record/record.js file.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Disabling_RLI_Alerts_on_Opportunities/index.html"}
{"id": "a5e5179524b2-0", "text": "Refreshing Subpanels on the RecordView\nOverview\nHow to refresh specific subpanels on the Record View.\nRefreshing Subpanels\nWhen Working with the Record View, it is sometimes necessary to force the refresh of a subpanel. The following example will demonstrate how to add buttons to force refresh a specific subpanel or all subpanels on the Accounts RecordView.\nAdding the Button Metadata\nFor our example, we will first create a metadata extension file to append our custom refresh buttons to the Accounts RecordView action menu.\n./custom/Extension/modules/Accounts/Ext/clients/base/views/record/refreshButtons.php\n<?php\n//module name\n$module = 'Accounts';\n//buttons to append\n$addButtons = array(\n    array(\n        'type' => 'divider',\n    ),\n    array (\n        'type' => 'rowaction',\n        'event' => 'button:refresh_specific_subpanel:click',\n        'name' => 'refresh_specific_subpanel',\n        'label' => 'LBL_REFRESH_SPECIFIC_SUBPANEL',\n        'acl_action' => 'view',\n    ),\n    array (\n        'type' => 'rowaction',\n        'event' => 'button:refresh_all_subpanels:click',\n        'name' => 'refresh_all_subpanels',\n        'label' => 'LBL_REFRESH_ALL_SUBPANELS',\n        'acl_action' => 'view',\n    )\n);\n//if the buttons are missing in our base modules metadata, include core buttons\nif (!isset($viewdefs[$module]['base']['view']['record']['buttons']))\n{\n    require('clients/base/views/record/record.php');\n    $viewdefs[$module]['base']['view']['record']['buttons'] = $viewdefs['base']['view']['record']['buttons'];\n    unset($viewdefs['base']);\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Refreshing_Subpanels_on_the_Record_View/index.html"}
{"id": "a5e5179524b2-1", "text": "unset($viewdefs['base']);\n}\nforeach($viewdefs[$module]['base']['view']['record']['buttons'] as $outerKey => $outerButton)\n{\n    if (\n        isset($outerButton['type'])\n        && $outerButton['type'] == 'actiondropdown'\n        && isset($outerButton['name'])\n        && $outerButton['name'] == 'main_dropdown'\n        && isset($outerButton['buttons'])\n    )\n    {\n        /*\n        //removing buttons by name\n        foreach($viewdefs[$module]['base']['view']['record']['buttons'][$outerKey]['buttons'] as $innerKey => $innerButton)\n        {\n            if (\n                isset($innerButton['name'])\n                && $innerButton['name'] == 'button_name'\n            )\n            {\n                unset($viewdefs[$module]['base']['view']['record']['buttons'][$outerKey]['buttons'][$innerKey]);\n            }\n        }\n        */\n        //appending buttons\n        foreach ($addButtons as $addButton)\n        {\n            $viewdefs[$module]['base']['view']['record']['buttons'][$outerKey]['buttons'][]=$addButton;\n        }\n    }\n}\nNext, we will create our language labels for the\u00c2\u00a0buttons.\n./custom/Extension/modules/Accounts/Ext/Language/en_us.refreshButtons.php\n<?php\n$mod_strings['LBL_REFRESH_SPECIFIC_SUBPANEL'] = 'Refresh Specific Subpanel';\n$mod_strings['LBL_REFRESH_ALL_SUBPANELS'] = 'Refresh All Subpanels';\nOur next step is to extend the Accounts controller file. This is where we will add our code to refresh the subpanels when the buttons are clicked.\n./custom/modules/Accounts/clients/base/views/record/record.js\n({", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Refreshing_Subpanels_on_the_Record_View/index.html"}
{"id": "a5e5179524b2-2", "text": "./custom/modules/Accounts/clients/base/views/record/record.js\n({\n    extendsFrom: 'RecordView',\n    initialize: function (options) {\n       this._super('initialize', [options]);\n        //add listeners for custom buttons\n        this.context.on('button:refresh_specific_subpanel:click', this.refresh_specific_subpanel, this);\n        this.context.on('button:refresh_all_subpanels:click', this.refresh_all_subpanels, this);\n    },\n    /**\n     * Refreshes a specific subpanel given a link\n     */\n    refresh_specific_subpanel: function() {\n        var linkName = 'contacts';\n        var subpanelCollection = this.model.getRelatedCollection(linkName);\n        subpanelCollection.fetch({relate: true});\n    },\n    /**\n     * Refreshes all subpanels\n     */\n    refresh_all_subpanels: function() {\n        _.each(this.model._relatedCollections, function(collection){\n            collection.fetch({relate: true});\n        });\n    }\n})\nNote:\u00c2\u00a0To refresh a specific subpanel, you will need to pass the linkname of the relationship to the\u00c2\u00a0this.model.getRelatedCollection() method.\nFinally, we will then need to navigate to Admin > Repair > Quick Repair and Rebuild. This will rebuild our extensions and make the refresh buttons available on our RecordView.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Refreshing_Subpanels_on_the_Record_View/index.html"}
{"id": "ce16bf15eefd-0", "text": "This page applies to the legacy \"BWC\" calendar offering. Sugar has released a Sidecar-based calendar in version 11.2.0; this content does not apply to the Sidecar calendar.\nModifying Calendar Item Colors\nOverview\nEach calendar event type (Meetings, Calls, and Tasks) has its own distinct color scheme. This article will review how to modify these colors, as well as demonstrate how to set the event color based on the event status.\nThe color scheme for each calendar activity type is defined in the stock file ./modules/Calendar/CalendarDisplay.php\u00c2\u00a0in the $activity_colors array as shown below:\npublic $activity_colors = array(\n\t'Meetings' => array(\n\t\t'border' => '#1C5FBD',\n\t\t'body' => '#D2E5FC',\n\t),\n\t'Calls' => array(\n\t\t'border' => '#DE4040',\n\t\t'body' => '#FCDCDC',\n\t),\n\t'Tasks' => array(\n\t\t'border' => '#015900',\n\t\t'body' => '#B1F5AE',\n\t),\n);\nThis file can not be overridden or extended in an upgrade-safe way, but this array can still be overridden later in the rendering process allowing for an upgrade safe customization.\nModifying the Calendar Activity Colors\nThe CalendarDisplay class passes the $activity_colors array to javascript by way of the ./modules/Calendar/tpls/main.tpl Smarty template.\nIn this template file, you will see the following code where the CAL.activity_colors\u00c2\u00a0object is setup:\nCAL.activity_colors = [];\t\t\t\t\n{foreach name=colors from=$activity_colors key=module item=v}\n\tCAL.activity_colors['{$module}'] = [];\n\tCAL.activity_colors['{$module}']['border'] = '{$v.border}';", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Modifying_Calendar_Item_Colors/index.html"}
{"id": "ce16bf15eefd-1", "text": "CAL.activity_colors['{$module}']['border'] = '{$v.border}';\n\tCAL.activity_colors['{$module}']['body'] = '{$v.body}'\n{/foreach}\nThis is where we can update the $activity_colors array in an upgrade safe manner. To do this, copy the template file from./modules/Calendar/tpls/main.tpl to ./custom/modules/Calendar/tpls/main.tpl.\nIf we wanted to change Meetings to have a purple color scheme, we might choose:\nborder: #580059body : #F2AEF5\nTo implement this, we'll update the activity colors array in the custom template file as follows:\n./custom/modules/Calendar/tpls/main.tpl\nCAL.activity_colors = [];\t\t\t\t\n{foreach name=colors from=$activity_colors key=module item=v}\n\tCAL.activity_colors['{$module}'] = [];\n\tCAL.activity_colors['{$module}']['border'] = '{$v.border}';\n\tCAL.activity_colors['{$module}']['body'] = '{$v.body}'\n{/foreach}\n{literal}\nCAL.activity_colors[\"Meetings\"] = {\n\t\"border\": \"#580059\",\n\t\"body\": \"#F2AEF5\"\n};\n{/literal}\nIn the above code, the activity_colors entry for \"Meetings\" has specifically been altered to set the custom colors just for Meetings, leaving the other activity types as they were. Alternatively, the entire activity_colors array could be updated, replacing the original coming from CalendarDisplay. For example:\n./custom/modules/Calendar/tpls/main.tpl\nCAL.activity_colors = [];\t\t\t\t\n{foreach name=colors from=$activity_colors key=module item=v}\n\tCAL.activity_colors['{$module}'] = [];\n\tCAL.activity_colors['{$module}']['border'] = '{$v.border}';", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Modifying_Calendar_Item_Colors/index.html"}
{"id": "ce16bf15eefd-2", "text": "CAL.activity_colors['{$module}']['border'] = '{$v.border}';\n\tCAL.activity_colors['{$module}']['body'] = '{$v.body}'\n{/foreach}\n{literal}\nCAL.activity_colors = {\n\t\t\"Meetings\": {\n\t\t\t\"border\": \"#580059\",\n\t\t\t\"body\": \"#F2AEF5\"\n\t\t},\n\t\t\"Calls\": {\n\t\t\t\"border\": \"#DE4040\",\n\t\t\t\"body\": \"#FCDCDC\"\n\t\t},\n\t\t\"Tasks\": {\n\t\t\t\"border\": \"#015900\",\n\t\t\t\"body\": \"#B1F5AE\"\n\t\t}\n\t};\n{/literal}\nWhile Calls and Tasks have not been modified from their original colors, having the entire array defined here may make it easier to make further color customizations later on, since the modified activity_colors will be completely defined in the custom template file.\nAfter making the above changes, run a Quick Repair and Rebuild and reload the Calendar module in your browser to see the changes take effect.\nCustomizing colors based on event status\nIf you wanted to go a step further, you might want to customize the colors based on the status of the activity. For example, perhaps for Meetings, the color should reflect if the Meeting status is Scheduled, Held, or Canceled. To achieve this, we will need to customize the javascript that actually renders the activities onto the calendar view, so we will copy\u00c2\u00a0./modules/Calendar/Cal.js to ./custom/modules/Calendar/Cal.js.\nAdditionally, in order for our custom template to load the custom Cal.js, it will need to be updated to point to the custom Cal.js by changing the line:\n{sugar_getscript file=\"modules/Calendar/Cal.js\"}\nto", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Modifying_Calendar_Item_Colors/index.html"}
{"id": "ce16bf15eefd-3", "text": "{sugar_getscript file=\"modules/Calendar/Cal.js\"}\nto\n{sugar_getscript file=\"custom/modules/Calendar/Cal.js\"}\nThe activity colors from the CAL.activity_colors object get applied in the Cal.js script at:\nel.style.backgroundColor = CAL.activity_colors[item.module_name]['body'];\nel.style.borderColor = CAL.activity_colors[item.module_name]['border'];\t\t\t\t\t\t\nThe activity type (Meetings, Calls, Tasks) comes from item.module_name, as shown above. The activity's status can be found in the item.status variable. Using these, we can modify the color-setting logic to apply a status-specific color scheme to the Meeting items in the calendar, for example:\nif (item.module_name ==\"Meetings\") {\n    el.style.backgroundColor = CAL.activity_colors[item.module_name][item.status]['body'];\n    el.style.borderColor     = CAL.activity_colors[item.module_name][item.status]['border'];\n} \nelse {\n    el.style.backgroundColor = CAL.activity_colors[item.module_name]['body'];\n    el.style.borderColor     = CAL.activity_colors[item.module_name]['border'];\n}\nThis assumes that the 'Meetings' part of CAL.activity_colors has status-specific colors set. Therefore we will need to update our custom template file so that this is the case:\n./custom/modules/Calendar/tpls/main.tpl\n{literal}\nCAL.activity_colors = {\n    \"Meetings\": {\n        \"Planned\": {\n            \"border\": \"#FF6666\",\n            \"body\": \"#FF6666\"\n        },\n        \"Held\": {\n            \"border\": \"#FF9999\",\n            \"body\": \"#FF9999\"\n        },\n        \"Not Held\": {\n            \"border\": \"#6C8CD5\",\n            \"body\": \"#6C8CD5\"\n        }\n    },\n    \"Calls\": {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Modifying_Calendar_Item_Colors/index.html"}
{"id": "ce16bf15eefd-4", "text": "}\n    },\n    \"Calls\": {\n        \"border\": \"#DE4040\",\n        \"body\": \"#FCDCDC\"\n    },\n    \"Tasks\": {\n        \"border\": \"#015900\",\n        \"body\": \"#B1F5AE\"\n    },\n    \"Planned\": {\n        \"border\": \"#ff6666\",\n        \"body\": \"#ff6666\"\n    },\n    \"Held\": {\n        \"border\": \"#FF9999\",\n        \"body\": \"#FF9999\"\n    },\n    \"Not Held\": {\n        \"border\": \"#6C8CD5\",\n        \"body\": \"#6C8CD5\"\n    }\n};\n{/literal}\nAfter making the above changes, run Rebuild JS Grouping Files followed by a Quick Repair and Rebuild, then reload the Calendar module in your browser to see the changes take effect.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Modifying_Calendar_Item_Colors/index.html"}
{"id": "99db50619d9a-0", "text": "Prepopulating the Compose Email View\nOverview\nWhen composing an email in Sugar, it may be useful to modify the compose view to better suit your common business practices. In this article, we will use JavaScript to create a code-level customization which causes the To, CC, and Subject fields of the email to prepopulate with data from a related Opportunity.\nSteps to Complete\nCreate a Custom Compose Email View\nTo modify the default compose email functionality, we will need to create our own compose-email view that extends from the base compose-email view. To accomplish this, we will need to create the following file:\n./custom/modules/Emails/clients/base/views/compose-email/compose-email.js\n({\n    extendsFrom: 'EmailsComposeEmailView',\n    initialize: function(options){\n        this._super('initialize',[options]);\n        this.configureDefaults();\n    },\n    /**\n     * Configure the default data\n     */\n    configureDefaults: function(){\n        var model = this.context.parent.get('model');\n        var module = this.context.parent.get('module');\n        if (module == 'Opportunities'){\n            var contacts;\n            var oppName = model.get('name');\n            if (this.model.get('to_collection').length === 0) {\n                var email = this.model;\n                //Get the related contacts to the Opportunity\n                contacts = model.getRelatedCollection('contacts');\n                contacts.fetch({\n                    relate: true,\n                    success: function (data) {\n                        var ccRecords = [],\n                            toRecords = [];\n                        data.forEach(function (record) {\n                            var parentName = app.utils.getRecordName(record);\n                            if (record.attributes.opportunity_role == 'Primary Decision Maker') {\n                                //Primary decisions makers are added to the TO Recipients\n                                toRecords.push(app.data.createBean('EmailParticipants', {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Prepopulating_the_Compose_Email_View/index.html"}
{"id": "99db50619d9a-1", "text": "toRecords.push(app.data.createBean('EmailParticipants', {\n                                    _link: 'to',\n                                    parent: _.extend({type: record.module}, record.attributes),\n                                    parent_type: record.module,\n                                    parent_id: record.get('id'),\n                                    parent_name: parentName\n                                }));\n                            } else {\n                                //All other contacts are added to the CC Recipients\n                                ccRecords.push(app.data.createBean('EmailParticipants', {\n                                    _link: 'cc',\n                                    parent: _.extend({type: record.module}, record.attributes),\n                                    parent_type: record.module,\n                                    parent_id: record.get('id'),\n                                    parent_name: parentName\n                                }));\n                            }\n                        });\n                        email.get('to_collection').add(toRecords);\n                        email.get('cc_collection').add(ccRecords);\n                    },\n                    fields: ['id', 'full_name', 'email', 'opportunity_role']\n                });\n            }\n            //Default the Subject of Email to the Opportunity Name\n            email.set('name',oppName);\n        }\n    }\n})\nSome key things to note about this customization:\nThe custom view should extend from EmailsComposeEmailView\nWhen adding recipients to an Email Bean Model, you should create an EmailParticipants Bean Model and specify the _link property that will be used.\nThis view will be used when clicking on the \"Create\" button in the Emails subpanel, or when clicking on Email Address on a record when the user is configured to use the Sugar Email Client\nOnce you have added the custom code, execute a Quick Repair and rebuild via Admin > Repair > Quick Repair and Rebuild, and your changes should now be reflected in your instance.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Prepopulating_the_Compose_Email_View/index.html"}
{"id": "a22d56fcef53-0", "text": "Customizing the Start Speed of List View Search\nOverview\nWhen searching a Sidecar module's list view, Sugar\u00c2\u00ae begins returning results automatically once a\u00c2\u00a0predefined number of milliseconds have passed. This article covers how to customize the start speed of the list view search for Sidecar modules in Sugar.\nPrerequisites\nThis change requires code-level customizations, and you will need direct access to the server in order to make the necessary changes in the file system.\u00c2\u00a0If you already have a relationship with a Sugar partner, you can work with them to make this customization. If not, please refer to the Partner Page to find a reselling partner to help with your development needs.\u00c2\u00a0\nNote: If your\u00c2\u00a0instance is hosted in Sugar's cloud environment, you can create a package that can be installed within Admin > Module Loader. For more information, please refer to the Creating an Installable Package That Copies Files article.\nNote: Sugar Sell Essentials customers do not have the ability to upload custom file packages to Sugar using Module Loader.\nUse Case\nBy default, the list view search process in Sugar begins to run 400 milliseconds after a user stops typing or pasting values into one of the search fields.\u00c2\u00a0For some users or situations, the system-defined start speed for list view search may be considered too fast. We will walk through increasing the length of time it takes before the search starts to run, using 750 milliseconds as an example.\nSteps to Complete\nThe function that controls the list view search speed in Sugar can be found in the following file: ./clients/base/views/filter-quicksearch/filter-quicksearch.js\u00c2\u00a0In order to customize this function, please use the following steps to create an extension in the ./custom/ directory:\nNavigate to the ./custom/ directory in the Sugar file system and create the following directory structure if it does not already exist: ./clients/base/views/filter-quicksearch/.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Customizing_the_Start_Speed_of_List_View_Search/index.html"}
{"id": "a22d56fcef53-1", "text": "In a text editor application, create a new file.\nCopy the code provided below into this new file:({\n  extendsFrom: 'FilterQuicksearchView',\n  /**\n   * @override\n   * @param {Object} opts\n   */\n  initialize: function(opts) {\n      this._super('initialize', [opts]);\n  },\n  /**\n   * Fire quick search\n   * @param {Event} e\n   */\n    throttledSearch: _.debounce(function(e) {\n      var newSearch = this.$el.val();\n      if(this.currentSearch !== newSearch) {\n          this.currentSearch = newSearch;\n          this.layout.trigger('filter:apply', newSearch);\n      }\n    }, 750),\n})\nFor our example, the value of \"750\" at the end of the code represents the new start speed of list view search. Feel free to replace it with\u00c2\u00a0your desired value in milliseconds.\nSave the new file as./custom/clients/base/views/filter-quicksearch/filter-quicksearch.js.\nUpdate the Ownership and Permissions of the directories and file that were created.\nFor more information on Linux based stacks, please refer to the article Required\u00c2\u00a0File\u00c2\u00a0System\u00c2\u00a0Permissions\u00c2\u00a0on Linux.\nFor more information on Windows-based stacks, please refer to the article Required File System Permissions on Windows With IIS.\nFinally, log into Sugar and navigate to Admin > Repair then perform a \"Quick Repair and Rebuild\".\nAfter completing the steps in this article, Sugar will wait 750 milliseconds before returning search results once\u00c2\u00a0the user has stopped entering search criteria.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Customizing_the_Start_Speed_of_List_View_Search/index.html"}
{"id": "dea755700303-0", "text": "Disabling Tooltips\nOverview\nThis article will demonstrate how to disable the tooltips in Sugar.\nSteps to Complete\nCreating a Custom JavaScript File\nFirst, we will need to create a custom JavaScript file. This file can technically exist anywhere within the root of your\u00c2\u00a0Sugar instance.\ncustom/JavaScript/disable_tooltips.js\n(function(app){\n     app.events.on('app:init', function(){\n          // Clear existing ones\n          app.tooltip.clear();\n          // Disable all\n          app.tooltip._disable();\n     });\n})(SUGAR.App);\nAppending to JSGroupings\nSecond, we need to add our disable_tooltips.js file to sugar_grp7.min.js in our\u00c2\u00a0JSGroupings.\ncustom/Extension/application/Ext/JSGroupings/disable_tooltips.php\n<?php\nforeach ($js_groupings as $key => $groupings) {\n    foreach ($groupings as $file => $target) {\n        if ($target == 'include/javascript/sugar_grp7.min.js') {\n            $js_groupings[$key]['custom/JavaScript/disable_tooltips.js'] = 'include/javascript/sugar_grp7.min.js';\n        }\n        break;\n    }\n}\nNote: More information about JSGroupings can be found here.\nQuick Repair and Rebuild\nAfter creating the\u00c2\u00a0./custom/JavaScript/disable_tooltips.js and\u00c2\u00a0./custom/Extension/application/Ext/JSGroupings/disable_tooltips.php files, navigate to Admin > Repairs and\u00c2\u00a0perform a \"Quick Repair and Rebuild\". This will rebuild the cached files to fully implement\u00c2\u00a0the changes.\u00c2\u00a0 Once \"Quick Repair and Rebuild\" finishes, the tooltips will be disabled through Sugar.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Disabling_Tooltips/index.html"}
{"id": "e39713af9e2d-0", "text": "Logic Hooks\nThese pages demonstrate\u00c2\u00a0some common examples of working with logic hooks in Sugar.\nTopicsComparing Bean Properties Between Logic HooksHow to compare the properties of a bean between the before_save and after_save logic hooksPreventing Infinite Loops with Logic HooksHow to add a check to a logic hook to eliminate perpetual looping\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Logic_Hooks/index.html"}
{"id": "ade508676418-0", "text": "Preventing Infinite Loops with Logic Hooks\nOverview\nInfinite loops often happen when a logic hook calls save on a bean in a scenario that triggers the same hook again. This example shows\u00c2\u00a0how to add a check to a logic hook to eliminate perpetual looping.\nSaving in an After Save Hook\nInfinite loops can sometimes happen when you have a need to update a record after it has been run through the workflow process in the after_save hook. Here is an example of a looping hook:\n./custom/modules/Accounts/logic_hooks.php\n<?php\n$hook_version = 1;\n$hook_array = Array();\n$hook_array['after_save'] = Array();\n$hook_array['after_save'][] = Array(\n    1,\n    'Update Account Record',\n    'custom/modules/Accounts/Accounts_Hook.php',\n    'Accounts_Hook',\n    'update_self'\n);\n./custom/modules/Accounts/Accounts_Hook.php\n<?php\nif (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nclass Accounts_Hook\n{\n    function update_self($bean, $event, $arguments)\n    {\n        //generic condition\n        if ($bean->account_type == 'Analyst')\n        {\n            //update\n            $bean->industry = 'Banking';\n            $bean->save();\n        }\n    }\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Logic_Hooks/Preventing_Infinite_Loops_with_Logic_Hooks/index.html"}
{"id": "ade508676418-1", "text": "$bean->save();\n        }\n    }\n}\nIn the example above, there is a condition that, when met, will trigger the update of a field on the record. This will cause an infinite loop because calling the save() method will trigger once during the before_save hook and then again during the after_save hook. The solution to this problem is to add a new property on the bean to ignore any unneeded saves. For this example, we will name the property \"ignore_update_c\" and add a check to the logic hook to eliminate the perpetual loop. An example of this is shown below:\n./custom/modules/Accounts/Accounts_Hook.php\n<?php\nif (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nclass Accounts_Hook\n{\n    function update_self($bean, $event, $arguments)\n    {\n        //loop prevention check\n        if (!isset($bean->ignore_update_c) || $bean->ignore_update_c === false)\n        {\n            //generic condition\n            if ($bean->account_type == 'Analyst')\n            {\n                //update\n                $bean->ignore_update_c = true;\n                $bean->industry = 'Banking';\n                $bean->save();\n            }\n        }\n    }\n}\nRelated Record Save Loops\nSometimes logic hooks on two separate but related modules can cause an infinite loop. The problem arises when the two modules have logic hooks that update one another. This is often done when wanting to keep a field in sync between two modules. The example below will demonstrate this behavior on the accounts:contacts relationship:\n./custom/modules/Accounts/logic_hooks.php\n<?php\n$hook_version = 1;\n$hook_array = Array();\n$hook_array['before_save'] = Array();", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Logic_Hooks/Preventing_Infinite_Loops_with_Logic_Hooks/index.html"}
{"id": "ade508676418-2", "text": "$hook_array = Array();\n$hook_array['before_save'] = Array();\n$hook_array['before_save'][] = Array(\n    1,\n    'Handling associated Contacts records',\n    'custom/modules/Accounts/Accounts_Hook.php',\n    'Accounts_Hook',\n    'update_contacts'\n);\n./custom/modules/Accounts/Accounts_Hook.php\n<?php\nif (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nclass Accounts_Hook\n{\n    function update_contacts($bean, $event, $arguments)\n    {\n        //if relationship is loaded\n        if ($bean->load_relationship('contacts'))\n        {\n            //fetch related beans\n            $relatedContacts = $bean->contacts->getBeans();\n            foreach ($relatedContacts as $relatedContact)\n            {\n                //perform any other contact logic\n                $relatedContact->save();\n            }\n        }\n    }\n}\nThe above example will loop through all contacts related to the account and save them. At this point, the save will then trigger our contacts logic hook shown below:\n./custom/modules/Contacts/logic_hooks.php\n<?php\n$hook_version = 1;\n$hook_array = Array();\n$hook_array['before_save'] = Array();\n$hook_array['before_save'][] = Array(\n    1,\n    'Handling associated Accounts records',\n    'custom/modules/Contacts/Contacts_Hook.php',\n    'Contacts_Hook',\n    'update_account'\n);\n./custom/modules/Contacts/Contacts_Hook.php\n<?php\nif (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nclass Contacts_Hook\n{\n    function update_account($bean, $event, $arguments)\n    {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Logic_Hooks/Preventing_Infinite_Loops_with_Logic_Hooks/index.html"}
{"id": "ade508676418-3", "text": "{\n    function update_account($bean, $event, $arguments)\n    {\n        //if relationship is loaded\n        if ($bean->load_relationship('accounts'))\n        {\n            //fetch related beans\n            $relatedAccounts = $bean->accounts->getBeans();\n            $parentAccount = false;\n            if (!empty($relatedAccounts))\n            {\n                //order the results\n                reset($relatedAccounts);\n                //first record in the list is the parent\n                $parentAccount = current($relatedAccounts);\n            }\n            if ($parentAccount !== false && is_object($parentAccount))\n            {\n                //perform any other account logic\n                $parentAccount->save();\n            }\n        }\n    }\n}\nThese two logic hooks will continuously trigger one another in this scenario until you run into a max_execution or memory_limit error. The solution to this problem is to add a new property on the bean to ignore any unneeded saves. In our example, we will name this property \"ignore_update_c\" and add a check to our logic hook to eliminate the perpetual loop. The following code snippets are copies of the two classes with the ignore_update_c property added.\n./custom/modules/Accounts/Accounts_Hook.php\n<?php\nif (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nclass Accounts_Hook\n{\n    function update_contacts($bean, $event, $arguments)\n    {\n        //if relationship is loaded\n        if ($bean->load_relationship('contacts'))\n        {\n            //fetch related beans\n            $relatedContacts = $bean->contacts->getBeans();\n            foreach ($relatedContacts as $relatedContact)\n            {\n                //check if the bean's ignore_update_c attribute is not set", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Logic_Hooks/Preventing_Infinite_Loops_with_Logic_Hooks/index.html"}
{"id": "ade508676418-4", "text": "{\n                //check if the bean's ignore_update_c attribute is not set\n                if (!isset($bean->ignore_update_c) || $bean->ignore_update_c === false)\n                {\n                    //set the ignore update attribute\n                    $relatedContact->ignore_update_c = true;\n                    //perform any other contact logic\n                    $relatedContact->save();\n                }\n            }\n        }\n    }\n}\n./custom/modules/Contacts/Contacts_Hook.php\n<?php\nif (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nclass Contacts_Hook\n{\n    function update_account($bean, $event, $arguments)\n    {\n        //if relationship is loaded\n        if ($bean->load_relationship('accounts'))\n        {\n            //fetch related beans\n            $relatedAccounts = $bean->accounts->getBeans();\n            $parentAccount = false;\n            if (!empty($relatedAccounts))\n            {\n                //order the results\n                reset($relatedAccounts);\n                //first record in the list is the parent\n                $parentAccount = current($relatedAccounts);\n            }\n            if ($parentAccount !== false && is_object($parentAccount))\n            {\n                //check if the bean's ignore_update_c element is set\n                if (!isset($bean->ignore_update_c) || $bean->ignore_update_c === false)\n                {\n                    //set the ignore update attribute\n                    $parentAccount->ignore_update_c = true;\n                    //perform any other account logic\n                    $parentAccount->save();\n                }\n            }\n        }\n    }\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Logic_Hooks/Preventing_Infinite_Loops_with_Logic_Hooks/index.html"}
{"id": "d5636bc79d06-0", "text": "Comparing Bean Properties Between Logic Hooks\nOverview\nHow to compare the properties of a bean between the before_save and after_save logic hooks\nStoring and Comparing Values\nWhen working with a bean in the after_save logic hook, you may notice that the after_save fetched rows no longer match the before_save fetched rows. If your after_save logic needs to be able to compare values that were in the before_save, you can use the following example to help you store and use the values.\n./custom/modules/<module>/logic_hooks.php\n<?php\n$hook_version = 1;\n$hook_array = Array();\n$hook_array['before_save'] = Array();\n$hook_array['before_save'][] = Array(\n    1,\n    'Store values',\n    'custom/modules/<module>/My_Logic_Hooks.php',\n    'My_Logic_Hooks',\n    'before_save_method'\n);\n$hook_array['after_save'] = Array();\n$hook_array['after_save'][] = Array(\n    1,\n    'Retrieve and compare values',\n    'custom/modules/<module>/My_Logic_Hooks.php',\n    'My_Logic_Hooks',\n    'after_save_method'\n);\n?>\n./custom/modules/<module>/My_Logic_Hooks.php\n<?php\nif (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nclass My_Logic_Hooks\n{\n    function before_save_method($bean, $event, $arguments)\n    {\n        //store as a new bean property\n        $bean->stored_fetched_row_c = $bean->fetched_row;\n    }\n    function after_save_method($bean, $event, $arguments)\n    {\n        //check if a fields value has changed\n        if (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Logic_Hooks/Comparing_Bean_Properties_Between_Logic_Hooks/index.html"}
{"id": "d5636bc79d06-1", "text": "{\n        //check if a fields value has changed\n        if (\n            isset($bean->stored_fetched_row_c)\n            && $bean->stored_fetched_row_c['field'] != $bean->field\n           )\n        {\n            //execute logic\n        }\n    }\n}\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Logic_Hooks/Comparing_Bean_Properties_Between_Logic_Hooks/index.html"}
{"id": "a393bfdbc0df-0", "text": "Moving Footer content to Sidebar Nav\nOverview\nThis example explains how to add additional buttons to a new section in the sidebar nav layout. You may have previously customized a button that was added to the footer layout, which can be repurposed here and added to the sidebar-nav layout. We will create a custom view and append the view component to the sidebar-nav layout metadata. The additional button will merely show an alert and a flyout menu with a link to the Accounts module but can be expanded to do much more.\nSteps To Complete\nThis tutorial requires the following steps, which are explained in the sections below:\nExtend the language files to include the new labels\nCreating the Custom View\nAppending the View to Layout Metadata\nAdding a Secondary Action\nExtending the Language files to Include New Labels\nWe'll want to add a couple of new labels for our new sidebar-nav-item. To do this, create the following file:\n./custom/Extension/application/Ext/Language/en_us.greetingNavItem.php\n<?php\n// Create the \"Hello\" label\n$app_strings['LBL_HELLO_C'] = 'Hello!';\nCreating the Custom View with a Primary Action\nTo add a new sidebar-nav-item, you will first need to create the custom view that extends sidebar-nav-item. To create the custom view create a folder in ./custom/clients/base/views with the name of your view, such as ./custom/clients/base/views/greeting-nav-item/. Once your folder is in place, you can create the two primary files that make up your view. By default, we can use the out-of-the-box template for our view.\ngreeting-nav-item.js\u00c2\u00a0- Contains the JavaScript controller logic\ngreeting-nav-item.php\u00c2\u00a0- Contains the metadata your view might use. For this example, we simply use the metadata to define whether the greeting will auto-close or not.\n./custom/clients/base/views/greeting-nav-item/greeting-nav-item.js", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Moving_Footer_content_to_Sidebar_Nav/index.html"}
{"id": "a393bfdbc0df-1", "text": "./custom/clients/base/views/greeting-nav-item/greeting-nav-item.js\n({\n    extendsFrom: 'SidebarNavItemView',\n    primaryActionOnClick: function() {\n        app.alert.show('greeting-alert', {\n            level: 'info',\n            messages: 'Hello '+ app.user.get('full_name') + '!',\n            autoClose: this.meta.autoClose || false\n        });\n    },\n})\n./custom/clients/base/views/greeting-nav-item/greeting-nav-item.php:\n<?php\n$viewdefs['base']['view']['greeting-nav-item'] = array(\n    'autoClose' => true\n);\nAppending the View to Layout Metadata\nOnce the view is created, you simply need to add the view to the\u00c2\u00a0sidebar-nav\u00c2\u00a0Layout metadata. The sidebar-nav Layout is located in\u00c2\u00a0./clients/base/layouts/sidebar-nav/, so appending the view to this layout can be done via the Extension Framework. Create a file\u00c2\u00a0\u00c2\u00a0./custom/Extension/application/Ext/clients/base/layouts/sidebar-nav/\u00c2\u00a0and the Extension Framework will append the metadata to the\u00c2\u00a0sidebar-nav\u00c2\u00a0Layout.\n./custom/Extension/application/Ext/clients/base/layouts/sidebar-nav/greeting-nav-item.php\n<?php \n$viewdefs['base']['layout']['sidebar-nav']['components'][] = [\n  'view' => [\n      'name' => 'greeting-nav-item',\n      'type' => 'greeting-nav-item',\n      'icon' => 'sicon-bell-lg',\n      'label' => 'LBL_HELLO_C',\n      'template' => 'sidebar-nav-item',\n   ],\n];\nOnce all the files are in place, you can run a Quick Repair and Rebuild and a new group\u00c2\u00a0\u00c2\u00a0sidebar-nav-item\u00c2\u00a0at the bottom of the\u00c2\u00a0sidebar-nav\u00c2\u00a0bar layout.\n\u00c2", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Moving_Footer_content_to_Sidebar_Nav/index.html"}
{"id": "a393bfdbc0df-2", "text": "\u00c2\u00a0\nNote:\u00c2\u00a0You may need to refresh the page to see the profile menu items removed.\nAdding a Secondary Action\nWith the introduction of the\u00c2\u00a0sidebar-nav-item\u00c2\u00a0component, we're now introducing Secondary Actions. These appear by way of a kebab menu when hovering on the\u00c2\u00a0sidebar-nav-item\u00c2\u00a0container to which they are added. It can be configured similarly to a Primary Action.\nIn this example, we'll add a secondary action to our\u00c2\u00a0greeting-nav-item\u00c2\u00a0view. It will trigger a flyout menu that has a link to the Accounts module.\nFirst, let's add a new label to the language file we created earlier for our flyout menu header:\n<?php\n// Create the \"Greetings\" header \n$app_strings['LBL_GREETINGS_C'] = 'Greetings';\n\u00c2\u00a0\nNext, we can define the components that will be used in the flyout menus via metadata in\u00c2\u00a0greeting-nav-item.php. The new metadata looks like this:\n./custom/Extension/application/Ext/clients/base/layouts/sidebar-nav/greeting-nav-item.php\n<?php\n$viewdefs['base']['layout']['sidebar-nav']['components'][] = [\n    'view' => [\n        'name' => 'greeting-nav-item',\n        'type' => 'greeting-nav-item',\n        'icon' => 'sicon-bell-lg',\n        'label' => 'LBL_HELLO_C',\n        'secondary_action' => true,\n        'template' => 'sidebar-nav-item',\n        'flyoutComponents' => [\n            [\n                'view' => 'sidebar-nav-flyout-header',\n                'title' => 'LBL_GREETINGS_C',\n            ],\n            [\n                'view' => [\n                    'type' => 'sidebar-nav-flyout-actions',\n                    'actions' => [\n                        [", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Moving_Footer_content_to_Sidebar_Nav/index.html"}
{"id": "a393bfdbc0df-3", "text": "'actions' => [\n                        [\n                            'route' => '#Accounts',\n                            'label' => 'LBL_ACCOUNTS',\n                            'icon' => 'sicon-account-lg',\n                        ],\n                    ],\n                ],\n            ],\n        ],\n    ],\n];\n\u00c2\u00a0\nOnce these changes are added, you can\u00c2\u00a0run a Quick Repair and Rebuild and sidebar-nav-item will be updated with a Secondary Action.\n\u00c2\u00a0\nNote:\u00c2\u00a0You may need to refresh the page to see the profile menu items removed.\n\u00c2\u00a0\nCustomizing the sidebar-nav-item Template\nBy default, our new\u00c2\u00a0sidebar-nav-item\u00c2\u00a0is using the base Handlebars template. If you'd like to customize the template, create the following Handlebar Template file\u00c2\u00a0greeting-nav-item.hbs. The following snippet is the template for the base view for reference.\u00c2\u00a0\n./custom/clients/base/views/greeting-nav-item/greeting-nav-item.hbs\n{{#if appIsSynced}}\n    <button class=\"sidebar-nav-item-btn w-full bg-transparent absolute p-0 text-base text-initial\"\n       rel=\"tooltip\"\n       data-placement=\"{{tooltipPlacement}}\"\n       title=\"{{str label}}\"\n    >\n        <span class=\"collapsed block ml-0 px-5.5 py-2\" rel=\"tooltip\" data-placement=\"{{tooltipPlacement}}\" title=\"{{str label module}}\">\n            <i class=\"{{buildIcon icon}} text-white\"></i>\n        </span>\n        <span class=\"expanded ellipsis_inline ml-0 px-5.5 py-2 text-white\"  rel=\"tooltip\" data-placement=\"{{tooltipPlacement}}\" title=\"{{str label module}}\">\n            <i class=\"{{buildIcon icon}} text-white\"></i>\n            <span class=\"text-sm pl-4.5\">{{str label}}</span>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Moving_Footer_content_to_Sidebar_Nav/index.html"}
{"id": "a393bfdbc0df-4", "text": "<span class=\"text-sm pl-4.5\">{{str label}}</span>\n        </span>\n    </button>\n    \n    {{#if secondaryAction}}\n        <button class=\"sidebar-nav-item-kebab bg-transparent absolute p-0 h-full\">\n            <i class=\"{{buildIcon 'sicon-kebab'}} text-white\"></i>\n        </button>\n    {{/if}}\n{{/if}}\nNext, in\u00c2\u00a0./custom/Extension/application/Ext/clients/base/layouts/sidebar-nav/greeting-nav-item.php remove the\u00c2\u00a0'template' => 'sidebar-nav-item'\u00c2\u00a0metadata entry.\u00c2\u00a0\nNote: Sidebar components must be expanded/collapsed state aware now, therefore you must make sure to provide\u00c2\u00a0collapsed\u00c2\u00a0(simple icon) and\u00c2\u00a0expanded\u00c2\u00a0(icon + text)\u00c2\u00a0class elements in your buttons.\nChanging position of sidebar-nav-item\nIf you need to change the position of the\u00c2\u00a0sidebar-nav-item\u00c2\u00a0in\u00c2\u00a0the\u00c2\u00a0sidebar-nav\u00c2\u00a0layout, it is recommended that the layout be redefined using custom metadata. For example, if you\u00c2\u00a0wanted to move the group we created above, we could define the custom metadata as such:\n./custom/clients/base/layouts/sidebar-nav/sidebar-nav.php\n<?php\n/*\n * Your installation or use of this SugarCRM file is subject to the applicable\n * terms available at\n * http://support.sugarcrm.com/Resources/Master_Subscription_Agreements/.\n * If you do not agree to all of the applicable terms or do not have the\n * authority to bind the entity as an authorized representative, then do not\n * install or use this SugarCRM file.\n *\n * Copyright (C) SugarCRM Inc. All rights reserved.\n */\n$viewdefs['base']['layout']['sidebar-nav'] = [\n    'components' => [", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Moving_Footer_content_to_Sidebar_Nav/index.html"}
{"id": "a393bfdbc0df-5", "text": "$viewdefs['base']['layout']['sidebar-nav'] = [\n    'components' => [\n        [ \n            'layout' => '...',\n        ],\n        [\n            'layout' => [\n                'type' => 'sidebar-nav-item-group-modules',\n                'css_class' => 'flex-grow flex-shrink',\n            ],\n        ],\n        [\n            'layout' => [\n                'type' => 'sidebar-nav-item-group',\n                'name' => 'sidebar-nav-item-group-bottom',\n                'css_class' => 'flex-grow-0 flex-shrink-0',\n                'components' => [\n                    [\n                        'view' => [\n                            'name' => 'footer-greet-button',\n                            'type' => 'footer-greet-button',\n                            'route' => '#Accounts',\n                            'icon' => 'sicon-bell-lg',\n                            'label' => 'Hello!',\n                            'flyoutComponents' => [\n                                [\n                                    'view' => 'sidebar-nav-flyout-header',\n                                    'title' => 'Greetings',\n                                ],\n                                [\n                                    'view' => [\n                                        'type' => 'sidebar-nav-flyout-actions',\n                                        'actions' => [\n                                            [\n                                                'route' => '#Accounts',\n                                                'label' => 'LBL_ACCOUNTS',\n                                                'icon' => 'sicon-account-lg',\n                                            ],\n                                        ],\n                                    ],\n                                ],\n                            ],\n                        ],\n                    ],\n                ],\n            ],\n        ],\n        [\n            'layout' => [\n                'type' => 'sidebar-nav-item-group',\n                'name' => 'sidebar-nav-item-group-bottom',\n                'css_class' => 'flex-grow-0 flex-shrink-0',\n                'components' => [ ... ],\n            ],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Moving_Footer_content_to_Sidebar_Nav/index.html"}
{"id": "a393bfdbc0df-6", "text": "'components' => [ ... ],\n            ],\n        ],\n    ],\n];\nNote:\u00c2\u00a0Although this is a best practice for customizing base metadata, these base layouts are subject to change and may be changed in the future. Maintenance of these customizations belongs to the owner of the instance.\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Moving_Footer_content_to_Sidebar_Nav/index.html"}
{"id": "f6aafbb6b3f6-0", "text": "Module Loadable Packages\nExamples working with the module loadable packages.\nTopicsCreating an Installable Package for a Logic HookThese examples will demonstrate how to create module loadable packages for logic hooks based on different scenarios.Creating an Installable Package That Copies FilesThis is an overview of how to create a module loadable package that will copy files into your instance of Sugar. This is most helpful when your instance is hosted in Sugar's cloud environment or by a third party. For more details on the $manifest or $installdef options, you can visit the Introduction to the Manifest. This example package can be downloaded here.Creating an Installable Package that Creates New FieldsThis is an overview of how to create a Module Loader package that will install custom fields to a module. This example will install a set of fields to the accounts module. The full package is downloadable here for your reference. For more details on the $manifest or $installdef options, you can visit the Introduction to the Manifest File.Removing Files with an Installable PackageThis is an overview of how to create a module loadable package that will remove files from the custom directory that may have been left over from a previous package installation or legacy versions of your code customization.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Module_Loadable_Packages/index.html"}
{"id": "eb2fe0596d07-0", "text": "Removing Files with an Installable Package\nOverview\nThis is an overview of how to create a module loadable package that will remove files from the custom directory that may have been left over from a previous package installation or legacy versions of your code customization.\u00c2\u00a0\nNote: For SugarCloud customers, this method will not work because removing files is prohibited by Package Scanner. To have files removed, you can submit\u00c2\u00a0a case to Sugar Support with a list of files to be removed or request a package approval and provide your module loadable package.\nThis example will install a custom file and use a pre-execute script to remove files from a previously installed customization. Typically, uninstalling a package would remove the files of the customization, however, in some scenarios, it is desired to install a new package on top of a previous version, and removing files with the new\u00c2\u00a0package might be necessary. The full package for this example is downloadable\u00c2\u00a0here\u00c2\u00a0for your reference.\nFor more details on the $manifest or $installdef options, you can visit the Introduction to the Manifest\u00c2\u00a0documentation.\u00c2\u00a0\nManifest Example\n<basepath>/manifest.php\n<?php\n    $manifest = array(\n        'acceptable_sugar_flavors' => array(\n            'PRO',\n            'ENT',\n            'ULT'\n        ),\n        'acceptable_sugar_versions' => array(\n            'exact_matches' => array(),\n            'regex_matches' => array(\n                '13.0.*\n            '),\n        ),\n        'author' => 'SugarCRM',\n        'description' => 'Installs a custom class file',\n        'icon' => '',\n        'is_uninstallable' => true,\n        'name' => 'Example Removing File Installer',\n        'published_date' => '2018-12-06 00:00:00',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Module_Loadable_Packages/Removing_Files_with_an_Installable_Package/index.html"}
{"id": "eb2fe0596d07-1", "text": "'type' => 'module',\n        'version' => '1.2.0'\n    );\n    $installdefs = array(\n        'id' => 'package_1341607504',\n        'copy' => array(\n            array(\n                'from' => '<basepath>/Files/custom/src/CustomClass.php',\n                'to' => 'custom/src/CustomClass.php',\n            ),\n        ),\n        'pre_execute' => array(\n            '<basepath>/removeLegacyFiles.php',\n        ),\n        'remove_files' => array(\n            'custom/include/CustomClass.php'\n        )\n    );\n<basepath>/removeLegacyFiles.php\u00c2\u00a0\n<?php\nif (isset($this->installdefs['remove_files'])) {\n    foreach($this->installdefs['remove_files'] as $relpath){\n        if (SugarAutoloader::fileExists($relpath)) {\n            SugarAutoloader::unlink($relpath);\n        }\n    }\n}\nThe full package is downloadable\u00c2\u00a0here\u00c2\u00a0for your reference.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Module_Loadable_Packages/Removing_Files_with_an_Installable_Package/index.html"}
{"id": "bd0f1f84f106-0", "text": "Creating an Installable Package That Copies Files\nOverview\nThis is an overview of how to create a module loadable package that will copy files into your instance of Sugar. This is most helpful when your instance is hosted in Sugar's cloud\u00c2\u00a0environment or by a third party. For more details on the $manifest or $installdef options, you can visit the Introduction to the Manifest.\u00c2\u00a0This example package can be downloaded here.\nManifest Example\n<?php\n$manifest = array(\n    'acceptable_sugar_flavors' => array('PRO','ENT','ULT'),\n    'acceptable_sugar_versions' => array(\n        'exact_matches' => array(),\n        'regex_matches' => array('(.*?)\\\\.(.*?)\\\\.(.*?)$'),\n    ),\n    'author' => 'SugarCRM',\n    'description' => 'Copies my files to custom/src/',\n    'icon' => '',\n    'is_uninstallable' => true,\n    'name' => 'Example File Installer',\n    'published_date' => '2018-06-29 00:00:00',\n    'type' => 'module',\n    'version' => '1.0.0',\n);\n$installdefs = array(\n    'id' => 'package_1530305622',\n    'copy' => array(\n        0 => array(\n            'from' => '<basepath>/Files/custom/src/MyLibrary/MyCustomClass.php',\n            'to' => 'custom/src/MyLibrary/MyCustomClass.php',\n        ),\n    ),\n);\nCopied File Example", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Module_Loadable_Packages/Creating_an_Installable_Package_That_Copies_Files/index.html"}
{"id": "bd0f1f84f106-1", "text": "),\n    ),\n);\nCopied File Example\nThis example copies a file to\u00c2\u00a0\u00c2\u00a0./custom/src/MyLibrary/MyCustomClass.php, which adds the custom namespaced\u00c2\u00a0class\u00c2\u00a0Sugarcrm\\Sugarcrm\\custom\\MyLibrary\\MyCustomClass\u00c2\u00a0to the application.\n<?php\nnamespace Sugarcrm\\Sugarcrm\\custom\\MyLibrary;\nuse \\Sugarcrm\\Sugarcrm\\Logger\\Factory;\nclass MyCustomClass\n{\n    public function MyCustomMethod($message = 'relax')\n    {\n        $logger = Factory::getLogger('default');\n        $logger->info('MyCustomClass says' . \"'{$message}'\");\n    }\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Module_Loadable_Packages/Creating_an_Installable_Package_That_Copies_Files/index.html"}
{"id": "3c8c6e17daa2-0", "text": "Creating an Installable Package that Creates New Fields\nOverview\nThis is an overview of how to create a Module Loader package that will install custom fields to a module. This example will install a set of fields to the accounts module. The full package is downloadable here\u00c2\u00a0for your reference. For more details on the $manifest or $installdef options, you can visit the Introduction to the Manifest File.\nNote: Sugar Sell Essentials customers do not have the ability to upload custom file packages to Sugar using Module Loader.\nManifest Example\n<basepath>/manifest.php\n<?php\n$manifest = array(\n    'acceptable_sugar_flavors' => array('CE', 'PRO', 'CORP', 'ENT', 'ULT'),\n    'acceptable_sugar_versions' => array(\n        'exact_matches' => array(),\n        'regex_matches' => array(\n            0 => '6\\\\.5\\\\.(.*?)',\n            1 => '7\\\\.8\\\\.(.*?)\\\\.(.*?)', \n            2 => '7\\\\.9\\\\.(.*?)\\\\.(.*?)', \n            3 => '7\\\\.10\\\\.(.*?)\\\\.(.*?)'\n        ),\n    'author' => 'SugarCRM',\n    'description' => 'Installs a sample set of custom fields to the accounts module',\n    'icon' => '',\n    'is_uninstallable' => true,\n    'name' => 'Example Custom Field Installer',\n    'published_date' => '2015-05-11 20:45:04',\n    'type' => 'module',\n    'version' => '1.0.0',\n);\n$installdefs = array(\n    'id' => 'package_1341607504',\n    'language' => array(\n        array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Module_Loadable_Packages/Creating_an_Installable_Package_that_Creates_New_Fields/index.html"}
{"id": "3c8c6e17daa2-1", "text": "'language' => array(\n        array(\n            'from' => '<basepath>/Files/Language/Accounts/en_us.lang.php',\n            'to_module' => 'Accounts',\n            'language' => 'en_us'\n        ),\n    ),\n    'custom_fields' => array(\n        //Text\n        array(\n            'name' => 'text_field_example_c',\n            'label' => 'LBL_TEXT_FIELD_EXAMPLE',\n            'type' => 'varchar',\n            'module' => 'Accounts',\n            'help' => 'Text Field Help Text',\n            'comment' => 'Text Field Comment Text',\n            'default_value' => '',\n            'max_size' => 255,\n            'required' => false, // true or false\n            'reportable' => true, // true or false\n            'audited' => false, // true or false\n            'importable' => 'true', // 'true', 'false', 'required'\n            'duplicate_merge' => false, // true or false\n        ),\n        //DropDown\n        array(\n            'name' => 'dropdown_field_example_c',\n            'label' => 'LBL_DROPDOWN_FIELD_EXAMPLE',\n            'type' => 'enum',\n            'module' => 'Accounts',\n            'help' => 'Enum Field Help Text',\n            'comment' => 'Enum Field Comment Text',\n            'ext1' => 'account_type_dom', //maps to options - specify list name\n            'default_value' => 'Analyst', //key of entry in specified list\n            'mass_update' => false, // true or false\n            'required' => false, // true or false\n            'reportable' => true, // true or false\n            'audited' => false, // true or false", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Module_Loadable_Packages/Creating_an_Installable_Package_that_Creates_New_Fields/index.html"}
{"id": "3c8c6e17daa2-2", "text": "'audited' => false, // true or false\n            'importable' => 'true', // 'true', 'false' or 'required'\n            'duplicate_merge' => false, // true or false\n        ),\n        //MultiSelect\n        array(\n            'name' => 'multiselect_field_example_c',\n            'label' => 'LBL_MULTISELECT_FIELD_EXAMPLE',\n            'type' => 'multienum',\n            'module' => 'Accounts',\n            'help' => 'Multi-Enum Field Help Text',\n            'comment' => 'Multi-Enum Field Comment Text',\n            'ext1' => 'account_type_dom', //maps to options - specify list name\n            'default_value' => 'Analyst', //key of entry in specified list\n            'mass_update' => false, // true or false\n            'required' => false, // true or false\n            'reportable' => true, // true or false\n            'audited' => false, // true or false\n            'importable' => 'true', // 'true', 'false' or 'required'\n            'duplicate_merge' => false, // true or false\n        ),\n        //Checkbox\n        array(\n            'name' => 'checkbox_field_example_c',\n            'label' => 'LBL_CHECKBOX_FIELD_EXAMPLE',\n            'type' => 'bool',\n            'module' => 'Accounts',\n            'default_value' => true, // true or false\n            'help' => 'Bool Field Help Text',\n            'comment' => 'Bool Field Comment',\n            'audited' => false, // true or false\n            'mass_update' => false, // true or false\n            'duplicate_merge' => false, // true or false\n            'reportable' => true, // true or false", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Module_Loadable_Packages/Creating_an_Installable_Package_that_Creates_New_Fields/index.html"}
{"id": "3c8c6e17daa2-3", "text": "'reportable' => true, // true or false\n            'importable' => 'true', // 'true', 'false' or 'required'\n        ),\n        //Date\n        array(\n            'name' => 'date_field_example_c',\n            'label' => 'LBL_DATE_FIELD_EXAMPLE',\n            'type' => 'date',\n            'module' => 'Accounts',\n            'default_value' => '',\n            'help' => 'Date Field Help Text',\n            'comment' => 'Date Field Comment',\n            'mass_update' => false, // true or false\n            'required' => false, // true or false\n            'reportable' => true, // true or false\n            'audited' => false, // true or false\n            'duplicate_merge' => false, // true or false\n            'importable' => 'true', // 'true', 'false' or 'required'\n        ),\n        //DateTime\n        array(\n            'name' => 'datetime_field_example_c',\n            'label' => 'LBL_DATETIME_FIELD_EXAMPLE',\n            'type' => 'datetime',\n            'module' => 'Accounts',\n            'default_value' => '',\n            'help' => 'DateTime Field Help Text',\n            'comment' => 'DateTime Field Comment',\n            'mass_update' => false, // true or false\n            'enable_range_search' => false, // true or false\n            'required' => false, // true or false\n            'reportable' => true, // true or false\n            'audited' => false, // true or false\n            'duplicate_merge' => false, // true or false\n            'importable' => 'true', // 'true', 'false' or 'required'\n        ),\n        //Encrypt\n        array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Module_Loadable_Packages/Creating_an_Installable_Package_that_Creates_New_Fields/index.html"}
{"id": "3c8c6e17daa2-4", "text": "),\n        //Encrypt\n        array(\n            'name' => 'encrypt_field_example_c',\n            'label' => 'LBL_ENCRYPT_FIELD_EXAMPLE',\n            'type' => 'encrypt',\n            'module' => 'Accounts',\n            'default_value' => '',\n            'help' => 'Encrypt Field Help Text',\n            'comment' => 'Encrypt Field Comment',\n            'reportable' => true, // true or false\n            'audited' => false, // true or false\n            'duplicate_merge' => false, // true or false\n            'importable' => 'true', // 'true', 'false' or 'required'\n        ),\n    ),\n);\n?>\nLanguage Example\n<basepath>/Files/Language/Accounts/en_us.lang.php\n<?php\n$mod_strings['LBL_TEXT_FIELD_EXAMPLE'] = 'Text Field Example';\n$mod_strings['LBL_DROPDOWN_FIELD_EXAMPLE'] = 'DropDown Field Example';\n$mod_strings['LBL_CHECKBOX_FIELD_EXAMPLE'] = 'Checkbox Field Example';\n$mod_strings['LBL_MULTISELECT_FIELD_EXAMPLE'] = 'Multi-Select Field Example';\n$mod_strings['LBL_DATE_FIELD_EXAMPLE'] = 'Date Field Example';\n$mod_strings['LBL_DATETIME_FIELD_EXAMPLE'] = 'DateTime Field Example';\n$mod_strings['LBL_ENCRYPT_FIELD_EXAMPLE'] = 'Encrypt Field Example';\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Module_Loadable_Packages/Creating_an_Installable_Package_that_Creates_New_Fields/index.html"}
{"id": "f19d3800dd09-0", "text": "Creating an Installable Package for a Logic Hook\nOverview\nThese examples will demonstrate how to create module loadable packages for logic hooks based on different scenarios.\nLogic Hook File vs. Logic Hook Definition\nNo matter the deployment method, all logic hooks require being registered (meaning they are attached to the $hook_array array), defining the logic hook event, module, file to load, and class and function to run for that logic hook event. For all deployment options, the logic hook definition points to a file where the class and function to run is located, and this file must be copied to the instance via the copy\u00c2\u00a0installdefs of the manifest. The bulk of this article will focus on the various options for registering the logic hook definition via the package manifest. But all deployment strategies will assume the same logic hook definition, the same logic hook file, and will use the same\u00c2\u00a0copy array to move the logic hook file into the instance.\nNote: More information on the $manifest or $installdef\u00c2\u00a0can be found in\u00c2\u00a0the Introduction to the Manifest .\nThe Logic Hook\nThis logic hook will install a before_save hook to the accounts module that will default the account name to 'My New Account Name ({time stamp})'. This various ways of installing this hook will be shown in the following sections.\nLogic Hook Definition\n<basepath>/Files/custom/Extension/Accounts/Ext/LogicHooks/account_name_hook.php\n<?php\n$hook_array['before_save'][] = Array(\n    99, \n    'Example Logic Hook - Updates account name', \n    'custom/modules/Accounts/accounts_save.php', \n    'Accounts_Save', \n    'updateAccountName'\n);\nLogic Hook File\n<basepath>/Files/custom/modules/Accounts/accounts_save.php\n<?php\nif (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nclass Accounts_Save", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Module_Loadable_Packages/Creating_an_Installable_Package_for_a_Logic_Hook/index.html"}
{"id": "f19d3800dd09-1", "text": "class Accounts_Save\n{\n\tfunction updateAccountName($bean, $event, $arguments)\n\t{\n\t\t$bean->name = \"My New Account Name (\" . time() . \")\";\n\t}\n}\nDistributed Plugin\nIf the package being built is intended to be distributed to various Sugar instances as part of a distributed plugin, your logic hook definition should be created as part of the extension framework using the LogicHooks Extension, which can be done using\u00c2\u00a0$installdefs['logic_hooks'] in the package manifest. When using this extension, the logic hook will be installed and uninstalled along with the plugin.\nNote: More information on the $installdefs['logic_hooks']\u00c2\u00a0can be found in\u00c2\u00a0LogicHooks Extensions.\nPackage Example\nThe following files are relative to the root of the .zip archive which is referred to at the basepath.\u00c2\u00a0This example package can be downloaded here.\n<basepath>/manifest.php\n<?php\n$manifest = array(\n    'acceptable_sugar_flavors' => array(\n        'PRO',\n        'ENT',\n        'ULT'\n    ),\n    'acceptable_sugar_versions' => array(\n        'exact_matches' => array(),\n        'regex_matches' => array(\n            '13.0.*\n        '),\n    ),\n    'author' => 'SugarCRM',\n    'description' => 'Installs a sample logic hook - using extension framework',\n    'icon' => '',\n    'is_uninstallable' => true,\n    'name' => 'Example Logic Hook Installer - Using Extension Framework',\n    'published_date' => '2018-01-01 00:00:00',\n    'type' => 'module',\n    'version' => '1.0.0',\n);\n$installdefs = array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Module_Loadable_Packages/Creating_an_Installable_Package_for_a_Logic_Hook/index.html"}
{"id": "f19d3800dd09-2", "text": ");\n$installdefs = array(\n\t'id' => 'package_123',\n\t'copy' => array(\n\t\tarray(\n\t\t\t'from' => '<basepath>/Files/custom/modules/Accounts/accounts_save.php',\n\t\t\t'to' => 'custom/modules/Accounts/accounts_save.php',\n\t\t),\n\t),\n\t'hookdefs' => array(\n\t\tarray(\n\t\t\t'from' => '<basepath>/Files/custom/Extension/Accounts/Ext/LogicHooks/account_name_hook.php',\n\t\t\t'to_module' => 'Accounts',\n\t\t)\n\t),\n);\n<basepath>/Files/custom/Extension/Accounts/Ext/LogicHooks/account_name_hook.php\n<?php\n$hook_array['before_save'][] = Array(\n    99, \n    'Example Logic Hook - Updates account name', \n    'custom/modules/Accounts/accounts_save.php', \n    'Accounts_Save', \n    'updateAccountName'\n);\n<basepath>/Files/custom/modules/Accounts/accounts_save.php\n<?php\nif (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nclass Accounts_Save\n{\n\tfunction updateAccountName($bean, $event, $arguments)\n\t{\n\t\t$bean->name = \"My New Account Name (\" . time() . \")\";\n\t}\n}\nPromotion Process\nIf the package being built is intended to be part of a code promotion process, you are welcome to use the\u00c2\u00a0LogicHooks Extension as mentioned above or\u00c2\u00a0you may find it easier to update the ./custom/modules/<module>/logic_hooks.php file, which can be done using the $installdefs['logic_hooks'] in the package manifest.\nPackage Example", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Module_Loadable_Packages/Creating_an_Installable_Package_for_a_Logic_Hook/index.html"}
{"id": "f19d3800dd09-3", "text": "Package Example\nThe following files are relative to the root of the .zip archive which is referred to at the basepath.\u00c2\u00a0This example package can be downloaded here.\n<basepath>/manifest.php\n<?php\n$manifest = array(\n        'acceptable_sugar_flavors' => array(\n            'PRO',\n            'ENT',\n            'ULT'\n        ),\n        'acceptable_sugar_versions' => array(\n            'exact_matches' => array(),\n            'regex_matches' => array(\n                '13.0.*\n            '),\n        ),\n\t'author' => 'SugarCRM',\n\t'description' => 'Installs a sample logic hook - using logic_hooks installdefs',\n\t'icon' => '',\n\t'is_uninstallable' => true,\n\t'name' => 'Example Logic Hook Installer - Using logic_hooks installdefs',\n\t'published_date' => '2018-01-01 00:00:00',\n\t'type' => 'module',\n\t'version' => '1.0.0',\n);\n$installdefs = array(\n\t'id' => 'package_456',\n\t'copy' => array(\n\t\tarray(\n\t\t\t'from' => '<basepath>/Files/custom/modules/Accounts/accounts_save.php',\n\t\t\t'to' => 'custom/modules/Accounts/accounts_save.php',\n\t\t),\n\t),\n\t'logic_hooks' => array(\n\t\tarray(\n\t\t\t'module' => 'Accounts',\n\t\t\t'hook' => 'before_save',\n\t\t\t'order' => 99,\n\t\t\t'description' => 'Example Logic Hook - Updates account name',\n\t\t\t'file' => 'custom/modules/Accounts/accounts_save.php',\n\t\t\t'class' => 'Accounts_Save',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Module_Loadable_Packages/Creating_an_Installable_Package_for_a_Logic_Hook/index.html"}
{"id": "f19d3800dd09-4", "text": "'class' => 'Accounts_Save',\n\t\t\t'function' => 'updateAccountName',\n\t\t),\n\t),\n);\n<basepath>/Files/custom/modules/Accounts/accounts_save.php\n<?php\nif (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nclass Accounts_Save\n{\n\tfunction updateAccountName($bean, $event, $arguments)\n\t{\n\t\t$bean->name = \"My New Account Name (\" . time() . \")\";\n\t}\n}\nConditionally Add or Remove Logic Hook via post_execute script\nA developer may want to be able to trigger the addition or removal of logic hooks from a customization. This can be done using a post execute script with the check_logic_hook_file and remove_logic_hook_file functions.\nIt is recommended to be cautious when doing this and limit any updates to off-hours as not to affect system behavior for users.\nNote:\u00c2\u00a0remove_logic_hook_file\u00c2\u00a0only removes hooks defined in the given module's logic_hooks.php file.\u00c2\u00a0check_logic_hook_file\u00c2\u00a0only checks hooks defined in the given module's\u00c2\u00a0logic_hooks.php\u00c2\u00a0file. Neither check or remove hooks defined via the Logic Hook Extension framework. Thus this deployment option should be considered a subset of the Promotion Process deployment option listed earlier.\nPackage Example\nNote: For demonstration purposes, in the post_execute script, the Accounts_Save logic hook from the earlier example package is unregistered (if it exists) and a second logic hook Accounts_Save_Enterprise\u00c2\u00a0is registered. The second logic hook points to a different logic hook file, which is moved to the instance using copy\u00c2\u00a0in the manifest.\nThe following files are relative to the root of the .zip archive which is referred to at the basepath.\u00c2\u00a0This example package can be downloaded here.\n<basepath>/manifest.php\n<?php", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Module_Loadable_Packages/Creating_an_Installable_Package_for_a_Logic_Hook/index.html"}
{"id": "f19d3800dd09-5", "text": "<basepath>/manifest.php\n<?php\n$manifest = array(\n        'acceptable_sugar_flavors' => array(\n            'PRO',\n            'ENT',\n            'ULT'\n        ),\n        'acceptable_sugar_versions' => array(\n            'exact_matches' => array(),\n            'regex_matches' => array(\n                '13.0.*\n            '),\n        ),\n\t'author' => 'SugarCRM',\n\t'description' => 'Installs a sample logic hook - using post_execute check_logic_hook_file',\n\t'icon' => '',\n\t'is_uninstallable' => true,\n\t'name' => 'Example Logic Hook Installer - Using post_execute check_logic_hook_file',\n\t'published_date' => '2018-01-01 00:00:00',\n\t'type' => 'module',\n\t'version' => '1.0.0',\n);\n$installdefs = array(\n\t'id' => 'package_789',\n\t'copy' => array(\n\t\tarray(\n\t\t\t'from' => '<basepath>/Files/custom/modules/Accounts/accounts_save_enterprise.php',\n\t\t\t'to' => 'custom/modules/Accounts/accounts_save_enterprise.php',\n\t\t),\n\t),\n\t'post_execute' => array(\n\t\t '<basepath>/change_hooks.php',\n\t),\n);\n<basepath>/Files/custom/modules/Accounts/accounts_save_enterprise.php\n<?php\nif (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nclass Accounts_Save_Enterprise\n{\n\tfunction updateAccountName($bean, $event, $arguments)\n\t{\n\t\t$bean->name = \"My New Account Name (\" . time() . \") -- Enterprise\";\n\t}\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Module_Loadable_Packages/Creating_an_Installable_Package_for_a_Logic_Hook/index.html"}
{"id": "f19d3800dd09-6", "text": "}\n}\n<basepath>/change_hooks.php\n<?php\nif(!defined('sugarEntry')) define('sugarEntry', true);\nrequire_once 'include/entryPoint.php';\n$accounts_hook_pro = array(\n\t99,\n\t'Example Logic Hook - Updates account name',\n\t'custom/modules/Accounts/accounts_save.php',\n\t'Accounts_Save',\n\t'updateAccountName'\n);\n$accounts_hook_ent = array(\n\t99,\n\t'Example Logic Hook - Updates account name - Enterprise',\n\t'custom/modules/Accounts/accounts_save_enterprise.php',\n\t'Accounts_Save_Enterprise',\n\t'updateAccountName'\n);\nif( $GLOBALS['sugar_flavor'] == 'ENT' ) {\n\t//unregister Accounts_Save logichook\n\tremove_logic_hook(\"Accounts\", \"before_save\", $accounts_hook_pro);\n\t//register Accounts_Save_Enterprise logichook\n\tcheck_logic_hook_file(\"Accounts\", \"before_save\", $accounts_hook_ent);\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Module_Loadable_Packages/Creating_an_Installable_Package_for_a_Logic_Hook/index.html"}
{"id": "69b7c71a0c17-0", "text": "Modifying Subpanel Buttons\nOverview\nSeveral buttons exist on each subpanel by default such as \"Create\" (+ Plus symbol) and \"Link Existing Record\". These buttons are controlled by the panel-top view for each module. To make changes to the buttons included in a subpanel layout, you will need to create an override for the panel-top view in\u00c2\u00a0./custom/Extension/modules/<module>/Ext/clients/base/views/panel-top/ and update the corresponding\u00c2\u00a0buttons property to include or exclude a button.\nIf you need to make changes to a specific relationships subpanel, then you will need to modify the subpanels layout definition for the relationship to point to a custom panel-top view that you define.\nSteps to Complete\nEditing Subpanel Buttons\nIn this example, we will remove the \"Create\" button from the Contacts subpanel for all modules. This code snippet uses the same button definition that the create button uses.\u00c2\u00a0It has been changed to trigger the \"Link Existing Record\" action\u00c2\u00a0by setting the button type to link-action. The blank array after the initial button is just to assure that the drop-down button displays next to it as disabled for placement purposes.\nCreate the file custom/Extension/modules/Contacts/Ext/clients/base/views/panel-top/panel-top.php as follows: <?php\n$viewdefs['Contacts']['base']['view']['panel-top']['buttons'] = array(\n    array(\n        'type' => 'actiondropdown',\n        'name' => 'panel_dropdown',\n        'css_class' => 'pull-right',\n        'buttons' => array(\n            array(\n                'type' => 'link-action',\n                'icon' => 'fa-link',\n                'name' => 'select_button',\n                'label' => ' ',\n                'tooltip' => 'LBL_ASSOC_RELATED_RECORD',\n            ),\n            array(\n            ),\n        ),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Modifying_Subpanel_Action_Buttons/index.html"}
{"id": "69b7c71a0c17-1", "text": "),\n            array(\n            ),\n        ),\n    ),\n);\nNavigate to Admin > Repair and click \"Quick Repair and Rebuild\".\nThe subpanel will appear as shown below for all Contacts subpanels.\nUsing a Custom Panel-Top View for a Specific Relationship\nIn this example, we will only remove the \"Create\" action from a specific relationships subpanel. Specifically, the example will look at Contacts subpanel on the Accounts module and implement the above changes explicitly for that relationship.\nCreate the custom panel-top view in ./custom/modules/Contacts/clients/base/views/panel-top-for-accounts/panel-top-for-accounts.php as follows: <?php\n$viewdefs['Contacts']['base']['view']['panel-top-for-accounts'] = array(\n    'type' => 'panel-top',\n    'template' => 'panel-top',\n    'buttons' => array(\n        array(\n            'type' => 'actiondropdown',\n            'name' => 'panel_dropdown',\n            'css_class' => 'pull-right',\n            'buttons' => array(\n                array(\n                    'type' => 'link-action',\n                    'icon' => 'fa-link',\n                    'name' => 'select_button',\n                    'label' => ' ',\n                    'tooltip' => 'LBL_ASSOC_RELATED_RECORD',\n                ),\n                array(\n                ),\n            ),\n        ),\n    ),\n);\nCreate the subpanel panel-top override definition for Accounts in ./custom/modules/Accounts/clients/base/layouts/subpanels/subpanels.php as follows:\u00c2\u00a0\n<?php\nrequire 'modules/Accounts/clients/base/layouts/subpanels/subpanels.php';\nforeach($viewdefs['Accounts']['base']['layout']['subpanels']['components'] as $key => $component){\n    if ($component['context']['link'] == 'contacts'){", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Modifying_Subpanel_Action_Buttons/index.html"}
{"id": "69b7c71a0c17-2", "text": "if ($component['context']['link'] == 'contacts'){\n        $viewdefs['Accounts']['base']['layout']['subpanels']['components'][$key]['override_paneltop_view']  = 'panel-top-for-accounts';\n        break;\n    }\n}\nNavigate to Admin > Repair and click \"Quick Repair and Rebuild\".\nYour changes will now be\u00c2\u00a0reflected in the system.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Modifying_Subpanel_Action_Buttons/index.html"}
{"id": "2a07a052b3fe-0", "text": "Adding an Existing Note to an Email as Attachment\nOverview\nThere may be times when you want to reuse a file attached to one Note record as an attachment for an Email, similar to the ability in the Compose Email view to add an attachment using 'Sugar Document'.\nKey Concepts\nThere are two key things to understand when implementing this functionality:\nYou can not relate an existing Note record to an Email record. This will throw an Exception in the API as intended. A note that is used as an attachment can only exist once and can not act as an attachment across multiple emails.\nYou can create a new Note record that uses an existing Note's attached file. Doing so essentially requires setting the\u00c2\u00a0upload_id\u00c2\u00a0field of the new Note record to the id of the existing Note you want to reuse the file from, and setting the\u00c2\u00a0file_source\u00c2\u00a0field of the new Note to 'Notes'. In addition to needing to set the upload_id, you must also set the filename and name field.\nThe following examples demonstrate how to do this in three different contexts: server-side (SugarBean/PHP), client-side (sidecar/Javascript), and purely through the API. But all three contexts follow the same essential steps:\nFetch the original Note record;\nCreate a new Note record, setting the necessary fields from the original Note record;\nLink the new Note record to the Email record via the appropriate 'attachments' link.\nPHP\nThis example would be done server-side using the SugarBean object, similar to how you might interact with the records in a custom Logic Hook or Scheduler job.\n$original_note_id = '4e226282-8158-11e8-a1b3-439fe19c087a';\n$email_id = 'e3e058f4-7f11-11e8-ba11-fcdd97d61bbe';\n// 1. Fetch Original Note:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_an_Existing_Note_to_an_Email_as_Attachment/index.html"}
{"id": "2a07a052b3fe-1", "text": "// 1. Fetch Original Note:\n$original_note = BeanFactory::retrieveBean('Notes', $original_note_id);\n// 2.  Create a new note based on original note, setting upload_id, name, and filename:\n$new_note = BeanFactory::newBean('Notes');\n$new_note->upload_id = $original_note->getUploadId();\n$new_note->file_source = 'Notes';\n$new_note->filename = $original_note->filename;\n$new_note->name = $original_note->filename;\n// 3. Relate the new note to Email record using 'attachments' link:\n$email = BeanFactory::retrieveBean('Emails', $email_id);\n$email->load_relationship('attachments');\n$email->attachments->add($email, $new_note);\nNote that in most contexts, such as a Logic Hook or a custom endpoint, you will not need to call save() on either the $new_note or $email for $new_note to be related as an attachment to $email and for $new_note to save. The $new_note record will save as part of being linked to $email.\nJavascript\nThe following example is totally standalone within Sidecar, demonstrating how to fetch the existing Note using app.data.createBean and\u00c2\u00a0bean.fetch(), create the new Note using app.data.createBean and setting the relevant fields, and then adding the new Note to the email records attachments_collection.\nvar original_note_id = '4e226282-8158-11e8-a1b3-439fe19c087a';\nvar email_id = 'e3e058f4-7f11-11e8-ba11-fcdd97d61bbe';\n// 1. Fetch Original Note:\nvar original_note = app.data.createBean('Notes');\noriginal_note.set('id', original_note_id);\noriginal_note.fetch();", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_an_Existing_Note_to_an_Email_as_Attachment/index.html"}
{"id": "2a07a052b3fe-2", "text": "original_note.set('id', original_note_id);\noriginal_note.fetch();\n// 2.  Create a new note based on original note, setting upload_id, name, and filename:\nvar new_note = app.data.createBean('Notes', {\n\t_link: 'attachments',\n\tupload_id: original_note.get('id'),\n\tfile_source: 'Notes',\n\tfilename: original_note.get('filename'),\n\tname: original_note.get('filename'),\n\tfile_mime_type: original_note.get('file_mime_type'),\n\tfile_size: original_note.get('file_size'),\n\tfile_ext: original_note.get('file_ext'),\n});\n// 3.  Relate the new note to Email record using 'attachments_collection' link:\nvar email = app.data.createBean('Emails');\nemail.set('id', email_id);\nemail.fetch();\nemail.get('attachments_collection').add(new_note,{merge:true});\nemail.save();\nNote: In the above example, the fields file_mime_type, file_size, and file_ext are also set. This is assuming a context where the customization is adding the attachments to the Compose Email view. Setting these fields makes the new attachments look correct to the user before saving the Email, but these fields are otherwise set automatically on save. If extending the actual compose view for emails, you also wouldn't fetch the email directly. This is added in this example purely for demonstration purposes.\nREST API\nThe following section will outline how to related the attachment using the REST API using the /link/attachments/\u00c2\u00a0endpoint for the Email record.\nFetch Original Note\nTo fetch the original note, send a GET request to rest/{REST VERSION}/Notes/{$original_note_id}. An example of the response is shown below :\n{\n  \"id\": \"4e226282-8158-11e8-a1b3-439fe19c087a\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_an_Existing_Note_to_an_Email_as_Attachment/index.html"}
{"id": "2a07a052b3fe-3", "text": "\"name\": \"Note with Attachment\",\n  \"date_entered\": \"2018-07-01T12:00:00-00:00\",\n  \"description\": \"Send to special clients.\",\n  \"file_mime_type\": \"application/pdf\",\n  \"filename\": \"special_sales_doc.pdf\",\n  \"_module\": \"Notes\"\n}\nCreate and Relate a Note\nCreate a JSON object based on the response (which we will treat as a JSON object named $original_note) like:\n{\n\t\"upload_id\": \"$original_note.id\",\n\t\"file_source\" : \"Notes\"\n\t\"name\" : \"$original_note.filename\",\n\t\"filename\" : \"$original_note.filename\",\n}\nRelate the Note to the Email record using the 'attachments' link. Next, send a POST request to rest/{REST VERSION}/Emails/{$email_id}/link/attachments/\u00c2\u00a0with the JSON shown above as the request body.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_an_Existing_Note_to_an_Email_as_Attachment/index.html"}
{"id": "12870e1f882e-0", "text": "Adding Buttons to the Record View\nOverview\nThis example explains how to create additional buttons on the record view and add events.\u00c2\u00a0We will extend and override the stock Accounts record view to add a custom button. The custom button will be called \"Validate Postal Code\" and ping the Zippopotamus REST service to validate the records billing state and postal code.\nSteps To Complete\nThis tutorial requires the following steps, which are explained in the sections below:\nDefining the Metadata\nAdding Custom Buttons\nDefining the Button Label\nExtending and Overriding the Controller\nDefining the Metadata\nTo add a button to the record view, you will first need to create the custom metadata for the view if it doesn't exist. You can easily do this by opening and saving your modules record layout in studio. Depending on your module, the path will then be ./custom/modules/<module>/clients/base/views/record/record.php. Once your file is in place, you will need to copy the button array from ./clients/base/views/record/record.php and add it to the $viewdefs['<module>']['base']['view']['record'] portion of your metadata array. An example of the button array is shown below:\n'buttons' => array(\n        array(\n            'type' => 'button',\n            'name' => 'cancel_button',\n            'label' => 'LBL_CANCEL_BUTTON_LABEL',\n            'css_class' => 'btn-invisible btn-link',\n            'showOn' => 'edit',\n        ),\n        array(\n            'type' => 'rowaction',\n            'event' => 'button:save_button:click',\n            'name' => 'save_button',\n            'label' => 'LBL_SAVE_BUTTON_LABEL',\n            'css_class' => 'btn btn-primary',\n            'showOn' => 'edit',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Buttons_to_the_Record_View/index.html"}
{"id": "12870e1f882e-1", "text": "'showOn' => 'edit',\n            'acl_action' => 'edit',\n        ),\n        array(\n            'type' => 'actiondropdown',\n            'name' => 'main_dropdown',\n            'primary' => true,\n            'showOn' => 'view',\n            'buttons' => array(\n                array(\n                    'type' => 'rowaction',\n                    'event' => 'button:edit_button:click',\n                    'name' => 'edit_button',\n                    'label' => 'LBL_EDIT_BUTTON_LABEL',\n                    'acl_action' => 'edit',\n                ),\n                array(\n                    'type' => 'shareaction',\n                    'name' => 'share',\n                    'label' => 'LBL_RECORD_SHARE_BUTTON',\n                    'acl_action' => 'view',\n                ),\n                array(\n                    'type' => 'pdfaction',\n                    'name' => 'download-pdf',\n                    'label' => 'LBL_PDF_VIEW',\n                    'action' => 'download',\n                    'acl_action' => 'view',\n                ),\n                array(\n                    'type' => 'pdfaction',\n                    'name' => 'email-pdf',\n                    'label' => 'LBL_PDF_EMAIL',\n                    'action' => 'email',\n                    'acl_action' => 'view',\n                ),\n                array(\n                    'type' => 'divider',\n                ),\n                array(\n                    'type' => 'rowaction',\n                    'event' => 'button:find_duplicates_button:click',\n                    'name' => 'find_duplicates_button',\n                    'label' => 'LBL_DUP_MERGE',\n                    'acl_action' => 'edit',\n                ),\n                array(\n                    'type' => 'rowaction',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Buttons_to_the_Record_View/index.html"}
{"id": "12870e1f882e-2", "text": "),\n                array(\n                    'type' => 'rowaction',\n                    'event' => 'button:duplicate_button:click',\n                    'name' => 'duplicate_button',\n                    'label' => 'LBL_DUPLICATE_BUTTON_LABEL',\n                    'acl_module' => $module,\n                ),\n                array(\n                    'type' => 'rowaction',\n                    'event' => 'button:audit_button:click',\n                    'name' => 'audit_button',\n                    'label' => 'LNK_VIEW_CHANGE_LOG',\n                    'acl_action' => 'view',\n                ),\n                array(\n                    'type' => 'divider',\n                ),\n                array(\n                    'type' => 'rowaction',\n                    'event' => 'button:delete_button:click',\n                    'name' => 'delete_button',\n                    'label' => 'LBL_DELETE_BUTTON_LABEL',\n                    'acl_action' => 'delete',\n                ),\n            ),\n        ),\n        array(\n            'name' => 'sidebar_toggle',\n            'type' => 'sidebartoggle',\n        ),\n    ),\nNote: When copying this array into your metadata, you will need to replace\u00c2\u00a0$module with the text string of your module's name.\nFor standard button types, the button definitions will contain the following properties:\nProperty\nPotential Values\nDescription\ntype\nbutton, rowaction, shareaction, actiondropdown\nThe widget type\nname\n\u00c2\u00a0\nThe name of the button\nlabel\n\u00c2\u00a0\nThe label string key for the display text of the button\ncss_class\n\u00c2\u00a0\nThe CSS class to append to the button\nshowOn\nedit, view\nThe ACL action of the button", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Buttons_to_the_Record_View/index.html"}
{"id": "12870e1f882e-3", "text": "showOn\nedit, view\nThe ACL action of the button\nFor this example, we will add\u00c2\u00a0the\u00c2\u00a0custom button to the main dropdown. For actiondropdown types, there\u00c2\u00a0is an additional buttons array for you to specify the dropdown list of buttons. The button definitions in this array will contain the following properties:\nProperty\nPotential Values\nDescription\ntype\nbutton, rowaction, shareaction, actiondropdown\nThe widget type; Most custom buttons are 'rowaction'\nevent\nbutton:button_name:click\nThe event name of the button\nname\n\u00c2\u00a0\nThe name of the button\nlabel\n\u00c2\u00a0\nThe label string key for the display text of the button\nacl_action\n\u00c2\u00a0edit, view\nThe ACL action of the button\nAdding Custom Buttons\nFor this example, modify the accounts' metadata to add the button definition to main_dropdown:\narray(\n    'type' => 'rowaction',\n    'event' => 'button:validate_postal_code:click',\n    'name' => 'validate_postal_code',\n    'label' => 'LBL_VALIDATE_POSTAL_CODE',\n    'acl_action' => 'view',\n),\nA full example is shown below:\n./custom/modules/Accounts/clients/base/views/record/record.php\n<?php\n$viewdefs['Accounts'] =\narray (\n  'base' =>\n  array (\n    'view' =>\n    array (\n      'record' =>\n      array (\n        'buttons' =>\n        array (\n          0 =>\n          array (\n            'type' => 'button',\n            'name' => 'cancel_button',\n            'label' => 'LBL_CANCEL_BUTTON_LABEL',\n            'css_class' => 'btn-invisible btn-link',\n            'showOn' => 'edit',\n          ),\n          1 =>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Buttons_to_the_Record_View/index.html"}
{"id": "12870e1f882e-4", "text": "'showOn' => 'edit',\n          ),\n          1 =>\n          array (\n            'type' => 'rowaction',\n            'event' => 'button:save_button:click',\n            'name' => 'save_button',\n            'label' => 'LBL_SAVE_BUTTON_LABEL',\n            'css_class' => 'btn btn-primary',\n            'showOn' => 'edit',\n            'acl_action' => 'edit',\n          ),\n          2 =>\n          array (\n            'type' => 'actiondropdown',\n            'name' => 'main_dropdown',\n            'primary' => true,\n            'showOn' => 'view',\n            'buttons' =>\n            array (\n              0 =>\n              array (\n                'type' => 'rowaction',\n                'event' => 'button:edit_button:click',\n                'name' => 'edit_button',\n                'label' => 'LBL_EDIT_BUTTON_LABEL',\n                'acl_action' => 'edit',\n              ),\n              1 =>\n              array (\n                'type' => 'shareaction',\n                'name' => 'share',\n                'label' => 'LBL_RECORD_SHARE_BUTTON',\n                'acl_action' => 'view',\n              ),\n              2 =>\n              array (\n                'type' => 'rowaction',\n                'event' => 'button:validate_postal_code:click',\n                'name' => 'validate_postal_code',\n                'label' => 'LBL_VALIDATE_POSTAL_CODE',\n                'acl_action' => 'view',\n              ),\n              3 =>\n              array (\n                'type' => 'divider',\n              ),\n              4 =>\n              array (\n                'type' => 'rowaction',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Buttons_to_the_Record_View/index.html"}
{"id": "12870e1f882e-5", "text": "4 =>\n              array (\n                'type' => 'rowaction',\n                'event' => 'button:duplicate_button:click',\n                'name' => 'duplicate_button',\n                'label' => 'LBL_DUPLICATE_BUTTON_LABEL',\n                'acl_module' => 'Accounts',\n              ),\n              5 =>\n              array (\n                'type' => 'rowaction',\n                'event' => 'button:audit_button:click',\n                'name' => 'audit_button',\n                'label' => 'LNK_VIEW_CHANGE_LOG',\n                'acl_action' => 'view',\n              ),\n              6 =>\n              array (\n                'type' => 'divider',\n              ),\n              7 =>\n              array (\n                'type' => 'rowaction',\n                'event' => 'button:delete_button:click',\n                'name' => 'delete_button',\n                'label' => 'LBL_DELETE_BUTTON_LABEL',\n                'acl_action' => 'delete',\n              ),\n            ),\n          ),\n          3 =>\n          array (\n            'name' => 'sidebar_toggle',\n            'type' => 'sidebartoggle',\n          ),\n        ),\n        'panels' =>\n        array (\n          0 =>\n          array (\n            'name' => 'panel_header',\n            'header' => true,\n            'fields' =>\n            array (\n              0 =>\n              array (\n                'name' => 'picture',\n                'type' => 'avatar',\n                'width' => 42,\n                'height' => 42,\n                'dismiss_label' => true,\n                'readonly' => true,\n              ),\n              1 => 'name',\n              2 =>\n              array (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Buttons_to_the_Record_View/index.html"}
{"id": "12870e1f882e-6", "text": "),\n              1 => 'name',\n              2 =>\n              array (\n                'name' => 'favorite',\n                'label' => 'LBL_FAVORITE',\n                'type' => 'favorite',\n                'dismiss_label' => true,\n              ),\n              3 =>\n              array (\n                'name' => 'follow',\n                'label' => 'LBL_FOLLOW',\n                'type' => 'follow',\n                'readonly' => true,\n                'dismiss_label' => true,\n              ),\n            ),\n          ),\n          1 =>\n          array (\n            'name' => 'panel_body',\n            'columns' => 2,\n            'labelsOnTop' => true,\n            'placeholders' => true,\n            'fields' =>\n            array (\n              0 => 'website',\n              1 => 'industry',\n              2 => 'parent_name',\n              3 => 'account_type',\n              4 => 'assigned_user_name',\n              5 => 'phone_office',\n            ),\n          ),\n          2 =>\n          array (\n            'name' => 'panel_hidden',\n            'hide' => true,\n            'columns' => 2,\n            'labelsOnTop' => true,\n            'placeholders' => true,\n            'fields' =>\n            array (\n              0 =>\n              array (\n                'name' => 'fieldset_address',\n                'type' => 'fieldset',\n                'css_class' => 'address',\n                'label' => 'LBL_BILLING_ADDRESS',\n                'fields' =>\n                array (\n                  0 =>\n                  array (\n                    'name' => 'billing_address_street',\n                    'css_class' => 'address_street',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Buttons_to_the_Record_View/index.html"}
{"id": "12870e1f882e-7", "text": "'css_class' => 'address_street',\n                    'placeholder' => 'LBL_BILLING_ADDRESS_STREET',\n                  ),\n                  1 =>\n                  array (\n                    'name' => 'billing_address_city',\n                    'css_class' => 'address_city',\n                    'placeholder' => 'LBL_BILLING_ADDRESS_CITY',\n                  ),\n                  2 =>\n                  array (\n                    'name' => 'billing_address_state',\n                    'css_class' => 'address_state',\n                    'placeholder' => 'LBL_BILLING_ADDRESS_STATE',\n                  ),\n                  3 =>\n                  array (\n                    'name' => 'billing_address_postalcode',\n                    'css_class' => 'address_zip',\n                    'placeholder' => 'LBL_BILLING_ADDRESS_POSTALCODE',\n                  ),\n                  4 =>\n                  array (\n                    'name' => 'billing_address_country',\n                    'css_class' => 'address_country',\n                    'placeholder' => 'LBL_BILLING_ADDRESS_COUNTRY',\n                  ),\n                ),\n              ),\n              1 =>\n              array (\n                'name' => 'fieldset_shipping_address',\n                'type' => 'fieldset',\n                'css_class' => 'address',\n                'label' => 'LBL_SHIPPING_ADDRESS',\n                'fields' =>\n                array (\n                  0 =>\n                  array (\n                    'name' => 'shipping_address_street',\n                    'css_class' => 'address_street',\n                    'placeholder' => 'LBL_SHIPPING_ADDRESS_STREET',\n                  ),\n                  1 =>\n                  array (\n                    'name' => 'shipping_address_city',\n                    'css_class' => 'address_city',\n                    'placeholder' => 'LBL_SHIPPING_ADDRESS_CITY',\n                  ),\n                  2 =>\n                  array (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Buttons_to_the_Record_View/index.html"}
{"id": "12870e1f882e-8", "text": "),\n                  2 =>\n                  array (\n                    'name' => 'shipping_address_state',\n                    'css_class' => 'address_state',\n                    'placeholder' => 'LBL_SHIPPING_ADDRESS_STATE',\n                  ),\n                  3 =>\n                  array (\n                    'name' => 'shipping_address_postalcode',\n                    'css_class' => 'address_zip',\n                    'placeholder' => 'LBL_SHIPPING_ADDRESS_POSTALCODE',\n                  ),\n                  4 =>\n                  array (\n                    'name' => 'shipping_address_country',\n                    'css_class' => 'address_country',\n                    'placeholder' => 'LBL_SHIPPING_ADDRESS_COUNTRY',\n                  ),\n                  5 =>\n                  array (\n                    'name' => 'copy',\n                    'label' => 'NTC_COPY_BILLING_ADDRESS',\n                    'type' => 'copy',\n                    'mapping' =>\n                    array (\n                      'billing_address_street' => 'shipping_address_street',\n                      'billing_address_city' => 'shipping_address_city',\n                      'billing_address_state' => 'shipping_address_state',\n                      'billing_address_postalcode' => 'shipping_address_postalcode',\n                      'billing_address_country' => 'shipping_address_country',\n                    ),\n                  ),\n                ),\n              ),\n              2 =>\n              array (\n                'name' => 'phone_alternate',\n                'label' => 'LBL_OTHER_PHONE',\n              ),\n              3 => 'email',\n              4 => 'phone_fax',\n              5 => 'campaign_name',\n              6 =>\n              array (\n                'name' => 'description',\n                'span' => 12,\n              ),\n              7 => 'sic_code',\n              8 => 'ticker_symbol',\n              9 => 'annual_revenue',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Buttons_to_the_Record_View/index.html"}
{"id": "12870e1f882e-9", "text": "8 => 'ticker_symbol',\n              9 => 'annual_revenue',\n              10 => 'employees',\n              11 => 'ownership',\n              12 => 'rating',\n              13 =>\n              array (\n                'name' => 'date_entered_by',\n                'readonly' => true,\n                'type' => 'fieldset',\n                'label' => 'LBL_DATE_ENTERED',\n                'fields' =>\n                array (\n                  0 =>\n                  array (\n                    'name' => 'date_entered',\n                  ),\n                  1 =>\n                  array (\n                    'type' => 'label',\n                    'default_value' => 'LBL_BY',\n                  ),\n                  2 =>\n                  array (\n                    'name' => 'created_by_name',\n                  ),\n                ),\n              ),\n              14 => 'team_name',\n              15 =>\n              array (\n                'name' => 'date_modified_by',\n                'readonly' => true,\n                'type' => 'fieldset',\n                'label' => 'LBL_DATE_MODIFIED',\n                'fields' =>\n                array (\n                  0 =>\n                  array (\n                    'name' => 'date_modified',\n                  ),\n                  1 =>\n                  array (\n                    'type' => 'label',\n                    'default_value' => 'LBL_BY',\n                  ),\n                  2 =>\n                  array (\n                    'name' => 'modified_by_name',\n                  ),\n                ),\n                'span' => 12,\n              ),\n            ),\n          ),\n        ),\n        'templateMeta' =>\n        array (\n          'useTabs' => false,\n          'tabDefs' =>\n          array (\n            'LBL_RECORD_BODY' =>\n            array (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Buttons_to_the_Record_View/index.html"}
{"id": "12870e1f882e-10", "text": "array (\n            'LBL_RECORD_BODY' =>\n            array (\n              'newTab' => false,\n              'panelDefault' => 'expanded',\n            ),\n            'LBL_RECORD_SHOWMORE' =>\n            array (\n              'newTab' => false,\n              'panelDefault' => 'expanded',\n            ),\n          ),\n        ),\n      ),\n    ),\n  ),\n);\nDefining the Button Label\nNext, define the label for the button:\n./custom/Extension/modules/Accounts/Ext/Language/en_us.validatePostalCode.php\n<?php\n$mod_strings['LBL_VALIDATE_POSTAL_CODE'] = 'Validate Postal Code';\nExtending and Overriding the Controller\nOnce the button has been added to the metadata, extend and override the record view controller:\n./custom/modules/Accounts/clients/base/views/record/record.js\n({\n    extendsFrom: 'RecordView',\n    zipJSON: {},\n    initialize: function (options) {\n        this._super('initialize', [options]);\n        //add listener for custom button\n        this.context.on('button:validate_postal_code:click', this.validate_postal_code, this);\n    },\n    validate_postal_code: function() {\n        //example of getting field data from current record\n        var AcctID = this.model.get('id');\n        var currentCity = this.model.get('billing_address_city');\n        var currentZip = this.model.get('billing_address_postalcode');\n        //jQuery AJAX call to Zippopotamus REST API\n        $.ajax({\n            url: 'http://api.zippopotam.us/us/' + currentZip,\n            success: function(data) {\n                    this.zipJSON = data;\n                    var city = this.zipJSON.places[0]['place name'];\n                    if (city === currentCity)", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Buttons_to_the_Record_View/index.html"}
{"id": "12870e1f882e-11", "text": "if (city === currentCity)\n                    {\n                        app.alert.show('address-ok', {\n                            level: 'success',\n                            messages: 'City and Zipcode match.',\n                            autoClose: true\n                        });\n                    }\n                    else\n                    {\n                        app.alert.show('address-ok', {\n                            level: 'error',\n                            messages: 'City and Zipcode do not match.',\n                            autoClose: false\n                        });\n                    }\n                }\n            });\n    }\n})\nOnce the files are in place, navigate to Admin > Repair > Quick Repair and Rebuild.\nAdding Buttons without Overriding View Controllers\nSometimes your customization might need to add the same buttons to multiple views, but you don't want to overwrite other possible customizations already on the view. The following will walk through creating a custom button like the above example, add adding the buttons to views without overriding the module view controllers.\nCreate a Custom Button\nButtons typically come in two forms, a standard button and a 'rowaction' in an Action Menu. We can create two buttons to handle both scenarios.\n./clients/base/fields/zipcode-check-button/zipcode-check-button.js\n/**\n * Zipcode Check button will check if zipcode matches city field\n *\n * @class View.Fields.Base.ZipcodeCheckButtonField\n * @alias SUGAR.App.view.fields.BaseZipcodeCheckButtonField\n * @extends View.Fields.Base.ButtonField\n */\n({\n    extendsFrom: 'ButtonField',\n    defaultZipCodeField: 'billing_address_postalcode',\n    defaultCityField: 'billing_address_city',\n    /**\n     * @inheritdoc\n     */\n    initialize: function(options) {\n        options.def.events = _.extend({}, options.def.events, {\n            'click .zip-check-btn': 'validatePostalCode'\n        });", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Buttons_to_the_Record_View/index.html"}
{"id": "12870e1f882e-12", "text": "'click .zip-check-btn': 'validatePostalCode'\n        });\n        this._super('initialize', [options]);\n        this.def.zip_code_field = _.isEmpty(this.def.zip_code_field)?this.defaultZipCodeField:this.def.zip_code_field;\n        this.def.city_field = _.isEmpty(this.def.city_field)?this.defaultCityField:this.def.city_field;\n    },\n    validatePostalCode: function(evt) {\n        var currentCity = this.model.get(this.def.city_field);\n        var currentZip = this.model.get(this.def.zip_code_field);\n        //jQuery AJAX call to Zippopotamus REST API\n        $.ajax({\n            url: 'http://api.zippopotam.us/us/' + currentZip,\n            success: function(data) {\n                this.zipJSON = data;\n                var city = this.zipJSON.places[0]['place name'];\n                if (city === currentCity)\n                {\n                    app.alert.show('address-ok', {\n                        level: 'success',\n                        messages: 'City and Zipcode match.',\n                        autoClose: true\n                    });\n                }\n                else\n                {\n                    app.alert.show('address-ok', {\n                        level: 'error',\n                        messages: 'City and Zipcode do not match.',\n                        autoClose: false\n                    });\n                }\n            }\n        });\n    }\n})\n./clients/base/fields/zipcode-check-rowaction/zipcode-check-rowaction.js\n/**\n * Zipcode Check button will check if zipcode matches city field\n *\n * @class View.Fields.Base.ZipcodeCheckRowactionField\n * @alias SUGAR.App.view.fields.BaseZipcodeCheckRowactionField\n * @extends View.Fields.Base.RowactionField\n */\n({\n    extendsFrom: 'RowactionField',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Buttons_to_the_Record_View/index.html"}
{"id": "12870e1f882e-13", "text": "*/\n({\n    extendsFrom: 'RowactionField',\n    defaultZipCodeField: 'billing_address_postalcode',\n    defaultCityField: 'billing_address_city',\n    /**\n     * @inheritdoc\n     */\n    initialize: function(options) {\n        this._super('initialize', [options]);\n        this.def.zip_code_field = _.isEmpty(this.def.zip_code_field)?this.defaultZipCodeField:this.def.zip_code_field;\n        this.def.city_field = _.isEmpty(this.def.city_field)?this.defaultCityField:this.def.city_field;\n    },\n    /**\n     * Rowaction fields have a default event which calls rowActionSelect\n     */\n    rowActionSelect: function(evt) {\n        this.validatePostalCode(evt);\n    },\n    validatePostalCode: function(evt) {\n        var currentCity = this.model.get(this.def.city_field);\n        var currentZip = this.model.get(this.def.zip_code_field);\n        //jQuery AJAX call to Zippopotamus REST API\n        $.ajax({\n            url: 'http://api.zippopotam.us/us/' + currentZip,\n            success: function(data) {\n                this.zipJSON = data;\n                var city = this.zipJSON.places[0]['place name'];\n                if (city === currentCity)\n                {\n                    app.alert.show('address-check-msg', {\n                        level: 'success',\n                        messages: 'City and Zipcode match.',\n                        autoClose: true\n                    });\n                }\n                else\n                {\n                    app.alert.show('address-check-msg', {\n                        level: 'error',\n                        messages: 'City and Zipcode do not match.',\n                        autoClose: false\n                    });\n                }\n            }\n        });\n    }\n})", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Buttons_to_the_Record_View/index.html"}
{"id": "12870e1f882e-14", "text": "});\n                }\n            }\n        });\n    }\n})\nAlong with the JavaScript controllers for the buttons, you can copy over the detail.hbs and edit.hbs from the base controllers that each button is\u00c2\u00a0extended from into each folder. The folder structure will look as follows:\n./clients/base/fields/zipcode-check-button/\nzipcode-check-button.js\ndetail.hbs\nedit.hbs\n./clients/base/fields/zipcode-check-rowaction/\nzipcode-check-rowaction.js\ndetail.hbs\nedit.hbs\n\u00c2\u00a0In the Handlebar files, you should add a custom CSS\u00c2\u00a0class called zip-check-btn to each of the layouts, as a way to find the elements on the page. This is also used for the ZipcodeCheckButton to isolate the event trigger. Example below:\n./cilents/base/fields/zipcode-check-button/edit.hbs\n<a href=\"{{#if fullRoute}}#{{fullRoute}}{{else}}{{#if def.route}}#{{buildRoute context=context model=model action=def.route.action}}{{else}}javascript:void(0);{{/if}}{{/if}}\"\n    class=\"btn{{#if def.primary}} btn-primary{{/if}} zip-check-btn\"\n    {{#if def.tooltip}}\n        rel=\"tooltip\"\n        data-placement=\"bottom\"\n        title=\"{{str def.tooltip module}}\"\n    {{/if}}\n    {{#if ariaLabel}}aria-label=\"{{ariaLabel}}\"{{/if}}\n    role=\"button\" tabindex=\"{{tabIndex}}\" name=\"{{name}}\">{{#if def.icon}}<i class=\"fa {{def.icon}}\"></i> {{/if}}{{label}}</a>\nOnce we have the button controllers and the templates setup, we can add the buttons to the View metadata for particular modules.\nAppending Buttons to Metadata", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Buttons_to_the_Record_View/index.html"}
{"id": "12870e1f882e-15", "text": "Appending Buttons to Metadata\nAfter creating your buttons, you will need to append the buttons to the views metadata. For this, you can use the Extension Framework. The following examples will add a button to the action menu on the Accounts record view and a button to the Contacts record view. Please note that this example assumes that you have created the\u00c2\u00a0rowaction button\u00c2\u00a0above.\n./custom/Extension/modules/Accounts/Ext/clients/base/views/record/addZipCodeCheckRowaction.php\n$buttons = isset($viewdefs['Accounts']['base']['view']['record']['buttons'])?$viewdefs['Accounts']['base']['view']['record']['buttons']:array();\nif (!empty($buttons)) {\n    foreach ($buttons as $key => $button) {\n        if ($button['type'] == 'actiondropdown' && $button['name'] == 'main_dropdown') {\n            $viewdefs['Accounts']['base']['view']['record']['buttons'][$key]['buttons'][] = array(\n                'type' => 'divider',\n            );\n            $viewdefs['Accounts']['base']['view']['record']['buttons'][$key]['buttons'][] = array(\n                'type' => 'zipcode-check-rowaction',\n                'event' => 'button:zipcode_check:click',\n                'name' => 'zipcode_check_button',\n                'label' => 'LBL_ZIPCODE_CHECK_BUTTON_LABEL',\n                'acl_action' => 'edit',\n                'showOn' => 'view',\n            );\n            break;\n        }\n    }\n}\n./custom/Extension/modules/Contacts/Ext/clients/base/views/record/addZipCodeCheckButton.php\n$buttons = isset($viewdefs['Contacts']['base']['view']['record']['buttons'])?$viewdefs['Contacts']['base']['view']['record']['buttons']:array();\n$zipCodeButton = array (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Buttons_to_the_Record_View/index.html"}
{"id": "12870e1f882e-16", "text": "$zipCodeButton = array (\n    'type' => 'zipcode-check-button',\n    'event' => 'button:zipcode_check:click',\n    'name' => 'zipcode_check_button',\n    'label' => 'LBL_ZIPCODE_CHECK_BUTTON_LABEL',\n    'acl_action' => 'edit',\n    'zip_code_field' => 'primary_address_postalcode',\n    'city_field' => 'primary_address_city'\n);\nif (!empty($buttons)){\n    foreach($buttons as $key => $button){\n        if ($button['type'] == 'actiondropdown' && $button['name'] == 'main_dropdown'){\n            //Get everything from this point down\n            $slicedBtns = array_slice($viewdefs['Contacts']['base']['view']['record']['buttons'],$key);\n            //Remove everything from this point down\n            array_splice($viewdefs['Contacts']['base']['view']['record']['buttons'],$key);\n            //Add Zip Code Button\n            $viewdefs['Contacts']['base']['view']['record']['buttons'][] = $zipCodeButton;\n            //Add back the buttons we removed\n            foreach($slicedBtns as $oldButton){\n                $viewdefs['Contacts']['base']['view']['record']['buttons'][] = $oldButton;\n            }\n            break;\n        }\n    }\n} else {\n    $viewdefs['Contacts']['base']['view']['record']['buttons'] = array(\n        $zipCodeButton\n    );\n}\nunset($zipCodeButton);\nThe last thing that is needed now, is to define the button's label.\nDefining the Button Labels\nSince the button was made to work globally on multiple modules, we can define the label at the application level.\n./custom/Extension/application/Ext/Language/en_us.ZipCodeCheckButton.php", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Buttons_to_the_Record_View/index.html"}
{"id": "12870e1f882e-17", "text": "./custom/Extension/application/Ext/Language/en_us.ZipCodeCheckButton.php\n$app_strings['LBL_ZIPCODE_CHECK_BUTTON_LABEL'] = 'Verify Zip Code';\n\u00c2\u00a0Once all files are in place, you can run a Quick Repair and Rebuild and the buttons will display and check the Zipcode fields for both the Contacts and Accounts record views without having to extend either modules RecordView controllers.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Adding_Buttons_to_the_Record_View/index.html"}
{"id": "97d93edc28d1-0", "text": "Removing the Account Requirement on Opportunities\nOverview\nThis article covers how to remove the Account field from being required on the Opportunities module.\u00c2\u00a0\nRemoving the Requirement in Configuration\nBy default, Sugar requires the accounts field to be populated on several modules. These modules include\nOpportunities\nCases\nContracts\nIn order to remove this dependency, you will need to modify the\u00c2\u00a0require_accounts\u00c2\u00a0configuration in\u00c2\u00a0your\u00c2\u00a0 ./config_override.php.\n$sugar_config['require_accounts'] = false;\nThe resulting file should look similar to:\nRemoving the Requirement in Vardefs\nOnce you have updated your configuration, you may find the field is still required. This may be due to the module's vardefs array having the field's required attribute set to true. This will also need to be updated. Using\u00c2\u00a0the Opportunities vardefs as an example, we will need to do the following:\nCreate a custom file in the Opportunities Extension directory like ./custom/Extension/modules/Opportunities/Ext/Vardefs/no_account_required.php\u00c2\u00a0\nSet the content of this file so that the\u00c2\u00a0account_name field has required set to false\n<?php\n$dictionary['Opportunity']['fields']['account_name']['required'] = false;\nOnce completed, you will need to navigate to Admin > Repairs and run a Quick Repair & Rebuild\nRemoving the Requirement in View Metadata\nIf the Account field is still required after making these changes, this may be due to the views metadata having the field's required attribute set to true. By default, account_name\u00c2\u00a0should not be set to required, but if you have created custom views, these may need to be updated. Using\u00c2\u00a0the Opportunities record view as an example, we will need to do the following:\nEdit\u00c2\u00a0\u00c2\u00a0./custom/modules/Opportunities/clients/base/views/record/record.php\u00c2\u00a0with a text editor application.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Removing_the_Account_Requirement_on_Opportunities/index.html"}
{"id": "97d93edc28d1-1", "text": "Search for the\u00c2\u00a0account_name field in panel definitions of your record view.\nRemove\u00c2\u00a0'required' => true,\u00c2\u00a0from\u00c2\u00a0the account_name\u00c2\u00a0definition. If it doesn't already exist, you don't need to modify anything.\n...\n  'fields' => \n    array (\n      0 => \n        array (\n          'name' => 'account_name',\n          'required' => false,\n          ...\nYour resulting file should be:\n...\n  'fields' => \n    array (\n      0 => \n        array (\n          'name' => 'account_name',\n          ...\nThese changes will only affect\u00c2\u00a0the\u00c2\u00a0record view for Opportunities.\u00c2\u00a0You may need to modify additional module layouts based on your use case.\u00c2\u00a0A\u00c2\u00a0list of other views you many need to modify for your module are\u00c2\u00a0shown below.\n./custom/modules/<module>/clients/base/views/list/list.php\n./custom/modules/<module>/clients/base/views/record/record.php\n./custom/modules/<module>/clients/base/views/dupecheck-list/dupecheck-list.php\n./custom/modules/<module>/clients/base/views/resolve-conflicts-list/resolve-conflicts-list.php\n./custom/modules/<module>/clients/base/views/selection-list/selection-list.php\n./custom/modules/<module>/clients/base/views/subpanel-list/subpanel-list.php\nOnce completed, you will need to navigate to Admin > Repairs and run a Quick Repair & Rebuild\nApplication\nNow that the appropriate changes have been made, navigate to the Opportunities module and create a new opportunity record. You will notice that the Account Name field no longer indicates \"Required\" in the field. In addition, the Account Name field will no longer be marked as required when importing records into the Opportunities module.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Removing_the_Account_Requirement_on_Opportunities/index.html"}
{"id": "97d93edc28d1-2", "text": "Last modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Removing_the_Account_Requirement_on_Opportunities/index.html"}
{"id": "27a7194ad433-0", "text": "Increasing the Number of Dashboards Displayed in the Home Menu\nOverview\nBy default, the \"Home Dashboard\" comes out-of-the-box with Sugar\u00c2\u00ae to display on the home page. In addition, Sugar users with a Sugar Serve and/or Sugar Sell license type\u00c2\u00a0will have access to specialized Home page dashboards called \"Service Console\" and \"Renewals Console\".\u00c2\u00a0 Users have the ability to create new dashboards on their home page and build out its layout and dashlet set. Currently, Sugar imposes a limit of 50 dashboards that\u00c2\u00a0can be displayed under the Home module tab.\u00c2\u00a0So, when creating multiple dashboards, keep in mind that having more than 50 in the list of available dashboards will cause the ones in the beginning to be dropped off the list.\u00c2\u00a0This article covers\u00c2\u00a0how to increase the number of dashboards allowed in the Home menu via a code-level customization.\nUse Case\nIn this example, we will make a code-level change to set\u00c2\u00a0the number of dashboards allowed in the Home menu to \"80\".\nPrerequisites\nThis change requires code-level customizations. You will need direct access to the server as well as administrator access in Sugar in order to perform the necessary actions. If you need\u00c2\u00a0assistance making these changes and already have a relationship with a Sugar partner, you can work with them to make this change.\u00c2\u00a0If not, please refer to the Partner Page to find a reselling partner to help with your development needs.\u00c2\u00a0\nYou will also need the following capabilities prior to making this code-level customization:\nYou should have a working knowledge of PHP development\u00c2\u00a0and arrays.\nYou should have access to\u00c2\u00a0a text editor that can be used for programming.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Increasing_the_Number_of_Dashboards_Displayed_in_the_Home_Menu/index.html"}
{"id": "27a7194ad433-1", "text": "You should have access to\u00c2\u00a0a text editor that can be used for programming.\nIf your Sugar instance is hosted on Sugar's cloud service or hosted on a server to which you do not have direct file access, you will need to know how to create and deploy Module Loader packages. For more information, please refer to the Module Loader section of the Developer Guide.\nNote: Sugar Sell Essentials customers do not have the ability to upload custom file packages to Sugar using Module Loader.\nSteps to Complete\nThe following steps cover setting the number of dashboards allowed on the Home menu to \"80\" as an example:\nNavigate to ./modules/Home/clients/base/views/module-menu/module-menu.php and copy the file contents to a new file at ./custom/modules/Home/clients/base/views/module-menu/module-menu.php. The contents of the file should look similar to this:\n<?php\n$viewdefs['Home']['base']['view']['module-menu'] = array(\n  'settings' => array(\n     'favorites' => 0,\n     'recently_viewed' => 10,\n     'recently_viewed_toggle' => 3,\n  ),\n);\n?>\nModify the ./custom/modules/Home/clients/base/views/module-menu/module-menu.php file and add the\u00c2\u00a0dashboards => 80, element to the array. The modified file should look similar to this:<?php\n$viewdefs['Home']['base']['view']['module-menu'] = array(\n  'settings' => array(\n     'dashboards' => 80,\n     'favorites' => 0,\n     'recently_viewed' => 10,\n     'recently_viewed_toggle' => 3,\n  ),\n);\n?>\nSave the changes to the file and update the ownership and permissions of the files that were created.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Increasing_the_Number_of_Dashboards_Displayed_in_the_Home_Menu/index.html"}
{"id": "27a7194ad433-2", "text": "Save the changes to the file and update the ownership and permissions of the files that were created.\nFor more information on Linux-based stacks, please refer to the Required File System Permissions on Linux article.\nFor more information on Windows-based stacks, please refer to the Required File System Permissions on Windows With IIS article.\u00c2\u00a0\nFinally, log\u00c2\u00a0into Sugar as an administrator, navigate to Admin > Repair, and perform a \"Quick Repair and Rebuild\". This will rebuild the cached files to fully implement the changes to your Sugar instance.\nApplication\nOnce the appropriate changes have\u00c2\u00a0been made, users should be able to create and view up to 80 dashboards on their home page and any previously missing dashboards should now display in the Home menu as well.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Increasing_the_Number_of_Dashboards_Displayed_in_the_Home_Menu/index.html"}
{"id": "ca2a08c148dc-0", "text": "Web Services\nExamples when working with Sugar's web service endpoints.\nTopicsREST APIExamples of integrating with Sugar REST APIs.Legacy APIExamples of the legacy v4_1 web service endpoints.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/index.html"}
{"id": "ea49d88c1983-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nLegacy API\nExamples of the legacy v4_1 web service endpoints.\nTopicsRESTExamples of v4.1 REST API calls.SOAPExamples of v4.1 SOAP API calls.\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/index.html"}
{"id": "e6b62967d296-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nSOAP\nExamples of v4.1 SOAP API calls.\nTopicsC#C# SOAP v4_1 Examples.\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/SOAP/index.html"}
{"id": "d9fd8e11f88b-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nC#\nC# SOAP v4_1 Examples.\nTopicsCreating or Updating a RecordA C# example demonstrating how to create or update an account with the set_entry method using SOAP and the v4 SOAP API.Logging InA C# example demonstrating how to log in and retrieve a session key using SOAP and the v4 SOAP API.\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/SOAP/C_sharp/index.html"}
{"id": "9b263d860132-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nCreating or Updating a Record\nOverview\nA C# example demonstrating how to create or update an account with the set_entry method using SOAP and the v4 SOAP API.\nExample\nusing System;\nusing System.Text;\nusing System.Security.Cryptography;\nusing System.Collections.Specialized;\nnamespace SugarSoap\n{\n    class Program\n    {\n        static void Main(string[] args)\n        {\n            //login -----------------------------------------\n            \n            string UserName = \"admin\";\n            string Password = \"password\";\n            string URL = \"http://{site_url}/service/v4/soap.php\";\n            //SugarCRM is a web reference added that points to http://{site_url}/service/v4/soap.php?wsdl\n            SugarCRM.sugarsoap SugarClient = new SugarCRM.sugarsoap();\n            SugarClient.Timeout = 900000;\n            SugarClient.Url = URL;\n            string SessionID = String.Empty;\n            //Create authentication object\n            SugarCRM.user_auth UserAuth = new SugarCRM.user_auth();\n            //Populate credentials\n            UserAuth.user_name = UserName;\n            UserAuth.password = getMD5(Password);\n            //Try to authenticate\n            SugarCRM.name_value[] LoginList = new SugarCRM.name_value[0];\n            SugarCRM.entry_value LoginResult = SugarClient.login(UserAuth, \"SoapTest\", LoginList);\n            \n            //get session id\n            SessionID = LoginResult.id;\n            //create account --------------------------------\n            \n            NameValueCollection fieldListCollection = new NameValueCollection();\n            //to update a record, you will nee to pass in a record id as commented below", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/SOAP/C_sharp/Creating_or_Updating_a_Record/index.html"}
{"id": "9b263d860132-1", "text": "//fieldListCollection.Add(\"id\", \"68c4781f-75d1-223a-5d8f-5058bc4e39ea\");\n            fieldListCollection.Add(\"name\", \"Test Account\");\n            //this is just a trick to avoid having to manually specify index values for name_value[]\n            SugarCRM.name_value[] fieldList = new SugarCRM.name_value[fieldListCollection.Count];\n            int count = 0;\n            foreach (string name in fieldListCollection)\n            {\n                foreach (string value in fieldListCollection.GetValues(name))\n                {\n                    SugarCRM.name_value field = new SugarCRM.name_value();\n                    field.name = name; field.value = value;\n                    fieldList[count] = field;\n                }\n                count++;\n            }\n            \n            try\n            {\n                SugarCRM.new_set_entry_result result = SugarClient.set_entry(SessionID, \"Accounts\", fieldList);\n                string RecordID = result.id;\n                //show record id to user\n                Console.WriteLine(RecordID);\n            }\n            catch (Exception ex)\n            {\n                Console.WriteLine(ex.Message);\n                Console.WriteLine(ex.Source);\n            }\n            \n            //Pause Window\n            Console.ReadLine();\n        }\n        static private string getMD5(string PlainText)\n        {\n            MD5 md5 = MD5.Create();\n            byte[] inputBuffer = System.Text.Encoding.ASCII.GetBytes(PlainText);\n            byte[] outputBuffer = md5.ComputeHash(inputBuffer);\n            //Convert the byte[] to a hex-string\n            StringBuilder builder = new StringBuilder(outputBuffer.Length);\n            for (int i = 0; i < outputBuffer.Length; i++)\n            {\n                builder.Append(outputBuffer[i].ToString(\"X2\"));\n            }", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/SOAP/C_sharp/Creating_or_Updating_a_Record/index.html"}
{"id": "9b263d860132-2", "text": "{\n                builder.Append(outputBuffer[i].ToString(\"X2\"));\n            }\n            return Builder.ToString().ToLower(); //lowercase as of 7.9.0.0\n        }\n    }\n}\nResult\n68c4781f-75d1-223a-5d8f-5058bc4e39ea\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/SOAP/C_sharp/Creating_or_Updating_a_Record/index.html"}
{"id": "8e9808c06a4e-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nLogging In\nOverview\nA C# example demonstrating how to log in and retrieve a session key using SOAP and the v4 SOAP API.\nExample\nusing System;\nusing System.Text;\nusing System.Security.Cryptography;\nnamespace SugarSoap\n{\n    class Program\n    {\n        static void Main(string[] args)\n        {\n            string UserName = \"admin\";\n            string Password = \"password\";\n            string URL = \"http://{site_url}/service/v4/soap.php\";\n            string SessionID = String.Empty;\n            //SugarCRM is a web reference added that points to http://{site_url}/service/v4/soap.php?wsdl\n            SugarCRM.sugarsoap SugarClient = new SugarCRM.sugarsoap();\n            SugarClient.Timeout = 900000;\n            SugarClient.Url = URL;\n            //Create authentication object\n            SugarCRM.user_auth UserAuth = new SugarCRM.user_auth();\n            //Populate credentials\n            UserAuth.user_name = UserName;\n            UserAuth.password = getMD5(Password);\n            //Try to authenticate\n            SugarCRM.name_value[] LoginList = new SugarCRM.name_value[0];\n            SugarCRM.entry_value LoginResult = SugarClient.login(UserAuth, \"SoapTest\", LoginList);\n            \n            //get session id\n            SessionID = LoginResult.id;\n            if (SessionID != String.Empty)\n            {\n                //print session\n                Console.WriteLine(SessionID);\n            }\n            //Pause Window\n            Console.ReadLine();\n        }\n        static private string getMD5(string TextString)\n        {\n            MD5 md5 = MD5.Create();\n            byte[] inputBuffer = System.Text.Encoding.ASCII.GetBytes(TextString);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/SOAP/C_sharp/Logging_In/index.html"}
{"id": "8e9808c06a4e-1", "text": "byte[] inputBuffer = System.Text.Encoding.ASCII.GetBytes(TextString);\n            byte[] outputBuffer = md5.ComputeHash(inputBuffer);\n            StringBuilder Builder = new StringBuilder(outputBuffer.Length);\n            for (int i = 0; i < outputBuffer.Length; i++)\n            {\n                Builder.Append(outputBuffer[i].ToString(\"X2\"));\n            }\n            return Builder.ToString().ToLower(); //lowercase as of 7.9.0.0\n        }\n    }\n}\nNote:\u00c2\u00a0As of 7.9.0.0, the md5 of the password must be lowercase.\nResult\nb2uv0vrjfiov41d03sk578ufq6\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/SOAP/C_sharp/Logging_In/index.html"}
{"id": "2a5cbac6d141-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nREST\nExamples of v4.1 REST API calls.\nTopicsPHPPHP v4_1 REST Examples.\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/index.html"}
{"id": "321e83995f89-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nPHP\nPHP v4_1 REST Examples.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/index.html"}
{"id": "321e83995f89-1", "text": "TopicsCreating DocumentsA PHP example demonstrating how to create a document using set_entry and a document revision with the set_document_revision method using cURL and the v4_1 REST API.Creating Notes with AttachmentsA PHP example demonstrating how to create a note using set_entry and add an attachment with the set_note_attachment method using cURL and the v4_1 REST API.Creating or Updating a RecordA PHP example demonstrating how to create or update an Account with the set_entry method using cURL and the v4_1 REST API.Creating or Updating Multiple RecordsA PHP example demonstrating how to create or update multiple contacts with the set_entries method using cURL and the v4_1 REST API.Creating or Updating TeamsA PHP example demonstrating how to manipulate teams using cURL and the v4_1 REST API.Logging InA PHP example demonstrating how to log in and retrieve a session key using cURL and the v4_1 REST API.Relating Quotes and ProductsA PHP example demonstrating how to create and relate Products to Quotes using cURL and the v4_1 REST API.Retrieving a List of Fields From a ModuleA PHP example demonstrating how to retrieve fields vardefs from the accounts module with the get_module_fields method using cURL and the v4_1 REST API.Retrieving a List of RecordsA PHP example demonstrating how to retrieve a list of records from a module with the get_entry_list method using cURL and the v4_1 REST API.Retrieving a List of Records With Related InfoA PHP example demonstrating how to retrieve a list of records with info from a related entity with the get_entry_list method using cURL and the v4_1 REST API.Retrieving Email AttachmentsA PHP example demonstrating how to retrieve an email and its attachments from using the get_entry and get_note_attachment methods using cURL and the v4_1 REST API.Retrieving Multiple Records by IDA PHP example demonstrating how to retrieve multiple records from the accounts module with the", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/index.html"}
{"id": "321e83995f89-2", "text": "Multiple Records by IDA PHP example demonstrating how to retrieve multiple records from the accounts module with the get_entries method using cURL and the v4_1 REST API.Retrieving Records by Email DomainA PHP example demonstrating how to retrieve email addresses based on an email domain with the search_by_module and get_entries methods using cURL and the v4_1 REST API.Retrieving Related RecordsA PHP example demonstrating how to retrieve a list of related records with the get_relationships method using cURL and the v4_1 REST API.Searching RecordsA PHP example demonstrating how to search the accounts module with the search_by_module method using cURL and the v4_1 REST API.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/index.html"}
{"id": "321e83995f89-3", "text": "Last modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/index.html"}
{"id": "1b66c53ca218-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nCreating or Updating a Record\nOverview\nA PHP example demonstrating how to create or update an Account with the set_entry method using cURL and the v4_1 REST API.\nExample\n<?php\n    $url = \"http://{site_url}/service/v4_1/rest.php\";\n    $username = \"admin\";\n    $password = \"password\";\n    //function to make cURL request\n    function call($method, $parameters, $url)\n    {\n        ob_start();\n        $curl_request = curl_init();\n        curl_setopt($curl_request, CURLOPT_URL, $url);\n        curl_setopt($curl_request, CURLOPT_POST, 1);\n        curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\n        curl_setopt($curl_request, CURLOPT_HEADER, 1);\n        curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\n        curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\n        curl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\n        $jsonEncodedData = json_encode($parameters);\n        $post = array(\n             \"method\" => $method,\n             \"input_type\" => \"JSON\",\n             \"response_type\" => \"JSON\",\n             \"rest_data\" => $jsonEncodedData\n        );\n        curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post);\n        $result = curl_exec($curl_request);\n        curl_close($curl_request);\n        $result = explode(\"\\r\\n\\r\\n\", $result, 2);\n        $response = json_decode($result[1]);\n        ob_end_flush();\n        return $response;\n    }\n    //login ---------------------------------------------", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Creating_or_Updating_a_Record/index.html"}
{"id": "1b66c53ca218-1", "text": "return $response;\n    }\n    //login ---------------------------------------------     \n    \n    $login_parameters = array(\n         \"user_auth\" => array(\n              \"user_name\" => $username,\n              \"password\" => md5($password),\n              \"version\" => \"1\"\n         ),\n         \"application_name\" => \"RestTest\",\n         \"name_value_list\" => array(),\n    );\n    $login_result = call(\"login\", $login_parameters, $url);\n    /*\n    echo \"<pre>\";\n    print_r($login_result);\n    echo \"</pre>\";\n    */\n    //get session id\n    $session_id = $login_result->id;\n    //create account -------------------------------------     \n    $set_entry_parameters = array(\n         //session id\n         \"session\" => $session_id,\n         //The name of the module from which to retrieve records.\n         \"module_name\" => \"Accounts\",\n         //Record attributes\n         \"name_value_list\" => array(\n              //to update a record, you will nee to pass in a record id as commented below\n              //array(\"name\" => \"id\", \"value\" => \"9b170af9-3080-e22b-fbc1-4fea74def88f\"),\n              array(\"name\" => \"name\", \"value\" => \"Test Account\"),\n         ),\n    );\n    $set_entry_result = call(\"set_entry\", $set_entry_parameters, $url);\n    echo \"<pre>\";\n    print_r($set_entry_result);\n    echo \"</pre>\";\n?>\nResult\nstdClass Object\n(\n    [id] => 9b170af9-3080-e22b-fbc1-4fea74def88f\n    [entry_list] => stdClass Object\n        (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Creating_or_Updating_a_Record/index.html"}
{"id": "1b66c53ca218-2", "text": "[entry_list] => stdClass Object\n        (\n            [name] => stdClass Object\n                (\n                    [name] => name\n                    [value] => Test Account\n                )\n        )\n)\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Creating_or_Updating_a_Record/index.html"}
{"id": "50a94f784bd5-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nRetrieving Email Attachments\nOverview\nA PHP example demonstrating how to retrieve an email and its attachments from using the get_entry and get_note_attachment methods using cURL and the v4_1 REST API.\nThis example will retrieve a specified email record by its ID and write the attachments to the local filesystem.\nExample\n<?php\n$url = \"http://{site_url}/service/v4_1/rest.php\";\n$username = \"admin\";\n$password = \"password\";\n//function to make cURL request\nfunction call($method, $parameters, $url)\n{\n    ob_start();\n    $curl_request = curl_init();\n    curl_setopt($curl_request, CURLOPT_URL, $url);\n    curl_setopt($curl_request, CURLOPT_POST, 1);\n    curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\n    curl_setopt($curl_request, CURLOPT_HEADER, 1);\n    curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\n    curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\n    curl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\n    $jsonEncodedData = json_encode($parameters);\n    $post = array(\n        \"method\" => $method,\n        \"input_type\" => \"JSON\",\n        \"response_type\" => \"JSON\",\n        \"rest_data\" => $jsonEncodedData\n    );\n    curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post);\n    $result = curl_exec($curl_request);\n    curl_close($curl_request);\n    $result = explode(\"\\r\\n\\r\\n\", $result, 2);\n    $response = json_decode($result[1]);\n    ob_end_flush();\n    return $response;", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Email_Attachments/index.html"}
{"id": "50a94f784bd5-1", "text": "ob_end_flush();\n    return $response;\n}\n//login --------------------------------------------- \n$login_parameters = array(\n    \"user_auth\" => array(\n        \"user_name\" => $username,\n        \"password\" => md5($password),\n        \"version\" => \"1\"\n    ),\n    \"application_name\" => \"RestTest\",\n    \"name_value_list\" => array(),\n);\n$login_result = call(\"login\", $login_parameters, $url);\n/*\necho \"<pre>\";\nprint_r($login_result);\necho \"</pre>\";\n*/\n//get session id\n$session_id = $login_result->id;\n//retrieve the email --------------------------------------------- \n// email id of an email with an attachment\n$email_id   = '5826bd75-527a-a736-edf5-5205421467bf';\n// use get_entry to get the email contents\n$get_entry_parameters = array(\n    'session' => $session_id,\n    'module_name' => 'Emails',\n    'id' => $email_id,\n    'select_fields' => array(),\n    'link_name_to_fields_array' => array(\n        array(\n            'name' => 'notes',\n            'value' => array(\n                'id',\n                'name',\n                'file_mime_type',\n                'filename',\n                'description',\n            ),\n        ),\n    ),\n    'track_view' => false\n);\n$get_entry_result = call('get_entry', $get_entry_parameters, $url);\n//Email record contents\necho \"<pre>\";\nprint_r($get_entry_result);\necho \"</pre>\";\nif (!isset($get_entry_result->entry_list[0]))\n{\n    echo \"Email not found!\";\n    die();\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Email_Attachments/index.html"}
{"id": "50a94f784bd5-2", "text": "{\n    echo \"Email not found!\";\n    die();\n}\nif (!isset($get_entry_result->relationship_list) || count($get_entry_result->relationship_list) == 0)\n{\n    echo \"No attachments found!\";\n    die();\n}\n//retrieve any attachments --------------------------------------------- \nforeach ($get_entry_result->relationship_list[0][0]->records as $key => $attachmentInfo)\n{\n    $get_note_attachment_parameters = array(\n        'session' => $session_id,\n        'id'      => $attachmentInfo->id->value,\n    );\n    $get_note_attachment_result = call('get_note_attachment', $get_note_attachment_parameters, $url);\n    //attachment contents\n    echo \"<pre>\";\n    print_r($get_note_attachment_result);\n    echo \"</pre>\";\n    $file_name = $get_note_attachment_result->note_attachment->filename;\n    //decode and get file contents\n    $file_contents = base64_decode($get_note_attachment_result->note_attachment->file);\n    //write file\n    file_put_contents($file_name, $file_contents);\n}\nResult\n//Email Result\nstdClass Object\n(\n    [entry_list] => Array\n        (\n            [0] => stdClass Object\n                (\n                    [id] => 5826bd75-527a-a736-edf5-5205421467bf\n                    [module_name] => Emails\n                    [name_value_list] => stdClass Object\n                        (\n                            [assigned_user_name] => stdClass Object\n                                (\n                                    [name] => assigned_user_name\n                                    [value] => Administrator\n                                )\n                            [modified_by_name] => stdClass Object\n                                (\n                                    [name] => modified_by_name\n                                    [value] => Administrator\n                                )\n                            [created_by_name] => stdClass Object", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Email_Attachments/index.html"}
{"id": "50a94f784bd5-3", "text": "[value] => Administrator\n                                )\n                            [created_by_name] => stdClass Object\n                                (\n                                    [name] => created_by_name\n                                    [value] => Administrator\n                                )\n                            [team_id] => stdClass Object\n                                (\n                                    [name] => team_id\n                                    [value] => 1\n                                )\n                            [team_set_id] => stdClass Object\n                                (\n                                    [name] => team_set_id\n                                    [value] => 1\n                                )\n                            [team_name] => stdClass Object\n                                (\n                                    [name] => team_name\n                                    [value] => Global\n                                )\n                            [id] => stdClass Object\n                                (\n                                    [name] => id\n                                    [value] => 5826bd75-527a-a736-edf5-5205421467bf\n                                )\n                            [date_entered] => stdClass Object\n                                (\n                                    [name] => date_entered\n                                    [value] => 2013-08-09 19:28:00\n                                )\n                            [date_modified] => stdClass Object\n                                (\n                                    [name] => date_modified\n                                    [value] => 2013-08-09 19:29:08\n                                )\n                            [assigned_user_id] => stdClass Object\n                                (\n                                    [name] => assigned_user_id\n                                    [value] => 1\n                                )\n                            [modified_user_id] => stdClass Object\n                                (\n                                    [name] => modified_user_id\n                                    [value] => 1\n                                )\n                            [created_by] => stdClass Object\n                                (\n                                    [name] => created_by\n                                    [value] => 1\n                                )\n                            [deleted] => stdClass Object\n                                (\n                                    [name] => deleted\n                                    [value] => 0\n                                )", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Email_Attachments/index.html"}
{"id": "50a94f784bd5-4", "text": "[name] => deleted\n                                    [value] => 0\n                                )\n                            [from_addr_name] => stdClass Object\n                                (\n                                    [name] => from_addr_name\n                                    [value] => SugarCRM\n                                )\n                            [to_addrs_names] => stdClass Object\n                                (\n                                    [name] => to_addrs_names\n                                    [value] => email@address.com\n                                )\n                            [description_html] => stdClass Object\n                                (\n                                    [name] => description_html\n                                    [value] =>\n                                )\n                            [description] => stdClass Object\n                                (\n                                    [name] => description\n                                    [value] =>\n                                )\n                            [date_sent] => stdClass Object\n                                (\n                                    [name] => date_sent\n                                    [value] => 2013-08-09 19:28:00\n                                )\n                            [message_id] => stdClass Object\n                                (\n                                    [name] => message_id\n                                    [value] =>\n                                )\n                            [message_uid] => stdClass Object\n                                (\n                                    [name] => message_uid\n                                    [value] =>\n                                )\n                            [name] => stdClass Object\n                                (\n                                    [name] => name\n                                    [value] => Example\n                                )\n                            [type] => stdClass Object\n                                (\n                                    [name] => type\n                                    [value] => out\n                                )\n                            [status] => stdClass Object\n                                (\n                                    [name] => status\n                                    [value] => read\n                                )\n                            [flagged] => stdClass Object\n                                (\n                                    [name] => flagged\n                                    [value] => 0\n                                )\n                            [reply_to_status] => stdClass Object\n                                (\n                                    [name] => reply_to_status\n                                    [value] => 0\n                                )\n                            [intent] => stdClass Object", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Email_Attachments/index.html"}
{"id": "50a94f784bd5-5", "text": "[value] => 0\n                                )\n                            [intent] => stdClass Object\n                                (\n                                    [name] => intent\n                                    [value] => pick\n                                )\n                            [mailbox_id] => stdClass Object\n                                (\n                                    [name] => mailbox_id\n                                    [value] =>\n                                )\n                            [parent_name] => stdClass Object\n                                (\n                                    [name] => parent_name\n                                    [value] => Having trouble adding new items\n                                )\n                            [parent_type] => stdClass Object\n                                (\n                                    [name] => parent_type\n                                    [value] => Cases\n                                )\n                            [parent_id] => stdClass Object\n                                (\n                                    [name] => parent_id\n                                    [value] => 116d4d46-928c-d4af-c22e-518ae4eb13fc\n                                )\n                        )\n                )\n        )\n    [relationship_list] => Array\n        (\n            [0] => Array\n                (\n                    [0] => stdClass Object\n                        (\n                            [name] => notes\n                            [records] => Array\n                                (\n                                    [0] => stdClass Object\n                                        (\n                                            [id] => stdClass Object\n                                                (\n                                                    [name] => id\n                                                    [value] => 1b63a8f9-ce67-6aad-b5a4-52054af18c47\n                                                )\n                                            [name] => stdClass Object\n                                                (\n                                                    [name] => name\n                                                    [value] => Example.zip\n                                                )\n                                            [file_mime_type] => stdClass Object\n                                                (\n                                                    [name] => file_mime_type\n                                                    [value] => application/zip\n                                                )\n                                            [filename] => stdClass Object\n                                                (\n                                                    [name] => filename\n                                                    [value] => Example2.zip\n                                                )", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Email_Attachments/index.html"}
{"id": "50a94f784bd5-6", "text": "[name] => filename\n                                                    [value] => Example2.zip\n                                                )\n                                            [description] => stdClass Object\n                                                (\n                                                    [name] => description\n                                                    [value] =>\n                                                )\n                                            [_empty_] => stdClass Object\n                                                (\n                                                    [name] =>\n                                                    [value] =>\n                                                )\n                                        )\n                                    [1] => stdClass Object\n                                        (\n                                            [id] => stdClass Object\n                                                (\n                                                    [name] => id\n                                                    [value] => 592f382d-b633-fd5f-803e-5205423a6d0b\n                                                )\n                                            [name] => stdClass Object\n                                                (\n                                                    [name] => name\n                                                    [value] => Example2.zip\n                                                )\n                                            [file_mime_type] => stdClass Object\n                                                (\n                                                    [name] => file_mime_type\n                                                    [value] => application/zip\n                                                )\n                                            [filename] => stdClass Object\n                                                (\n                                                    [name] => filename\n                                                    [value] => Example2.zip\n                                                )\n                                            [description] => stdClass Object\n                                                (\n                                                    [name] => description\n                                                    [value] =>\n                                                )\n                                            [_empty_] => stdClass Object\n                                                (\n                                                    [name] =>\n                                                    [value] =>\n                                                )\n                                        )\n                                )\n                        )\n                )\n        )\n)\n//Attachment 1 Result\nstdClass Object\n(\n    [note_attachment] => stdClass Object\n        (\n            [id] => 1b63a8f9-ce67-6aad-b5a4-52054af18c47\n            [filename] => Example.zip\n            [file] => UEsDBAoAAAAIAOujCEOkMbvsNa0AAMCFAgAXAAAARmlsZXMvaW", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Email_Attachments/index.html"}
{"id": "50a94f784bd5-7", "text": "[related_module_id] => 5826bd75-527a-a736-edf5-5205421467bf\n            [related_module_name] => Emails\n        )\n)\n//Attachment 2 Result\nstdClass Object\n(\n    [note_attachment] => stdClass Object\n        (\n            [id] => 592f382d-b633-fd5f-803e-5205423a6d0b\n            [filename] => Example2.zip\n            [file] => AEUoaAAARmlslsZXMvaWZXujCEOkMbvsNa0AAMCFAgAXAAAARm\n            [related_module_id] => 5826bd75-527a-a736-edf5-5205421467bf\n            [related_module_name] => Emails\n        )\n)\nRelated\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Email_Attachments/index.html"}
{"id": "0cf03a55563e-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nCreating Documents\nOverview\nA PHP example demonstrating how to create a document using set_entry and a document revision with the set_document_revision method using cURL and the v4_1 REST API.\nExample\n<?php\n    $url = \"http://{site_url}/service/v4_1/rest.php\";\n    $username = \"admin\";\n    $password = \"password\";\n    //function to make cURL request\n    function call($method, $parameters, $url)\n    {\n        ob_start();\n        $curl_request = curl_init();\n        curl_setopt($curl_request, CURLOPT_URL, $url);\n        curl_setopt($curl_request, CURLOPT_POST, 1);\n        curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\n        curl_setopt($curl_request, CURLOPT_HEADER, 1);\n        curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\n        curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\n        curl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\n        $jsonEncodedData = json_encode($parameters);\n        $post = array(\n             \"method\" => $method,\n             \"input_type\" => \"JSON\",\n             \"response_type\" => \"JSON\",\n             \"rest_data\" => $jsonEncodedData\n        );\n        curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post);\n        $result = curl_exec($curl_request);\n        curl_close($curl_request);\n        $result = explode(\"\\r\\n\\r\\n\", $result, 2);\n        $response = json_decode($result[1]);\n        ob_end_flush();\n        return $response;\n    }\n    //login -----------------------------------------------------", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Creating_Documents/index.html"}
{"id": "0cf03a55563e-1", "text": "return $response;\n    }\n    //login ----------------------------------------------------- \n    $login_parameters = array(\n         \"user_auth\" => array(\n              \"user_name\" => $username,\n              \"password\" => md5($password),\n              \"version\" => \"1\"\n         ),\n         \"application_name\" => \"RestTest\",\n         \"name_value_list\" => array(),\n    );\n    $login_result = call(\"login\", $login_parameters, $url);\n    /*\n    echo \"<pre>\";\n    print_r($login_result);\n    echo \"</pre>\";\n    */\n    //get session id\n    $session_id = $login_result->id;\n    //create document -------------------------------------------- \n    $set_entry_parameters = array(\n        //session id\n        \"session\" => $session_id,\n        //The name of the module\n        \"module_name\" => \"Documents\",\n        //Record attributes\n        \"name_value_list\" => array(\n            //to update a record, pass in a record id as commented below\n            //array(\"name\" => \"id\", \"value\" => \"9b170af9-3080-e22b-fbc1-4fea74def88f\"),\n            array(\"name\" => \"document_name\", \"value\" => \"Example Document\"),\n            array(\"name\" => \"revision\", \"value\" => \"1\"),\n        ),\n    );\n    $set_entry_result = call(\"set_entry\", $set_entry_parameters, $url);\n    echo \"<pre>\";\n    print_r($set_entry_result);\n    echo \"</pre>\";\n    $document_id = $set_entry_result->id;\n    //create document revision ------------------------------------ \n    $contents = file_get_contents (\"/path/to/example_document.txt\");\n    $set_document_revision_parameters = array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Creating_Documents/index.html"}
{"id": "0cf03a55563e-2", "text": "$set_document_revision_parameters = array(\n        //session id\n        \"session\" => $session_id,\n        //The attachment details\n        \"note\" => array(\n            //The ID of the parent document.\n            'id' => $document_id,\n            //The binary contents of the file.\n            'file' => base64_encode($contents),\n            //The name of the file\n            'filename' => 'example_document.txt',\n            //The revision number\n            'revision' => '1',\n        ),\n    );\n    $set_document_revision_result = call(\"set_document_revision\", $set_document_revision_parameters, $url);\n    echo \"<pre>\";\n    print_r($set_document_revision_result);\n    echo \"</pre>\";\n?>\nResult\n//set_entry result\nstdClass Object\n(\n    [id] => b769cf46-7881-a369-314d-50abaa238c62\n    [entry_list] => stdClass Object\n        (\n            [document_name] => stdClass Object\n                (\n                    [name] => document_name\n                    [value] => Example Document\n                )\n            [revision] => stdClass Object\n                (\n                    [name] => revision\n                    [value] => 1\n                )\n        )\n)\n//set_document_revision result\nstdClass Object\n(\n    [id] => e83f97b9-b818-2d04-1aeb-50abaa8303b5\n)\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Creating_Documents/index.html"}
{"id": "9e409287714b-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nRetrieving Records by Email Domain\nOverview\nA PHP example demonstrating how to retrieve email addresses based on an email domain with the search_by_module and get_entries methods using cURL and the v4_1 REST API.\n    \nWhen using the search_by_module method, the email address information is not returned in the result. Due to this behavior, we will gather the record ids and pass them back to the get_entries method to fetch our related email addresses.\nExample \n<?php\n    $url = \"http://{site_url}/service/v4_1/rest.php\";\n    $username = \"admin\";\n    $password = \"password\";\n    //function to make cURL request\n    function call($method, $parameters, $url)\n    {\n        ob_start();\n        $curl_request = curl_init();\n   \n        curl_setopt($curl_request, CURLOPT_URL, $url);\n        curl_setopt($curl_request, CURLOPT_POST, 1);\n        curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\n        curl_setopt($curl_request, CURLOPT_HEADER, 1);\n        curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\n        curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\n        curl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\n   \n        $jsonEncodedData = json_encode($parameters);\n   \n        $post = array(\n            \"method\" => $method,\n            \"input_type\" => \"JSON\",\n            \"response_type\" => \"JSON\",\n            \"rest_data\" => $jsonEncodedData\n        );\n   \n        curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post);\n        $result = curl_exec($curl_request);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Records_by_Email_Domain/index.html"}
{"id": "9e409287714b-1", "text": "$result = curl_exec($curl_request);\n        curl_close($curl_request);\n   \n        $result = explode(\"\\r\\n\\r\\n\", $result, 2);\n        $response = json_decode($result[1]);\n        ob_end_flush();\n   \n        return $response;\n    }\n   \n    //login --------------------------------------------\n   \n    $login_parameters = array(\n        \"user_auth\" => array(\n            \"user_name\" => $username,\n            \"password\" => md5($password),\n            \"version\" => \"1\"\n        ),\n        \"application_name\" => \"RestTest\",\n        \"name_value_list\" => array(),\n    );\n   \n    $login_result = call(\"login\", $login_parameters, $url);\n   \n    /*\n    echo \"<pre>\";\n    print_r($login_result);\n    echo \"</pre>\";\n    */\n   \n    //get session id\n    $session_id = $login_result->id;\n   \n    //search_by_module -------------------------------------------------\n   \n    $search_by_module_parameters = array(\n        \"session\" => $session_id,\n        'search_string' => '%@example.com',\n        'modules' => array(\n            'Accounts',\n            'Contacts',\n            'Leads',\n        ),\n        'offset' => 0,\n        'max_results' => 1,\n        'assigned_user_id' => '',\n        'select_fields' => array('id'),\n        'unified_search_only' => false,\n        'favorites' => false\n    );\n   \n    $search_by_module_results = call('search_by_module', $search_by_module_parameters, $url);\n   \n    /*\n    echo '<pre>';\n    print_r($search_by_module_results);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Records_by_Email_Domain/index.html"}
{"id": "9e409287714b-2", "text": "/*\n    echo '<pre>';\n    print_r($search_by_module_results);\n    echo '</pre>';\n    */\n   \n    $record_ids = array();\n    foreach ($search_by_module_results->entry_list as $results)\n    {\n        $module = $results->name;\n   \n        foreach ($results->records as $records)\n        {\n            foreach($records as $record)\n            {\n                if ($record->name = 'id')\n                {\n                    $record_ids[$module][] = $record->value;\n                    //skip any additional fields\n                    break;\n                }\n            }\n        }\n   \n    }\n   \n    $get_entries_results = array();\n    $modules = array_keys($record_ids);\n   \n    foreach($modules as $module)\n    {\n        $get_entries_parameters = array(\n            //session id\n            'session' => $session_id,\n   \n            //The name of the module from which to retrieve records\n            'module_name' => $module,\n   \n            //An array of record IDs\n            'ids' => $record_ids[$module],\n   \n            //The list of fields to be returned in the results\n            'select_fields' => array(\n                'name',\n            ),\n   \n            //A list of link names and the fields to be returned for each link name\n            'link_name_to_fields_array' => array(\n                array(\n                    'name' => 'email_addresses',\n                    'value' => array(\n                        'email_address',\n                        'opt_out',\n                        'primary_address'\n                    ),\n                ),\n            ),\n   \n            //Flag the record as a recently viewed item\n            'track_view' => false,\n        );", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Records_by_Email_Domain/index.html"}
{"id": "9e409287714b-3", "text": "'track_view' => false,\n        );\n   \n        $get_entries_results[$module] = call('get_entries', $get_entries_parameters, $url);\n    }\n   \n    echo '<pre>';\n    print_r($get_entries_results);\n    echo '</pre>';\nResult \nArray\n(\n    [Accounts] => stdClass Object\n        (\n            [entry_list] => Array\n                (\n                    [0] => stdClass Object\n                        (\n                            [id] => 1bb7ef28-64b9-cbd5-e7d6-5282a3b96953\n                            [module_name] => Accounts\n                            [name_value_list] => stdClass Object\n                                (\n                                    [name] => stdClass Object\n                                        (\n                                            [name] => name\n                                            [value] => Underwater Mining Inc.\n                                        )\n                                )\n                        )\n                    [1] => stdClass Object\n                        (\n                            [id] => efbc0c4e-cc72-f843-b6ed-5282a38dad7f\n                            [module_name] => Accounts\n                            [name_value_list] => stdClass Object\n                                (\n                                    [name] => stdClass Object\n                                        (\n                                            [name] => name\n                                            [value] => 360 Vacations\n                                        )\n                                )\n                        )\n                )\n            [relationship_list] => Array\n                (\n                    [0] => stdClass Object\n                        (\n                            [link_list] => Array\n                                (\n                                    [0] => stdClass Object\n                                        (\n                                            [name] => email_addresses\n                                            [records] => Array\n                                                (\n                                                    [0] => stdClass Object\n                                                        (\n                                                            [link_value] => stdClass Object\n                                                                (\n                                                                    [email_address] => stdClass Object\n                                                                        (\n                                                                            [name] => email_address", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Records_by_Email_Domain/index.html"}
{"id": "9e409287714b-4", "text": "[email_address] => stdClass Object\n                                                                        (\n                                                                            [name] => email_address\n                                                                            [value] => beans.the.qa@example.com\n                                                                        )\n                                                                    [opt_out] => stdClass Object\n                                                                        (\n                                                                            [name] => opt_out\n                                                                            [value] => 0\n                                                                        )\n                                                                    [primary_address] => stdClass Object\n                                                                        (\n                                                                            [name] => primary_address\n                                                                            [value] =>\n                                                                        )\n                                                                )\n                                                        )\n                                                    [1] => stdClass Object\n                                                        (\n                                                            [link_value] => stdClass Object\n                                                                (\n                                                                    [email_address] => stdClass Object\n                                                                        (\n                                                                            [name] => email_address\n                                                                            [value] => section.sales@example.edu\n                                                                        )\n                                                                    [opt_out] => stdClass Object\n                                                                        (\n                                                                            [name] => opt_out\n                                                                            [value] => 0\n                                                                        )\n                                                                    [primary_address] => stdClass Object\n                                                                        (\n                                                                            [name] => primary_address\n                                                                            [value] =>\n                                                                        )\n                                                                )\n                                                        )\n                                                )\n                                        )\n                                )\n                        )\n                    [1] => stdClass Object\n                        (\n                            [link_list] => Array\n                                (\n                                    [0] => stdClass Object\n                                        (\n                                            [name] => email_addresses\n                                            [records] => Array\n                                                (\n                                                    [0] => stdClass Object\n                                                        (\n                                                            [link_value] => stdClass Object\n                                                                (\n                                                                    [email_address] => stdClass Object\n                                                                        (\n                                                                            [name] => email_address\n                                                                            [value] => section51@example.com\n                                                                        )\n                                                                    [opt_out] => stdClass Object\n                                                                        (\n                                                                            [name] => opt_out\n                                                                            [value] => 0\n                                                                        )\n                                                                    [primary_address] => stdClass Object\n                                                                        (\n                                                                            [name] => primary_address\n                                                                            [value] =>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Records_by_Email_Domain/index.html"}
{"id": "9e409287714b-5", "text": "(\n                                                                            [name] => primary_address\n                                                                            [value] =>\n                                                                        )\n                                                                )\n                                                        )\n                                                    [1] => stdClass Object\n                                                        (\n                                                            [link_value] => stdClass Object\n                                                                (\n                                                                    [email_address] => stdClass Object\n                                                                        (\n                                                                            [name] => email_address\n                                                                            [value] => kid.sugar.qa@example.co.uk\n                                                                        )\n                                                                    [opt_out] => stdClass Object\n                                                                        (\n                                                                            [name] => opt_out\n                                                                            [value] => 0\n                                                                        )\n                                                                    [primary_address] => stdClass Object\n                                                                        (\n                                                                            [name] => primary_address\n                                                                            [value] =>\n                                                                        )\n                                                                )\n                                                        )\n                                                )\n                                        )\n                                )\n                        )\n                )\n        )\n    [Contacts] => stdClass Object\n        (\n            [entry_list] => Array\n                (\n                    [0] => stdClass Object\n                        (\n                            [id] => 24330979-0e39-f9ec-2622-5282a372f39b\n                            [module_name] => Contacts\n                            [name_value_list] => stdClass Object\n                                (\n                                    [name] => stdClass Object\n                                        (\n                                            [name] => name\n                                            [value] => Errol Goldberg\n                                        )\n                                )\n                        )\n                    [1] => stdClass Object\n                        (\n                            [id] => 2542dad2-85f3-5529-3a30-5282a3104e31\n                            [module_name] => Contacts\n                            [name_value_list] => stdClass Object\n                                (\n                                    [name] => stdClass Object\n                                        (\n                                            [name] => name\n                                            [value] => Luis Deegan\n                                        )\n                                )\n                        )\n                )\n            [relationship_list] => Array\n                (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Records_by_Email_Domain/index.html"}
{"id": "9e409287714b-6", "text": ")\n                        )\n                )\n            [relationship_list] => Array\n                (\n                    [0] => stdClass Object\n                        (\n                            [link_list] => Array\n                                (\n                                    [0] => stdClass Object\n                                        (\n                                            [name] => email_addresses\n                                            [records] => Array\n                                                (\n                                                    [0] => stdClass Object\n                                                        (\n                                                            [link_value] => stdClass Object\n                                                                (\n                                                                    [email_address] => stdClass Object\n                                                                        (\n                                                                            [name] => email_address\n                                                                            [value] => hr.phone@example.com\n                                                                        )\n                                                                    [opt_out] => stdClass Object\n                                                                        (\n                                                                            [name] => opt_out\n                                                                            [value] => 0\n                                                                        )\n                                                                    [primary_address] => stdClass Object\n                                                                        (\n                                                                            [name] => primary_address\n                                                                            [value] =>\n                                                                        )\n                                                                )\n                                                        )\n                                                    [1] => stdClass Object\n                                                        (\n                                                            [link_value] => stdClass Object\n                                                                (\n                                                                    [email_address] => stdClass Object\n                                                                        (\n                                                                            [name] => email_address\n                                                                            [value] => the.info.phone@example.cn\n                                                                        )\n                                                                    [opt_out] => stdClass Object\n                                                                        (\n                                                                            [name] => opt_out\n                                                                            [value] => 1\n                                                                        )\n                                                                    [primary_address] => stdClass Object\n                                                                        (\n                                                                            [name] => primary_address\n                                                                            [value] =>\n                                                                        )\n                                                                )\n                                                        )\n                                                )\n                                        )\n                                )\n                        )\n                    [1] => stdClass Object\n                        (\n                            [link_list] => Array\n                                (\n                                    [0] => stdClass Object\n                                        (\n                                            [name] => email_addresses\n                                            [records] => Array\n                                                (\n                                                    [0] => stdClass Object\n                                                        (\n                                                            [link_value] => stdClass Object", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Records_by_Email_Domain/index.html"}
{"id": "9e409287714b-7", "text": "[0] => stdClass Object\n                                                        (\n                                                            [link_value] => stdClass Object\n                                                                (\n                                                                    [email_address] => stdClass Object\n                                                                        (\n                                                                            [name] => email_address\n                                                                            [value] => im.the.sales@example.name\n                                                                        )\n                                                                    [opt_out] => stdClass Object\n                                                                        (\n                                                                            [name] => opt_out\n                                                                            [value] => 0\n                                                                        )\n                                                                    [primary_address] => stdClass Object\n                                                                        (\n                                                                            [name] => primary_address\n                                                                            [value] =>\n                                                                        )\n                                                                )\n                                                        )\n                                                    [1] => stdClass Object\n                                                        (\n                                                            [link_value] => stdClass Object\n                                                                (\n                                                                    [email_address] => stdClass Object\n                                                                        (\n                                                                            [name] => email_address\n                                                                            [value] => the36@example.com\n                                                                        )\n                                                                    [opt_out] => stdClass Object\n                                                                        (\n                                                                            [name] => opt_out\n                                                                            [value] => 1\n                                                                        )\n                                                                    [primary_address] => stdClass Object\n                                                                        (\n                                                                            [name] => primary_address\n                                                                            [value] =>\n                                                                        )\n                                                                )\n                                                        )\n                                                )\n                                        )\n                                )\n                        )\n                )\n        )\n    [Leads] => stdClass Object\n        (\n            [entry_list] => Array\n                (\n                    [0] => stdClass Object\n                        (\n                            [id] => 83abeeff-5e71-0f06-2e5f-5282a3f04f41\n                            [module_name] => Leads\n                            [name_value_list] => stdClass Object\n                                (\n                                    [name] => stdClass Object\n                                        (\n                                            [name] => name\n                                            [value] => Caryn Wert\n                                        )\n                                )\n                        )\n                    [1] => stdClass Object\n                        (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Records_by_Email_Domain/index.html"}
{"id": "9e409287714b-8", "text": ")\n                                )\n                        )\n                    [1] => stdClass Object\n                        (\n                            [id] => 2a3b304b-5167-8432-d4e7-5282a300eabb\n                            [module_name] => Leads\n                            [name_value_list] => stdClass Object\n                                (\n                                    [name] => stdClass Object\n                                        (\n                                            [name] => name\n                                            [value] => Marco Castonguay\n                                        )\n                                )\n                        )\n                )\n            [relationship_list] => Array\n                (\n                    [0] => stdClass Object\n                        (\n                            [link_list] => Array\n                                (\n                                    [0] => stdClass Object\n                                        (\n                                            [name] => email_addresses\n                                            [records] => Array\n                                                (\n                                                    [0] => stdClass Object\n                                                        (\n                                                            [link_value] => stdClass Object\n                                                                (\n                                                                    [email_address] => stdClass Object\n                                                                        (\n                                                                            [name] => email_address\n                                                                            [value] => hr60@example.com\n                                                                        )\n                                                                    [opt_out] => stdClass Object\n                                                                        (\n                                                                            [name] => opt_out\n                                                                            [value] => 0\n                                                                        )\n                                                                    [primary_address] => stdClass Object\n                                                                        (\n                                                                            [name] => primary_address\n                                                                            [value] =>\n                                                                        )\n                                                                )\n                                                        )\n                                                )\n                                        )\n                                )\n                        )\n                    [1] => stdClass Object\n                        (\n                            [link_list] => Array\n                                (\n                                    [0] => stdClass Object\n                                        (\n                                            [name] => email_addresses\n                                            [records] => Array\n                                                (\n                                                    [0] => stdClass Object\n                                                        (\n                                                            [link_value] => stdClass Object\n                                                                (\n                                                                    [email_address] => stdClass Object\n                                                                        (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Records_by_Email_Domain/index.html"}
{"id": "9e409287714b-9", "text": "(\n                                                                    [email_address] => stdClass Object\n                                                                        (\n                                                                            [name] => email_address\n                                                                            [value] => im.the@example.com\n                                                                        )\n                                                                    [opt_out] => stdClass Object\n                                                                        (\n                                                                            [name] => opt_out\n                                                                            [value] => 0\n                                                                        )\n                                                                    [primary_address] => stdClass Object\n                                                                        (\n                                                                            [name] => primary_address\n                                                                            [value] =>\n                                                                        )\n                                                                )\n                                                        )\n                                                )\n                                        )\n                                )\n                        )\n                )\n        )\n)\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Records_by_Email_Domain/index.html"}
{"id": "2a13cf8254a7-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nRetrieving Multiple Records by ID\nOverview\nA PHP example demonstrating how to retrieve multiple records from the accounts module with the get_entries method using cURL and the v4_1 REST API.\nThis example will only retrieve 2 records and return the following fields: 'name', 'billing_address_state' and 'billing_address_country'.\nExample\n<?php\n    $url = \"http://{site_url}/service/v4_1/rest.php\";\n    $username = \"admin\";\n    $password = \"password\";\n    //function to make cURL request\n    function call($method, $parameters, $url)\n    {\n        ob_start();\n        $curl_request = curl_init();\n        curl_setopt($curl_request, CURLOPT_URL, $url);\n        curl_setopt($curl_request, CURLOPT_POST, 1);\n        curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\n        curl_setopt($curl_request, CURLOPT_HEADER, 1);\n        curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\n        curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\n        curl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\n        $jsonEncodedData = json_encode($parameters);\n        $post = array(\n             \"method\" => $method,\n             \"input_type\" => \"JSON\",\n             \"response_type\" => \"JSON\",\n             \"rest_data\" => $jsonEncodedData\n        );\n        curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post);\n        $result = curl_exec($curl_request);\n        curl_close($curl_request);\n        $result = explode(\"\\r\\n\\r\\n\", $result, 2);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Multiple_Records_by_ID/index.html"}
{"id": "2a13cf8254a7-1", "text": "$result = explode(\"\\r\\n\\r\\n\", $result, 2);\n        $response = json_decode($result[1]);\n        ob_end_flush();\n        return $response;\n    }\n    //login --------------------------------------------- \n    $login_parameters = array(\n         \"user_auth\" => array(\n              \"user_name\" => $username,\n              \"password\" => md5($password),\n              \"version\" => \"1\"\n         ),\n         \"application_name\" => \"RestTest\",\n         \"name_value_list\" => array(),\n    );\n    $login_result = call(\"login\", $login_parameters, $url);\n    /*\n    echo \"<pre>\";\n    print_r($login_result);\n    echo \"</pre>\";\n    */\n    //get session id\n    $session_id = $login_result->id;\n    //retrieve records ----------------------------------- \n    $get_entries_parameters = array(\n         //session id\n         'session' => $session_id,\n         //The name of the module from which to retrieve records\n         'module_name' => 'Accounts',\n         //An array of SugarBean IDs\n         'ids' => array(\n             '20328809-9d0a-56fc-0e7c-4f7cb6eb1c83',\n             '328b22a6-d784-66d9-0295-4f7cb59e8cbb',\n         ),\n         //Optional. The list of fields to be returned in the results\n         'select_fields' => array(\n            'name',\n            'billing_address_state',\n            'billing_address_country'\n         ),\n         //A list of link names and the fields to be returned for each link name\n         'link_name_to_fields_array' => array(\n         ),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Multiple_Records_by_ID/index.html"}
{"id": "2a13cf8254a7-2", "text": "'link_name_to_fields_array' => array(\n         ),\n    );\n    $get_entries_result = call(\"get_entries\", $get_entries_parameters, $url);\n    echo \"<pre>\";\n    print_r($get_entries_result);\n    echo \"</pre>\";\n?>\nResult\nstdClass Object\n(\n    [entry_list] => Array\n        (\n            [0] => stdClass Object\n                (\n                    [id] => 20328809-9d0a-56fc-0e7c-4f7cb6eb1c83\n                    [module_name] => Accounts\n                    [name_value_list] => stdClass Object\n                        (\n                            [name] => stdClass Object\n                                (\n                                    [name] => name\n                                    [value] => Jungle Systems Inc\n                                )\n                            [billing_address_state] => stdClass Object\n                                (\n                                    [name] => billing_address_state\n                                    [value] => NY\n                                )\n                            [billing_address_country] => stdClass Object\n                                (\n                                    [name] => billing_address_country\n                                    [value] => USA\n                                )\n                        )\n                )\n            [1] => stdClass Object\n                (\n                    [id] => 328b22a6-d784-66d9-0295-4f7cb59e8cbb\n                    [module_name] => Accounts\n                    [name_value_list] => stdClass Object\n                        (\n                            [name] => stdClass Object\n                                (\n                                    [name] => name\n                                    [value] => Riviera Hotels\n                                )\n                            [billing_address_state] => stdClass Object\n                                (\n                                    [name] => billing_address_state\n                                    [value] => CA\n                                )\n                            [billing_address_country] => stdClass Object\n                                (\n                                    [name] => billing_address_country\n                                    [value] => USA", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Multiple_Records_by_ID/index.html"}
{"id": "2a13cf8254a7-3", "text": "(\n                                    [name] => billing_address_country\n                                    [value] => USA\n                                )\n                        )\n                )\n        )\n    [relationship_list] => Array\n        (\n        )\n)\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Multiple_Records_by_ID/index.html"}
{"id": "e53873ca382a-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nRelating Quotes and Products\nOverview\nA PHP example demonstrating how to create and relate Products to Quotes using cURL and the v4_1 REST API.\nExample\n<?php\n    $url = \"http://{site_url}/service/v4_1/rest.php\";\n    $username = \"admin\";\n    $password = \"password\";\n    //function to make cURL request\n    function call($method, $parameters, $url)\n    {\n        ob_start();\n        $curl_request = curl_init();\n        curl_setopt($curl_request, CURLOPT_URL, $url);\n        curl_setopt($curl_request, CURLOPT_POST, 1);\n        curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\n        curl_setopt($curl_request, CURLOPT_HEADER, 1);\n        curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\n        curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\n        curl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\n        $jsonEncodedData = json_encode($parameters);\n        $post = array(\n            \"method\" => $method,\n            \"input_type\" => \"JSON\",\n            \"response_type\" => \"JSON\",\n            \"rest_data\" => $jsonEncodedData\n        );\n        curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post);\n        $result = curl_exec($curl_request);\n        curl_close($curl_request);\n        $result = explode(\"\\r\\n\\r\\n\", $result, 2);\n        $response = json_decode($result[1]);\n        ob_end_flush();\n        return $response;\n    }\n    //login ---------------------------------------------- \n    $login_parameters = array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Relating_Quotes_and_Products/index.html"}
{"id": "e53873ca382a-1", "text": "}\n    //login ---------------------------------------------- \n    $login_parameters = array(\n        \"user_auth\" => array(\n            \"user_name\" => $username,\n            \"password\" => md5($password),\n            \"version\" => \"1\"\n        ),\n        \"application_name\" => \"RestTest\",\n        \"name_value_list\" => array(),\n    );\n    $login_result = call(\"login\", $login_parameters, $url);\n    /*\n    echo \"<pre>\";\n    print_r($login_result);\n    echo \"</pre>\";\n    */\n    //get session id\n    $session_id = $login_result->id;\n    //create quote ---------------------------------------------- \n    $createQuoteParams = array(\n        'session' => $session_id,\n        'module_name' => 'Quotes',\n        'name_value_list' => array(\n            array(\n                'name' => 'name',\n                'value' => 'Widget Quote'\n            ),\n            array(\n                'name' => 'team_count',\n                'value' => ''\n            ),\n            array(\n                'name' => 'team_name',\n                'value' => ''\n            ),\n            array(\n                'name' => 'date_quote_expected_closed',\n                'value' => date('Y-m-d', mktime(0, 0, 0, date('m')  , date('d')+7, date('Y')))\n            ),\n            array(\n                'name' => 'quote_stage',\n                'value' => 'Negotiation'\n            ),\n            array(\n                'name' => 'quote_num',\n                'value' => ''\n            ),\n            array(\n                'name' => 'quote_type',\n                'value' => 'Quotes'", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Relating_Quotes_and_Products/index.html"}
{"id": "e53873ca382a-2", "text": "'name' => 'quote_type',\n                'value' => 'Quotes'\n            ),\n            array(\n                'name' => 'subtotal',\n                'value' => '1230.23'\n            ),\n            array(\n                'name' => 'subtotal_usdollar',\n                'value' => '1230.23'\n            ),\n        ),\n    );\n    $createQuoteResult = call('set_entry', $createQuoteParams, $url);\n    echo \"Create Quote Result<br />\";\n    echo \"<pre>\";\n    print_r($createQuoteResult);\n    echo \"</pre>\";\n    //create product ---------------------------------------------- \n    $createProductParams = array(\n        'session' => $session_id,\n        'module_name' => 'Products',\n        'name_value_list' => array(\n            array(\n                'name' => 'name',\n                'value' => 'Widget'\n            ),\n            array(\n                'name' => 'quote_id',\n                'value' => $createQuoteResult->id\n            ),\n            array(\n                'name' => 'status',\n                'value' => 'Quotes'\n            )\n        )\n    );\n    $createProductResult = call('set_entry', $createProductParams, $url);\n    echo \"Create Product Result<br />\";\n    echo \"<pre>\";\n    print_r($createProductResult);\n    echo \"</pre>\";\n    //create product-bundle ---------------------------------------------- \n    $createProductBundleParams = array(\n        \"session\"         => $session_id,\n        \"module_name\"     => \"ProductBundles\",\n        \"name_value_list\" => array(\n            array(\n                'name' => 'name',\n                'value' => 'Rest SugarOnline Order'),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Relating_Quotes_and_Products/index.html"}
{"id": "e53873ca382a-3", "text": "'value' => 'Rest SugarOnline Order'),\n            array(\n                'name' => 'bundle_stage',\n                'value' => 'Draft'\n            ),\n            array(\n                'name' => 'tax',\n                'value' => '0.00'\n            ),\n            array(\n                'name' => 'total',\n                'value' => '0.00'\n            ),\n            array(\n                'name' => 'subtotal',\n                'value' => '0.00'\n            ),\n            array(\n                'name' => 'shippint',\n                'value' => '0.00'\n            ),\n            array(\n                'name' => 'currency_id',\n                'value' => '-99'\n            ),\n        )\n    );\n    $createProductBundleResult = call('set_entry', $createProductBundleParams, $url);\n    echo \"Create ProductBundles Result<br />\";\n    echo \"<pre>\";\n    print_r($createProductBundleResult);\n    echo \"</pre>\";\n    //relate product to product-bundle ---------------------------------------- \n    $relationshipProductBundleProductsParams = array(\n        'sesssion' => $session_id,\n        'module_name' => 'ProductBundles',\n        'module_id' => $createProductBundleResult->id,\n        'link_field_name' => 'products',\n        'related_ids' => array(\n            $createProductResult->id\n        ),\n    );\n    // set the product bundles products relationship\n    $relationshipProductBundleProductResult = call('set_relationship', $relationshipProductBundleProductsParams, $url);\n    echo \"Create ProductBundleProduct Relationship Result<br />\";\n    echo \"<pre>\";\n    print_r($relationshipProductBundleProductResult);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Relating_Quotes_and_Products/index.html"}
{"id": "e53873ca382a-4", "text": "echo \"<pre>\";\n    print_r($relationshipProductBundleProductResult);\n    echo \"</pre>\";\n    //relate product-bundle to quote ---------------------------------------- \n    $relationshipProductBundleQuoteParams = array(\n        'sesssion' => $session_id,\n        'module_name' => 'Quotes',\n        'module_id' => $createQuoteResult->id,\n        'link_field_name' => 'product_bundles',\n        'related_ids' => array(\n            $createProductBundleResult->id\n        ),\n        'name_value_list' => array()\n    );\n    // set the product bundles quotes relationship\n    $relationshipProductBundleQuoteResult = call('set_relationship', $relationshipProductBundleQuoteParams, $url);\n    echo \"Create ProductBundleQuote Relationship Result<br />\";\n    echo \"<pre>\";\n    print_r($relationshipProductBundleQuoteResult);\n    echo \"</pre>\";\nResult\n//Create Quote Result\nstdClass Object\n(\n    [id] => 2e0cd18b-21da-50f0-10f6-517e835a1e09\n    [entry_list] => stdClass Object\n        (\n            [name] => stdClass Object\n                (\n                    [name] => name\n                    [value] => Widget Quote\n                )\n            [team_count] => stdClass Object\n                (\n                    [name] => team_count\n                    [value] =>\n                )\n            [team_name] => stdClass Object\n                (\n                    [name] => team_name\n                    [value] =>\n                )\n            [date_quote_expected_closed] => stdClass Object\n                (\n                    [name] => date_quote_expected_closed\n                    [value] => 2013-05-06\n                )\n            [quote_stage] => stdClass Object\n                (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Relating_Quotes_and_Products/index.html"}
{"id": "e53873ca382a-5", "text": ")\n            [quote_stage] => stdClass Object\n                (\n                    [name] => quote_stage\n                    [value] => Negotiation\n                )\n            [quote_num] => stdClass Object\n                (\n                    [name] => quote_num\n                    [value] =>\n                )\n            [quote_type] => stdClass Object\n                (\n                    [name] => quote_type\n                    [value] => Quotes\n                )\n            [subtotal] => stdClass Object\n                (\n                    [name] => subtotal\n                    [value] => 1230.23\n                )\n            [subtotal_usdollar] => stdClass Object\n                (\n                    [name] => subtotal_usdollar\n                    [value] => 1230.23\n                )\n        )\n)\n//Create Product Result\nstdClass Object\n(\n    [id] => 6c40f344-a269-d4d0-9929-517e83884fb2\n    [entry_list] => stdClass Object\n        (\n            [name] => stdClass Object\n                (\n                    [name] => name\n                    [value] => Widget\n                )\n            [quote_id] => stdClass Object\n                (\n                    [name] => quote_id\n                    [value] => 2e0cd18b-21da-50f0-10f6-517e835a1e09\n                )\n            [status] => stdClass Object\n                (\n                    [name] => status\n                    [value] => Quotes\n                )\n        )\n)\n//Create ProductBundles Result\nstdClass Object\n(\n    [id] => a8a4e449-7e72-dea5-9495-517e830a7353\n    [entry_list] => stdClass Object\n        (\n            [name] => stdClass Object\n                (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Relating_Quotes_and_Products/index.html"}
{"id": "e53873ca382a-6", "text": "(\n            [name] => stdClass Object\n                (\n                    [name] => name\n                    [value] => Rest SugarOnline Order\n                )\n            [bundle_stage] => stdClass Object\n                (\n                    [name] => bundle_stage\n                    [value] => Draft\n                )\n            [tax] => stdClass Object\n                (\n                    [name] => tax\n                    [value] => 0\n                )\n            [total] => stdClass Object\n                (\n                    [name] => total\n                    [value] => 0\n                )\n            [subtotal] => stdClass Object\n                (\n                    [name] => subtotal\n                    [value] => 0\n                )\n            [currency_id] => stdClass Object\n                (\n                    [name] => currency_id\n                    [value] => -99\n                )\n        )\n)\n//Create ProductBundleProduct Relationship Result\nstdClass Object\n(\n    [created] => 1\n    [failed] => 0\n    [deleted] => 0\n)\n//Create ProductBundleQuote Relationship Result\nstdClass Object\n(\n    [created] => 1\n    [failed] => 0\n    [deleted] => 0\n)\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Relating_Quotes_and_Products/index.html"}
{"id": "077918f078ce-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nCreating or Updating Multiple Records\nOverview\nA PHP example demonstrating how to create or update multiple contacts with the set_entries method using cURL and the v4_1 REST API.\nExample\n<?php\n    $url = \"http://{site_url}/service/v4_1/rest.php\";\n    $username = \"admin\";\n    $password = \"password\";\n    //function to make cURL request\n    function call($method, $parameters, $url)\n    {\n        ob_start();\n        $curl_request = curl_init();\n        curl_setopt($curl_request, CURLOPT_URL, $url);\n        curl_setopt($curl_request, CURLOPT_POST, 1);\n        curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\n        curl_setopt($curl_request, CURLOPT_HEADER, 1);\n        curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\n        curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\n        curl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\n        $jsonEncodedData = json_encode($parameters);\n        $post = array(\n             \"method\" => $method,\n             \"input_type\" => \"JSON\",\n             \"response_type\" => \"JSON\",\n             \"rest_data\" => $jsonEncodedData\n        );\n        curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post);\n        $result = curl_exec($curl_request);\n        curl_close($curl_request);\n        $result = explode(\"\\r\\n\\r\\n\", $result, 2);\n        $response = json_decode($result[1]);\n        ob_end_flush();\n        return $response;\n    }\n    //login -------------------------------------------- \n    $login_parameters = array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Creating_or_Updating_Multiple_Records/index.html"}
{"id": "077918f078ce-1", "text": "}\n    //login -------------------------------------------- \n    $login_parameters = array(\n         \"user_auth\" => array(\n              \"user_name\" => $username,\n              \"password\" => md5($password),\n              \"version\" => \"1\"\n         ),\n         \"application_name\" => \"RestTest\",\n         \"name_value_list\" => array(),\n    );\n    $login_result = call(\"login\", $login_parameters, $url);\n    /*\n    echo \"<pre>\";\n    print_r($login_result);\n    echo \"</pre>\";\n    */\n    //get session id\n    $session_id = $login_result->id;\n    //create contacts ------------------------------------ \n    $set_entries_parameters = array(\n         //session id\n         \"session\" => $session_id,\n         //The name of the module from which to retrieve records.\n         \"module_name\" => \"Contacts\",\n         //Record attributes\n         \"name_value_list\" => array(\n             array(\n                //to update a record, you will nee to pass in a record id as commented below\n                //array(\"name\" => \"id\", \"value\" => \"912e58c0-73e9-9cb6-c84e-4ff34d62620e\"),\n                array(\"name\" => \"first_name\", \"value\" => \"John\"),\n                array(\"name\" => \"last_name\", \"value\" => \"Smith\"),\n             ),\n             array(\n                //to update a record, you will nee to pass in a record id as commented below\n                //array(\"name\" => \"id\", \"value\" => \"99d6ddfd-7d52-d45b-eba8-4ff34d684964\"),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Creating_or_Updating_Multiple_Records/index.html"}
{"id": "077918f078ce-2", "text": "array(\"name\" => \"first_name\", \"value\" => \"Jane\"),\n                array(\"name\" => \"last_name\", \"value\" => \"Doe\"),\n             ),\n         ),\n    );\n    $set_entries_result = call(\"set_entries\", $set_entries_parameters, $url);\n    echo \"<pre>\";\n    print_r($set_entries_result);\n    echo \"</pre>\";\n?>\nResult\nstdClass Object\n(\n    [ids] => Array\n        (\n            [0] => 912e58c0-73e9-9cb6-c84e-4ff34d62620e\n            [1] => 99d6ddfd-7d52-d45b-eba8-4ff34d684964\n        )\n)\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Creating_or_Updating_Multiple_Records/index.html"}
{"id": "3512510b0cd9-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nLogging In\nOverview\nA PHP example demonstrating how to log in and retrieve a session key using cURL and the v4_1 REST API.\nStandard Authentication Example\n<?php\n    $url = \"http://{site_url}/service/v4_1/rest.php\";\n    $username = \"admin\";\n    $password = \"password\";\n    //function to make cURL request\n    function call($method, $parameters, $url)\n    {\n        ob_start();\n        $curl_request = curl_init();\n        curl_setopt($curl_request, CURLOPT_URL, $url);\n        curl_setopt($curl_request, CURLOPT_POST, 1);\n        curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\n        curl_setopt($curl_request, CURLOPT_HEADER, 1);\n        curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\n        curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\n        curl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\n        $jsonEncodedData = json_encode($parameters);\n        $post = array(\n             \"method\" => $method,\n             \"input_type\" => \"JSON\",\n             \"response_type\" => \"JSON\",\n             \"rest_data\" => $jsonEncodedData\n        );\n        curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post);\n        $result = curl_exec($curl_request);\n        curl_close($curl_request);\n        $result = explode(\"\\r\\n\\r\\n\", $result, 2);\n        $response = json_decode($result[1]);\n        ob_end_flush();\n        return $response;\n    }\n    //login ------------------------------ \n    $login_parameters = array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Logging_In/index.html"}
{"id": "3512510b0cd9-1", "text": "}\n    //login ------------------------------ \n    $login_parameters = array(\n         \"user_auth\" => array(\n              \"user_name\" => $username,\n              \"password\" => md5($password),\n              \"version\" => \"1\"\n         ),\n         \"application_name\" => \"RestTest\",\n         \"name_value_list\" => array(),\n    );\n    $login_result = call(\"login\", $login_parameters, $url);\n    echo \"<pre>\";\n    print_r($login_result);\n    echo \"</pre>\";\n    //get session id\n    $session_id = $login_result->id;\n?>\nLDAP Authentication Example\n<?php\n    $url = \"http://{site_url}/service/v4_1/rest.php\";\n    $username = \"admin\";\n    $password = \"password\";\n    $ldap_enc_key = 'LDAP_ENCRYPTION_KEY';\n    //function to make cURL request\n    function call($method, $parameters, $url)\n    {\n        ob_start();\n        $curl_request = curl_init();\n        curl_setopt($curl_request, CURLOPT_URL, $url);\n        curl_setopt($curl_request, CURLOPT_POST, 1);\n        curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\n        curl_setopt($curl_request, CURLOPT_HEADER, 1);\n        curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\n        curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\n        curl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\n        $jsonEncodedData = json_encode($parameters);\n        $post = array(\n             \"method\" => $method,\n             \"input_type\" => \"JSON\",\n             \"response_type\" => \"JSON\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Logging_In/index.html"}
{"id": "3512510b0cd9-2", "text": "\"input_type\" => \"JSON\",\n             \"response_type\" => \"JSON\",\n             \"rest_data\" => $jsonEncodedData\n        );\n        curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post);\n        $result = curl_exec($curl_request);\n        curl_close($curl_request);\n        $result = explode(\"\\r\\n\\r\\n\", $result, 2);\n        $response = json_decode($result[1]);\n        ob_end_flush();\n        return $response;\n    }\n    //login ---------------------------------\n    $ldap_enc_key = substr(md5($ldap_enc_key), 0, 24);\n    $login_parameters = array(\n         \"user_auth\" => array(\n              \"user_name\" => $username,\n              \"password\" => bin2hex(mcrypt_encrypt(MCRYPT_3DES, $ldap_enc_key, $password, MCRYPT_MODE_CBC, \"password\")),\n              \"version\" => \"1\"\n         ),\n         \"application_name\" => \"RestTest\",\n         \"name_value_list\" => array(),\n    );\n    /* \n        The mcrypt extension is deprecated as of PHP 7.1. \n        If on 7.1+, LDAP passwords will need to be sent unencrypted, with\n        $login_parameters[\"user_auth\"][\"encryption\"] set to \"PLAIN\".        An example is below:\n        $login_parameters = array(\n            \"user_auth\" => array(\n                \"user_name\" => $username,\n                \"password\" => $password,\n                \"version\" => \"1\",\n                \"encryption\" => \"PLAIN\"\n            ),\n            \"application_name\" => \"RestTest\",\n            \"name_value_list\" => array(),\n        );\n    */\n    $login_result = call(\"login\", $login_parameters, $url);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Logging_In/index.html"}
{"id": "3512510b0cd9-3", "text": "*/\n    $login_result = call(\"login\", $login_parameters, $url);\n    echo \"<pre>\";\n    print_r($login_result);\n    echo \"</pre>\";\n    //get session id\n    $session_id = $login_result->id;\n?>\nResult\nstdClass Object\n(\n    [id] => lb7479svj8pjtf57ipmshepo80\n    [module_name] => Users\n    [name_value_list] => stdClass Object\n        (\n            [user_id] => stdClass Object\n                (\n                    [name] => user_id\n                    [value] => 1\n                )\n            [user_name] => stdClass Object\n                (\n                    [name] => user_name\n                    [value] => admin\n                )\n            [user_language] => stdClass Object\n                (\n                    [name] => user_language\n                    [value] => en_us\n                )\n            [user_currency_id] => stdClass Object\n                (\n                    [name] => user_currency_id\n                    [value] => -99\n                )\n            [user_is_admin] => stdClass Object\n                (\n                    [name] => user_is_admin\n                    [value] => 1\n                )\n            [user_default_team_id] => stdClass Object\n                (\n                    [name] => user_default_team_id\n                    [value] => 1\n                )\n            [user_default_dateformat] => stdClass Object\n                (\n                    [name] => user_default_dateformat\n                    [value] => m/d/Y\n                )\n            [user_default_timeformat] => stdClass Object\n                (\n                    [name] => user_default_timeformat\n                    [value] => h:ia\n                )\n            [user_number_seperator] => stdClass Object\n                (\n                    [name] => user_number_seperator", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Logging_In/index.html"}
{"id": "3512510b0cd9-4", "text": "(\n                    [name] => user_number_seperator\n                    [value] => ,\n                )\n            [user_decimal_seperator] => stdClass Object\n                (\n                    [name] => user_decimal_seperator\n                    [value] => .\n                )\n            [mobile_max_list_entries] => stdClass Object\n                (\n                    [name] => mobile_max_list_entries\n                    [value] => 10\n                )\n            [mobile_max_subpanel_entries] => stdClass Object\n                (\n                    [name] => mobile_max_subpanel_entries\n                    [value] => 3\n                )\n            [user_currency_name] => stdClass Object\n                (\n                    [name] => user_currency_name\n                    [value] => US Dollars\n                )\n        )\n)\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Logging_In/index.html"}
{"id": "9e3bf36e16d2-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nRetrieving a List of Records With Related Info\nOverview\nA PHP example demonstrating how to retrieve a list of records with info from a related entity with the get_entry_list method using cURL and the v4_1 REST API.\nThis example will retrieve a list of contacts and their related email addresses.\nExample\n<?php\n    $url = \"http://{site_url}/service/v4_1/rest.php\";\n    $username = \"admin\";\n    $password = \"password\";\n    //function to make cURL request\n    function call($method, $parameters, $url)\n    {\n        ob_start();\n        $curl_request = curl_init();\n        curl_setopt($curl_request, CURLOPT_URL, $url);\n        curl_setopt($curl_request, CURLOPT_POST, 1);\n        curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\n        curl_setopt($curl_request, CURLOPT_HEADER, 1);\n        curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\n        curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\n        curl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\n        $jsonEncodedData = json_encode($parameters);\n        $post = array(\n             \"method\" => $method,\n             \"input_type\" => \"JSON\",\n             \"response_type\" => \"JSON\",\n             \"rest_data\" => $jsonEncodedData\n        );\n        curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post);\n        $result = curl_exec($curl_request);\n        curl_close($curl_request);\n        $result = explode(\"\\r\\n\\r\\n\", $result, 2);\n        $response = json_decode($result[1]);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_a_List_of_Records_With_Related_Info/index.html"}
{"id": "9e3bf36e16d2-1", "text": "$response = json_decode($result[1]);\n        ob_end_flush();\n        return $response;\n    }\n    //login ---------------------------------------------- \n    $login_parameters = array(\n         \"user_auth\" => array(\n              \"user_name\" => $username,\n              \"password\" => md5($password),\n              \"version\" => \"1\"\n         ),\n         \"application_name\" => \"RestTest\",\n         \"name_value_list\" => array(),\n    );\n    $login_result = call(\"login\", $login_parameters, $url);\n    /*\n    echo \"<pre>\";\n    print_r($login_result);\n    echo \"</pre>\";\n    */\n    //get session id\n    $session_id = $login_result->id;\n    //retrieve records ------------------------------------- \n    $get_entry_list_parameters = array(\n         //session id\n         'session' => $session_id,\n         //The name of the module from which to retrieve records\n         'module_name' => \"Contacts\",\n         //The SQL WHERE clause without the word \"where\".\n         'query' => \"\",\n         //The SQL ORDER BY clause without the phrase \"order by\".\n         'order_by' => \"\",\n         //The record offset from which to start.\n         'offset' => \"0\",\n         //Optional. The list of fields to be returned in the results\n         'select_fields' => array(\n              'id',\n              'first_name',\n              'last_name',\n         ),\n         //A list of link names and the fields to be returned for each link name\n         'link_name_to_fields_array' => array(\n              array(\n                   'name' => 'email_addresses',\n                   'value' => array(\n                        'id',\n                        'email_address',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_a_List_of_Records_With_Related_Info/index.html"}
{"id": "9e3bf36e16d2-2", "text": "'value' => array(\n                        'id',\n                        'email_address',\n                        'opt_out',\n                        'primary_address'\n                   ),\n              ),\n         ),\n         //The maximum number of results to return.\n         'max_results' => '2',\n         //To exclude deleted records\n         'deleted' => 0,\n         //If only records marked as favorites should be returned.\n         'Favorites' => false,\n    );\n    $get_entry_list_result = call(\"get_entry_list\", $get_entry_list_parameters, $url);\n    echo \"<pre>\";\n    print_r($get_entry_list_result);\n    echo \"</pre>\";\n?>\nResult\nstdClass Object\n(\n    [result_count] => 2\n    [total_count] => 200\n    [next_offset] => 2\n    [entry_list] => Array\n        (\n            [0] => stdClass Object\n                (\n                    [id] => 116d9bc6-4a24-b826-952e-4f7cb6b25ea7\n                    [module_name] => Contacts\n                    [name_value_list] => stdClass Object\n                        (\n                            [id] => stdClass Object\n                                (\n                                    [name] => id\n                                    [value] => 116d9bc6-4a24-b826-952e-4f7cb6b25ea7\n                                )\n                            [first_name] => stdClass Object\n                                (\n                                    [name] => first_name\n                                    [value] => Lucinda\n                                )\n                            [last_name] => stdClass Object\n                                (\n                                    [name] => last_name\n                                    [value] => Jacoby\n                                )\n                        )\n                )\n            [1] => stdClass Object\n                (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_a_List_of_Records_With_Related_Info/index.html"}
{"id": "9e3bf36e16d2-3", "text": ")\n                        )\n                )\n            [1] => stdClass Object\n                (\n                    [id] => 11c263ef-ff61-71ff-f090-4f7cb6fc9f68\n                    [module_name] => Contacts\n                    [name_value_list] => stdClass Object\n                        (\n                            [id] => stdClass Object\n                                (\n                                    [name] => id\n                                    [value] => 11c263ef-ff61-71ff-f090-4f7cb6fc9f68\n                                )\n                            [first_name] => stdClass Object\n                                (\n                                    [name] => first_name\n                                    [value] => Ike\n                                )\n                            [last_name] => stdClass Object\n                                (\n                                    [name] => last_name\n                                    [value] => Gassaway\n                                )\n                        )\n                )\n        )\n    [relationship_list] => Array\n        (\n            [0] => stdClass Object\n                (\n                    [link_list] => Array\n                        (\n                            [0] => stdClass Object\n                                (\n                                    [name] => email_addresses\n                                    [records] => Array\n                                        (\n                                            [0] => stdClass Object\n                                                (\n                                                    [link_value] => stdClass Object\n                                                        (\n                                                            [id] => stdClass Object\n                                                                (\n                                                                    [name] => id\n                                                                    [value] => 13066f13-d6ea-405c-0f95-4f7cb6fa3a08\n                                                                )\n                                                            [email_address] => stdClass Object\n                                                                (\n                                                                    [name] => email_address\n                                                                    [value] => support52@example.org\n                                                                )\n                                                            [opt_out] => stdClass Object\n                                                                (\n                                                                    [name] => opt_out\n                                                                    [value] => 0\n                                                                )", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_a_List_of_Records_With_Related_Info/index.html"}
{"id": "9e3bf36e16d2-4", "text": "[name] => opt_out\n                                                                    [value] => 0\n                                                                )\n                                                            [primary_address] => stdClass Object\n                                                                (\n                                                                    [name] => primary_address\n                                                                    [value] => \n                                                                )\n                                                        )\n                                                )\n                                            [1] => stdClass Object\n                                                (\n                                                    [link_value] => stdClass Object\n                                                        (\n                                                            [id] => stdClass Object\n                                                                (\n                                                                    [name] => id\n                                                                    [value] => 13e3d111-b226-c363-4832-4f7cb699a3a0\n                                                                )\n                                                            [email_address] => stdClass Object\n                                                                (\n                                                                    [name] => email_address\n                                                                    [value] => qa.section@example.it\n                                                                )\n                                                            [opt_out] => stdClass Object\n                                                                (\n                                                                    [name] => opt_out\n                                                                    [value] => 1\n                                                                )\n                                                            [primary_address] => stdClass Object\n                                                                (\n                                                                    [name] => primary_address\n                                                                    [value] => \n                                                                )\n                                                        )\n                                                )\n                                        )\n                                )\n                        )\n                )\n            [1] => stdClass Object\n                (\n                    [link_list] => Array\n                        (\n                            [0] => stdClass Object\n                                (\n                                    [name] => email_addresses\n                                    [records] => Array\n                                        (\n                                            [0] => stdClass Object\n                                                (\n                                                    [link_value] => stdClass Object\n                                                        (\n                                                            [id] => stdClass Object\n                                                                (\n                                                                    [name] => id\n                                                                    [value] => 16aeaf8b-b31f-943d-3844-4f7cb6ac63f2\n                                                                )\n                                                            [email_address] => stdClass Object\n                                                                (\n                                                                    [name] => email_address\n                                                                    [value] => vegan.sales.im@example.cn\n                                                                )", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_a_List_of_Records_With_Related_Info/index.html"}
{"id": "9e3bf36e16d2-5", "text": "[value] => vegan.sales.im@example.cn\n                                                                )\n                                                            [opt_out] => stdClass Object\n                                                                (\n                                                                    [name] => opt_out\n                                                                    [value] => 0\n                                                                )\n                                                            [primary_address] => stdClass Object\n                                                                (\n                                                                    [name] => primary_address\n                                                                    [value] => \n                                                                )\n                                                        )\n                                                )\n                                            [1] => stdClass Object\n                                                (\n                                                    [link_value] => stdClass Object\n                                                        (\n                                                            [id] => stdClass Object\n                                                                (\n                                                                    [name] => id\n                                                                    [value] => 173bacf5-5ea6-3906-d91d-4f7cb6c6e883\n                                                                )\n                                                            [email_address] => stdClass Object\n                                                                (\n                                                                    [name] => email_address\n                                                                    [value] => kid.the.section@example.org\n                                                                )\n                                                            [opt_out] => stdClass Object\n                                                                (\n                                                                    [name] => opt_out\n                                                                    [value] => 1\n                                                                )\n                                                            [primary_address] => stdClass Object\n                                                                (\n                                                                    [name] => primary_address\n                                                                    [value] => \n                                                                )\n                                                        )\n                                                )\n                                        )\n                                )\n                        )\n                )\n        )\n)\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_a_List_of_Records_With_Related_Info/index.html"}
{"id": "64b20190aa46-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nRetrieving a List of Records\nOverview\nA PHP example demonstrating how to retrieve a list of records from a module with the get_entry_list method using cURL and the v4_1 REST API.\nThis example will retrieve a list of leads.\nExample\n<?php\n    $url = \"http://{site_url}/service/v4_1/rest.php\";\n    $username = \"admin\";\n    $password = \"password\";\n    //function to make cURL request\n    function call($method, $parameters, $url)\n    {\n        ob_start();\n        $curl_request = curl_init();\n        curl_setopt($curl_request, CURLOPT_URL, $url);\n        curl_setopt($curl_request, CURLOPT_POST, 1);\n        curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\n        curl_setopt($curl_request, CURLOPT_HEADER, 1);\n        curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\n        curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\n        curl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\n        $jsonEncodedData = json_encode($parameters);\n        $post = array(\n             \"method\" => $method,\n             \"input_type\" => \"JSON\",\n             \"response_type\" => \"JSON\",\n             \"rest_data\" => $jsonEncodedData\n        );\n        curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post);\n        $result = curl_exec($curl_request);\n        curl_close($curl_request);\n        $result = explode(\"\\r\\n\\r\\n\", $result, 2);\n        $response = json_decode($result[1]);\n        ob_end_flush();\n        return $response;\n    }", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_a_List_of_Records/index.html"}
{"id": "64b20190aa46-1", "text": "ob_end_flush();\n        return $response;\n    }\n    //login ----------------------------------------- \n    $login_parameters = array(\n         \"user_auth\" => array(\n              \"user_name\" => $username,\n              \"password\" => md5($password),\n              \"version\" => \"1\"\n         ),\n         \"application_name\" => \"RestTest\",\n         \"name_value_list\" => array(),\n    );\n    $login_result = call(\"login\", $login_parameters, $url);\n    /*\n    echo \"<pre>\";\n    print_r($login_result);\n    echo \"</pre>\";\n    */\n    //get session id\n    $session_id = $login_result->id;\n    //get list of records --------------------------------\n   \n    $get_entry_list_parameters = array(\n         //session id\n         'session' => $session_id,\n         //The name of the module from which to retrieve records\n         'module_name' => 'Leads',\n         //The SQL WHERE clause without the word \"where\".\n         'query' => \"\",\n         //The SQL ORDER BY clause without the phrase \"order by\".\n         'order_by' => \"\",\n         //The record offset from which to start.\n         'offset' => '0',\n         //Optional. A list of fields to include in the results.\n         'select_fields' => array(\n              'id',\n              'name',\n              'title',\n         ),\n         /*\n         A list of link names and the fields to be returned for each link name.\n         Example: 'link_name_to_fields_array' => array(array('name' => 'email_addresses', 'value' => array('id', 'email_address', 'opt_out', 'primary_address')))\n         */\n         'link_name_to_fields_array' => array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_a_List_of_Records/index.html"}
{"id": "64b20190aa46-2", "text": "*/\n         'link_name_to_fields_array' => array(\n         ),\n         //The maximum number of results to return.\n         'max_results' => '2',\n         //To exclude deleted records\n         'deleted' => '0',\n         //If only records marked as favorites should be returned.\n         'Favorites' => false,\n    );\n    $get_entry_list_result = call('get_entry_list', $get_entry_list_parameters, $url);\n    echo '<pre>';\n    print_r($get_entry_list_result);\n    echo '</pre>';\n?>\nResult\nstdClass Object\n(\n    [result_count] => 2\n    [total_count] => 200\n    [next_offset] => 2\n    [entry_list] => Array\n        (\n            [0] => stdClass Object\n                (\n                    [id] => 18124607-69d1-b158-47ff-4f7cb69344f7\n                    [module_name] => Leads\n                    [name_value_list] => stdClass Object\n                        (\n                            [id] => stdClass Object\n                                (\n                                    [name] => id\n                                    [value] => 18124607-69d1-b158-47ff-4f7cb69344f7\n                                )\n                            [name] => stdClass Object\n                                (\n                                    [name] => name\n                                    [value] => Bernie Worthey\n                                )\n                            [title] => stdClass Object\n                                (\n                                    [name] => title\n                                    [value] => Senior Product Manager\n                                )\n                        )\n                )\n            [1] => stdClass Object\n                (\n                    [id] => 1cdfddc1-2759-b007-8713-4f7cb64c2e9c\n                    [module_name] => Leads", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_a_List_of_Records/index.html"}
{"id": "64b20190aa46-3", "text": "[module_name] => Leads\n                    [name_value_list] => stdClass Object\n                        (\n                            [id] => stdClass Object\n                                (\n                                    [name] => id\n                                    [value] => 1cdfddc1-2759-b007-8713-4f7cb64c2e9c\n                                )\n                            [name] => stdClass Object\n                                (\n                                    [name] => name\n                                    [value] => Bobbie Kohlmeier\n                                )\n                            [title] => stdClass Object\n                                (\n                                    [name] => title\n                                    [value] => Director Operations\n                                )\n                        )\n                )\n        )\n    [relationship_list] => Array\n        (\n        )\n)\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_a_List_of_Records/index.html"}
{"id": "6805f753fdfb-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nCreating Notes with Attachments\nOverview\nA PHP example demonstrating how to create a note using set_entry and add an attachment with the set_note_attachment method using cURL and the v4_1 REST API.\nExample\n<?php\n    $url = \"http://{site_url}/service/v4_1/rest.php\";\n    $username = \"admin\";\n    $password = \"password\";\n    //function to make cURL request\n    function call($method, $parameters, $url)\n    {\n        ob_start();\n        $curl_request = curl_init();\n        curl_setopt($curl_request, CURLOPT_URL, $url);\n        curl_setopt($curl_request, CURLOPT_POST, 1);\n        curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\n        curl_setopt($curl_request, CURLOPT_HEADER, 1);\n        curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\n        curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\n        curl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\n        $jsonEncodedData = json_encode($parameters);\n        $post = array(\n             \"method\" => $method,\n             \"input_type\" => \"JSON\",\n             \"response_type\" => \"JSON\",\n             \"rest_data\" => $jsonEncodedData\n        );\n        curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post);\n        $result = curl_exec($curl_request);\n        curl_close($curl_request);\n        $result = explode(\"\\r\\n\\r\\n\", $result, 2);\n        $response = json_decode($result[1]);\n        ob_end_flush();\n        return $response;\n    }\n    //login ----------------------------------------------------", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Creating_Notes_with_Attachments/index.html"}
{"id": "6805f753fdfb-1", "text": "return $response;\n    }\n    //login ----------------------------------------------------     \n    $login_parameters = array(\n         \"user_auth\" => array(\n              \"user_name\" => $username,\n              \"password\" => md5($password),\n              \"version\" => \"1\"\n         ),\n         \"application_name\" => \"RestTest\",\n         \"name_value_list\" => array(),\n    );\n    $login_result = call(\"login\", $login_parameters, $url);\n    /*\n    echo \"<pre>\";\n    print_r($login_result);\n    echo \"</pre>\";\n    */\n    //get session id\n    $session_id = $login_result->id;\n    //create note -----------------------------------------------     \n    $set_entry_parameters = array(\n         //session id\n         \"session\" => $session_id,\n         //The name of the module\n         \"module_name\" => \"Notes\",\n         //Record attributes\n         \"name_value_list\" => array(\n              //to update a record, you will nee to pass in a record id as commented below\n              //array(\"name\" => \"id\", \"value\" => \"9b170af9-3080-e22b-fbc1-4fea74def88f\"),\n              array(\"name\" => \"name\", \"value\" => \"Example Note\"),\n         ),\n    );\n    $set_entry_result = call(\"set_entry\", $set_entry_parameters, $url);\n    echo \"<pre>\";\n    print_r($set_entry_result);\n    echo \"</pre>\";\n    $note_id = $set_entry_result->id;\n    //create note attachment --------------------------------------     \n    $contents = file_get_contents (\"/path/to/example_file.php\");\n    $set_note_attachment_parameters = array(\n        //session id", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Creating_Notes_with_Attachments/index.html"}
{"id": "6805f753fdfb-2", "text": "$set_note_attachment_parameters = array(\n        //session id\n        \"session\" => $session_id,\n        //The attachment details\n        \"note\" => array(\n            //The ID of the note containing the attachment.\n            'id' => $note_id,\n            //The file name of the attachment.\n            'filename' => 'example_file.php',\n            //The binary contents of the file.\n            'file' => base64_encode($contents),\n        ),\n    );\n    $set_note_attachment_result = call(\"set_note_attachment\", $set_note_attachment_parameters, $url);\n    echo \"<pre>\";\n    print_r($set_note_attachment_result);\n    echo \"</pre>\";\n?>\nResult\n//set_entry result\nstdClass Object\n(\n    [id] => 72508938-db19-3b5c-b7a8-50abc7ec3fdb\n    [entry_list] => stdClass Object\n        (\n            [name] => stdClass Object\n                (\n                    [name] => name\n                    [value] => Example Note\n                )\n        )\n)\n//set_note_attachment result\nstdClass Object\n(\n    [id] => 72508938-db19-3b5c-b7a8-50abc7ec3fdb\n)\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Creating_Notes_with_Attachments/index.html"}
{"id": "4507e84e786b-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nRetrieving a List of Fields From a Module\nOverview\nA PHP example demonstrating how to retrieve fields vardefs from the accounts module with the get_module_fields method using cURL and the v4_1 REST API.\nThis example will only retrieve the vardefs for the 'id' and 'name' fields.\nExample\n<?php\n    $url = \"http://{site_url}/service/v4_1/rest.php\";\n    $username = \"admin\";\n    $password = \"password\";\n    function call($method, $parameters, $url)\n    {\n        ob_start();\n        $curl_request = curl_init();\n        curl_setopt($curl_request, CURLOPT_URL, $url);\n        curl_setopt($curl_request, CURLOPT_POST, 1);\n        curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\n        curl_setopt($curl_request, CURLOPT_HEADER, 1);\n        curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\n        curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\n        curl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\n        $jsonEncodedData = json_encode($parameters);\n        $post = array(\n             \"method\" => $method,\n             \"input_type\" => \"JSON\",\n             \"response_type\" => \"JSON\",\n             \"rest_data\" => $jsonEncodedData\n        );\n        curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post);\n        $result = curl_exec($curl_request);\n        curl_close($curl_request);\n        $result = explode(\"\\r\\n\\r\\n\", $result, 2);\n        $response = json_decode($result[1]);\n        ob_end_flush();", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_a_List_of_Fields_From_a_Module/index.html"}
{"id": "4507e84e786b-1", "text": "$response = json_decode($result[1]);\n        ob_end_flush();\n        return $response;\n    }\n    //login ---------------------------------------- \n    $login_parameters = array(\n         \"user_auth\" => array(\n              \"user_name\" => $username,\n              \"password\" => md5($password),\n              \"version\" => \"1\"\n         ),\n         \"application_name\" => \"RestTest\",\n         \"name_value_list\" => array(),\n    );\n    $login_result = call(\"login\", $login_parameters, $url);\n    /*\n    echo \"<pre>\";\n    print_r($login_result);\n    echo \"</pre>\";\n    */\n    //get session id\n    $session_id = $login_result->id;\n    //retrieve fields -------------------------------- \n    $get_module_fields_parameters = array(\n         //session id\n         'session' => $session_id,\n         //The name of the module from which to retrieve records\n         'module_name' => 'Accounts',\n         //Optional. Returns vardefs for the specified fields. An empty array will return all fields.\n         'fields' => array(\n             'id',\n             'name',\n         ),\n    );\n    $get_module_fields_result = call(\"get_module_fields\", $get_module_fields_parameters, $url);\n    echo \"<pre>\";\n    print_r($get_module_fields_result);\n    echo \"</pre>\";\n?>\nResult\nstdClass Object\n(\n    [module_name] => Accounts\n    [table_name] => accounts\n    [module_fields] => stdClass Object\n        (\n            [id] => stdClass Object\n                (\n                    [name] => id\n                    [type] => id\n                    [group] => \n                    [id_name] => \n                    [label] => ID", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_a_List_of_Fields_From_a_Module/index.html"}
{"id": "4507e84e786b-2", "text": "[id_name] => \n                    [label] => ID\n                    [required] => 1\n                    [options] => Array\n                        (\n                        )\n                    [related_module] => \n                    [calculated] => \n                    [len] => \n                )\n            [name] => stdClass Object\n                (\n                    [name] => name\n                    [type] => name\n                    [group] => \n                    [id_name] => \n                    [label] => Name:\n                    [required] => 1\n                    [options] => Array\n                        (\n                        )\n                    [related_module] => \n                    [calculated] => \n                    [len] => 150\n                )\n        )\n    [link_fields] => Array\n        (\n        )\n)\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_a_List_of_Fields_From_a_Module/index.html"}
{"id": "67806f13096d-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nCreating or Updating Teams\nOverview\nA PHP example demonstrating how to manipulate teams using cURL and the v4_1 REST API.\n    \nNote: If you are creating a private team for a user, you will need to set private to true and populate the associated_user_id populated. You should also populate the name and name_2 properties with the users first and last name.\n    \nExample \n<?php\n    $url = \"http://{site_url}/service/v4_1/rest.php\";\n    $username = \"admin\";\n    $password = \"password\";\n    //function to make cURL request\n    function call($method, $parameters, $url)\n    {\n        ob_start();\n        $curl_request = curl_init();\n   \n        curl_setopt($curl_request, CURLOPT_URL, $url);\n        curl_setopt($curl_request, CURLOPT_POST, 1);\n        curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\n        curl_setopt($curl_request, CURLOPT_HEADER, 1);\n        curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\n        curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\n        curl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\n   \n        $jsonEncodedData = json_encode($parameters);\n   \n        $post = array(\n            \"method\" => $method,\n            \"input_type\" => \"JSON\",\n            \"response_type\" => \"JSON\",\n            \"rest_data\" => $jsonEncodedData\n        );\n   \n        curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post);\n        $result = curl_exec($curl_request);\n        curl_close($curl_request);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Creating_or_Updating_Teams/index.html"}
{"id": "67806f13096d-1", "text": "curl_close($curl_request);\n   \n        $result = explode(\"\\r\\n\\r\\n\", $result, 2);\n        $response = json_decode($result[1]);\n        ob_end_flush();\n   \n        return $response;\n    }\n   \n    //login --------------------------------------------\n   \n    $login_parameters = array(\n        \"user_auth\" => array(\n            \"user_name\" => $username,\n            \"password\" => md5($password),\n            \"version\" => \"1\"\n        ),\n        \"application_name\" => \"RestTest\",\n        \"name_value_list\" => array(),\n    );\n   \n    $login_result = call(\"login\", $login_parameters, $url);\n   \n    /*\n    echo \"<pre>\";\n    print_r($login_result);\n    echo \"</pre>\";\n    */\n   \n    //get session id\n    $session_id = $login_result->id;\n   \n    //create team -----------------------------------------------\n   \n    $set_entry_parameters = array(\n   \n        // session id\n        \"session\" => $session_id,\n   \n        // The name of the module that the record will be create in.\n        \"module_name\" => \"Teams\",\n   \n        // array of arrays for the record attributes\n        \"name_value_list\" => array(\n            /* Setting the id with a valid record id will update the record.\n            array(\n                \"name\" => \"id\",\n                \"value\" => \"47dbab1d-bd78-09e8-4392-5256b4501d90\"\n            ),\n            */\n            array(\n                \"name\" => \"name\",\n                \"value\" => \"My Team\"\n            ),\n            array(\n                \"name\" => \"description\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Creating_or_Updating_Teams/index.html"}
{"id": "67806f13096d-2", "text": "),\n            array(\n                \"name\" => \"description\",\n                \"value\" => \"My new team\"\n            ),\n            //Whether the team is private.\n            //Private teams will have the associated_user_id populated.\n            array(\n                \"name\" => \"private\",\n                \"value\" => 0\n            ),\n        ),\n    );\n   \n    $set_entry_result = call(\"set_entry\", $set_entry_parameters, $url);\n   \n    echo \"<pre>\";\n    print_r($set_entry_result);\n    echo \"</pre>\";\n?>\nResult \nstdClass Object\n(\n    [id] => 5c35a3be-4601-fb45-3afd-52ab78b03f89\n    [entry_list] => stdClass Object\n        (\n            [name] => stdClass Object\n                (\n                    [name] => name\n                    [value] => My Team\n                )\n            [description] => stdClass Object\n                (\n                    [name] => description\n                    [value] => My new team\n                )\n            [private] => stdClass Object\n                (\n                    [name] => private\n                    [value] =>\n                )\n        )\n)\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Creating_or_Updating_Teams/index.html"}
{"id": "6b5437db2cb7-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nSearching Records\nOverview\nA PHP example demonstrating how to search the accounts module with the search_by_module method using cURL and the v4_1 REST API.\nThis script will return two results, sorted by the id field, and return the value of the id, name, account_type, phone_office, and assigned_user_name fields.\nExample\n<?php\n    $url = \"http://{site_url}/service/v4_1/rest.php\";\n    $username = \"admin\";\n    $password = \"password\";\n    //function to make cURL request\n    function call($method, $parameters, $url)\n    {\n        ob_start();\n        $curl_request = curl_init();\n        curl_setopt($curl_request, CURLOPT_URL, $url);\n        curl_setopt($curl_request, CURLOPT_POST, 1);\n        curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\n        curl_setopt($curl_request, CURLOPT_HEADER, 1);\n        curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\n        curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\n        curl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\n        $jsonEncodedData = json_encode($parameters);\n        $post = array(\n             \"method\" => $method,\n             \"input_type\" => \"JSON\",\n             \"response_type\" => \"JSON\",\n             \"rest_data\" => $jsonEncodedData\n        );\n        curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post);\n        $result = curl_exec($curl_request);\n        curl_close($curl_request);\n        $result = explode(\"\\r\\n\\r\\n\", $result, 2);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Searching_Records/index.html"}
{"id": "6b5437db2cb7-1", "text": "$result = explode(\"\\r\\n\\r\\n\", $result, 2);\n        $response = json_decode($result[1]);\n        ob_end_flush();\n        return $response;\n    }\n    //login ----------------------------------------- \n    $login_parameters = array(\n         \"user_auth\" => array(\n              \"user_name\" => $username,\n              \"password\" => md5($password),\n              \"version\" => \"1\"\n         ),\n         \"application_name\" => \"RestTest\",\n         \"name_value_list\" => array(),\n    );\n    $login_result = call(\"login\", $login_parameters, $url);\n    /*\n    echo \"<pre>\";\n    print_r($login_result);\n    echo \"</pre>\";\n    */\n    //get session id\n    $session_id = $login_result->id;\n    //search --------------------------------------- \n    $search_by_module_parameters = array(\n        //Session id\n        \"session\" => $session_id,\n        //The string to search for.\n        'search_string' => 'Customer',\n        //The list of modules to query.\n        'modules' => array(\n        'Accounts',\n        ),\n        //The record offset from which to start.\n        'offset' => 0,\n        //The maximum number of records to return.\n        'max_results' => 2,\n        //Filters records by the assigned user ID.\n        //Leave this empty if no filter should be applied.\n        'id' => '',\n        //An array of fields to return.\n        //If empty the default return fields will be from the active listviewdefs.\n        'select_fields' => array(\n            'id',\n            'name',\n            'account_type',\n            'phone_office',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Searching_Records/index.html"}
{"id": "6b5437db2cb7-2", "text": "'name',\n            'account_type',\n            'phone_office',\n            'assigned_user_name',\n        ),\n        //If the search is to only search modules participating in the unified search.\n        //Unified search is the SugarCRM Global Search alternative to Full-Text Search.\n        'unified_search_only' => false,\n        //If only records marked as favorites should be returned.\n        'favorites' => false\n    );\n    $search_by_module_result = call('search_by_module', $search_by_module_parameters, $url);\n    echo '<pre>';\n    print_r($search_by_module_result);\n    echo '</pre>';\n?>\nResult\nstdClass Object\n(\n    [result_count] => 2\n    [total_count] => 200\n    [next_offset] => 2\n    [entry_list] => Array\n        (\n            [0] => stdClass Object\n                (\n                    [id] => 18124607-69d1-b158-47ff-4f7cb69344f7\n                    [module_name] => Leads\n                    [name_value_list] => stdClass Object\n                        (\n                            [id] => stdClass Object\n                                (\n                                    [name] => id\n                                    [value] => 18124607-69d1-b158-47ff-4f7cb69344f7\n                                )\n                            [name] => stdClass Object\n                                (\n                                    [name] => name\n                                    [value] => Bernie Worthey\n                                )\n                            [title] => stdClass Object\n                                (\n                                    [name] => title\n                                    [value] => Senior Product Manager\n                                )\n                        )\n                )\n            [1] => stdClass Object\n                (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Searching_Records/index.html"}
{"id": "6b5437db2cb7-3", "text": ")\n                        )\n                )\n            [1] => stdClass Object\n                (\n                    [id] => 1cdfddc1-2759-b007-8713-4f7cb64c2e9c\n                    [module_name] => Leads\n                    [name_value_list] => stdClass Object\n                        (\n                            [id] => stdClass Object\n                                (\n                                    [name] => id\n                                    [value] => 1cdfddc1-2759-b007-8713-4f7cb64c2e9c\n                                )\n                            [name] => stdClass Object\n                                (\n                                    [name] => name\n                                    [value] => Bobbie Kohlmeier\n                                )\n                            [title] => stdClass Object\n                                (\n                                    [name] => title\n                                    [value] => Director Operations\n                                )\n                        )\n                )\n        )\n    [relationship_list] => Array\n        (\n        )\n)\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Searching_Records/index.html"}
{"id": "b2b19bbc67ee-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nRetrieving Related Records\nOverview\nA PHP example demonstrating how to retrieve a list of related records with the get_relationships method using cURL and the v4_1 REST API.\nThis example will retrieve a list of leads related to a specific target list.\nExample\n<?php\n    $url = \"http://{site_url}/service/v4_1/rest.php\";\n    $username = \"admin\";\n    $password = \"password\";\n    //function to make cURL request\n    function call($method, $parameters, $url)\n    {\n        ob_start();\n        $curl_request = curl_init();\n        curl_setopt($curl_request, CURLOPT_URL, $url);\n        curl_setopt($curl_request, CURLOPT_POST, 1);\n        curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\n        curl_setopt($curl_request, CURLOPT_HEADER, 1);\n        curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\n        curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\n        curl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\n        $jsonEncodedData = json_encode($parameters);\n        $post = array(\n             \"method\" => $method,\n             \"input_type\" => \"JSON\",\n             \"response_type\" => \"JSON\",\n             \"rest_data\" => $jsonEncodedData\n        );\n        curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post);\n        $result = curl_exec($curl_request);\n        curl_close($curl_request);\n        $result = explode(\"\\r\\n\\r\\n\", $result, 2);\n        $response = json_decode($result[1]);\n        ob_end_flush();\n        return $response;", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Related_Records/index.html"}
{"id": "b2b19bbc67ee-1", "text": "ob_end_flush();\n        return $response;\n    }\n    //login --------------------------------------------- \n    $login_parameters = array(\n         \"user_auth\" => array(\n              \"user_name\" => $username,\n              \"password\" => md5($password),\n              \"version\" => \"1\"\n         ),\n         \"application_name\" => \"RestTest\",\n         \"name_value_list\" => array(),\n    );\n    $login_result = call(\"login\", $login_parameters, $url);\n    /*\n    echo \"<pre>\";\n    print_r($login_result);\n    echo \"</pre>\";\n    */\n    //get session id\n    $session_id = $login_result->id;\n    //retrieve related list ------------------------------ \n    $get_relationships_parameters = array(\n         'session'=>$session_id,\n         //The name of the module from which to retrieve records.\n         'module_name' => 'ProspectLists',\n         //The ID of the specified module bean.\n         'module_id' => '76d0e694-ef66-ddd5-9bdf-4febd3af44d5',\n         //The relationship name of the linked field from which to return records.\n         'link_field_name' => 'leads',\n         //The portion of the WHERE clause from the SQL statement used to find the related items.\n         'related_module_query' => '',\n         //The related fields to be returned.\n         'related_fields' => array(\n            'id',\n            'first_name',\n            'last_name',\n         ),\n         //For every related bean returned, specify link field names to field information.\n         'related_module_link_name_to_fields_array' => array(\n         ),\n         //To exclude deleted records\n         'deleted'=> '0',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Related_Records/index.html"}
{"id": "b2b19bbc67ee-2", "text": "),\n         //To exclude deleted records\n         'deleted'=> '0',\n         //order by\n         'order_by' => '',\n         //offset\n         'offset' => 0,\n         //limit\n         'limit' => 5,\n    );\n    $get_relationships_result = call(\"get_relationships\", $get_relationships_parameters, $url);\n    echo \"<pre>\";\n    print_r($get_relationships_result);\n    echo \"</pre>\";\n?>\nResults\nstdClass Object\n(\n    [entry_list] => Array\n        (\n            [0] => stdClass Object\n                (\n                    [id] => 117c26c0-11d4-7b8b-cb8f-4f7cb6823dd8\n                    [module_name] => Leads\n                    [name_value_list] => stdClass Object\n                        (\n                            [id] => stdClass Object\n                                (\n                                    [name] => id\n                                    [value] => 117c26c0-11d4-7b8b-cb8f-4f7cb6823dd8\n                                )\n                            [first_name] => stdClass Object\n                                (\n                                    [name] => first_name\n                                    [value] => Diane\n                                )\n                            [last_name] => stdClass Object\n                                (\n                                    [name] => last_name\n                                    [value] => Mckamey\n                                )\n                        )\n                )\n            [1] => stdClass Object\n                (\n                    [id] => 142faeef-1a19-b53a-b780-4f7cb600c553\n                    [module_name] => Leads\n                    [name_value_list] => stdClass Object\n                        (\n                            [id] => stdClass Object\n                                (\n                                    [name] => id", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Related_Records/index.html"}
{"id": "b2b19bbc67ee-3", "text": "[id] => stdClass Object\n                                (\n                                    [name] => id\n                                    [value] => 142faeef-1a19-b53a-b780-4f7cb600c553\n                                )\n                            [first_name] => stdClass Object\n                                (\n                                    [name] => first_name\n                                    [value] => Leonor\n                                )\n                            [last_name] => stdClass Object\n                                (\n                                    [name] => last_name\n                                    [value] => Reser\n                                )\n                        )\n                )\n        )\n    [relationship_list] => Array\n        (\n        )\n)\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/Legacy_API/REST/PHP/Retrieving_Related_Records/index.html"}
{"id": "1cbd9d412a9b-0", "text": "REST API\nExamples of integrating with Sugar REST APIs.\nTopicsBashBash cURL examples of integrating with the REST v11 API.PHPPHP Examples interacting with the v11 REST API.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/index.html"}
{"id": "8c683c2b0d02-0", "text": "PHP\nPHP Examples interacting with the v11 REST API.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/index.html"}
{"id": "8c683c2b0d02-1", "text": "TopicsHow to Export a List of RecordsAn PHP example demonstrating how to export a list of records using the v11 /<module>/export/:record_list_id REST GET endpoint.How to Filter a List of RecordsA PHP example demonstrating how to filter records using the v11 /<module>/filter REST POST endpoints.How to Favorite a RecordA PHP example demonstrating how to favorite a record using the v11 <module>/:record/favorite REST PUT API endpoint.How to Manipulate File AttachmentsA PHP example demonstrating how to attach a file to a record using the v11 <module>/:record/file/:field REST POST API endpoint, then retrieve it with the GET endpoint.How to Fetch Related RecordsA PHP example demonstrating how to fetch related records using the v11 /<module>/:record/link/:link REST GET endpoints.How to Manipulate Records (CRUD)A PHP example demonstrating how to use the CRUD (Create, Read, Update, Delete) endpoints in the REST v11 API.How to Follow a RecordA PHP example demonstrating how to follow a record using the v11 /<module>/:record/subscribe REST POST endpoint.How to Unfavorite a RecordA PHP example demonstrating how to unfavorite a record using the v11 /<module>/:record/unfavorite REST PUT endpoint.How to Unfollow a RecordA PHP example demonstrating how to unfollow a record using the v11 /<module>/:record/unsubscribe REST DELETE endpoint.How to Get the Most Active UsersA PHP example demonstrating how to fetch the most active users for meetings, calls, inbound emails, and outbound emails using the v11 /mostactiveusers REST GET endpoint.How to Authenticate and Log OutA PHP example on how to authenticate and logout of the v11 REST API using the /oauth2/token and /oauth2/logout POST endpoints.How to PingA PHP example demonstrating how to ping using the REST v11 /ping GET endpoint.How to Fetch the Current Users TimeA PHP example demonstrating how to fetch the current users", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/index.html"}
{"id": "8c683c2b0d02-2", "text": "GET endpoint.How to Fetch the Current Users TimeA PHP example demonstrating how to fetch the current users time with the v11 /ping/whattimeisit REST GET endpoint.How to Fetch Recently Viewed RecordsA PHP example demonstrating how to retrieve recently viewed records using the v11 /recent REST GET endpoint.How to Use the Global SearchA PHP example demonstrating how to globally search for records using the REST v11 /search GET endpoint.How to Check for Duplicate RecordsAn PHP example demonstrating how to check for duplicate records using the v11 /<module>/duplicateCheck REST POST endpoint.How to Manipulate QuotesA PHP example demonstrating how to manipulate Quotes and related record data such as ProductBundles, Products, and ProductBundleNotes.How to Manipulate Tags (CRUD)A PHP example demonstrating how to work with tags using the v11 REST endpoints.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/index.html"}
{"id": "8c683c2b0d02-3", "text": "Last modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/index.html"}
{"id": "8cc42f064174-0", "text": "How to Fetch Related Records\nOverview\nA PHP example\u00c2\u00a0demonstrating how to fetch related records\u00c2\u00a0using the v11\u00c2\u00a0/<module>/:record/link/:link REST GET endpoints.\nFetching Related Records\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\n<?php\n$instance_url = \"http://{site_url}/rest/v11\";\n$username = \"admin\";\n$password = \"password\";\n//Login - POST /oauth2/token\n$auth_url = $instance_url . \"/oauth2/token\";\n$oauth2_token_arguments = array(\n    \"grant_type\" => \"password\",\n    //client id - default is sugar. \n    //It is recommended to create your own in Admin > OAuth Keys\n    \"client_id\" => \"sugar\", \n    \"client_secret\" => \"\",\n    \"username\" => $username,\n    \"password\" => $password,\n    //platform type - default is base.\n    //It is recommend to change the platform to a custom name such as \"custom_api\" to avoid authentication conflicts.\n    \"platform\" => \"custom_api\" \n);\n$auth_request = curl_init($auth_url);\ncurl_setopt($auth_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($auth_request, CURLOPT_HEADER, false);\ncurl_setopt($auth_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($auth_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($auth_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($auth_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\"\n));\n//convert arguments to json\n$json_arguments = json_encode($oauth2_token_arguments);\ncurl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Related_Records/index.html"}
{"id": "8cc42f064174-1", "text": "curl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$oauth2_token_response = curl_exec($auth_request);\n//decode oauth2 response to get token\n$oauth2_token_response_obj = json_decode($oauth2_token_response);\n$oauth_token = $oauth2_token_response_obj->access_token;\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nFetching Related Records\nNext, we can fetch the related records we want to return\u00c2\u00a0using the\u00c2\u00a0/<module>/:record/link/:link endpoint with a GET request where\nElement\nMeaning\n<module>\nThe parent module name\n:record\nThe parent records ID\nlink\nthe actual word \"link\"\n:link\nThe name of the relationship to fetch\nIn this example, we will fetch the related Contacts for an Account\n//Identify records to fetch - POST /<module>/:record/link/:link\n$fetch_url = $instance_url . \"/Accounts/d8f05e67-dee3-553d-0040-5342e88f2fd1/link/contacts\";\n$fetch_request = curl_init($fetch_url);\ncurl_setopt($fetch_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($fetch_request, CURLOPT_HEADER, false);\ncurl_setopt($fetch_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($fetch_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($fetch_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($fetch_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//execute request\n$fetch_response = curl_exec($fetch_request);\n//decode json\n$fetch_response_obj = json_decode($fetch_response);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Related_Records/index.html"}
{"id": "8cc42f064174-2", "text": "//decode json\n$fetch_response_obj = json_decode($fetch_response);\nRequest\nhttp://{site_url}/rest/v11/Accounts/d8f05e67-dee3-553d-0040-5342e88f2fd1/link/contacts\nResponse\nThe data received from the server is shown below:\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"819f4149-b007-a6da-a5fa-56fedbf2de77\",\n         \"name\":\"Florine Marcus\",\n         \"date_entered\":\"2016-04-01T15:34:00-05:00\",\n         \"date_modified\":\"2016-04-01T15:34:00-05:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"user_favorites\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_will_id\",\n         \"assigned_user_name\":\"Will Westin\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":true\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":false\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"support27@example.tv\",\n               \"primary_address\":true,\n               \"reply_to_address\":false,\n               \"invalid_email\":false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Related_Records/index.html"}
{"id": "8cc42f064174-3", "text": "\"reply_to_address\":false,\n               \"invalid_email\":false,\n               \"opt_out\":false\n            },\n            {\n               \"email_address\":\"support.support.kid@example.net\",\n               \"primary_address\":false,\n               \"reply_to_address\":false,\n               \"invalid_email\":false,\n               \"opt_out\":true\n            }\n         ],\n         \"email1\":\"support27@example.tv\",\n         \"email2\":\"\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"salutation\":\"\",\n         \"first_name\":\"Florine\",\n         \"last_name\":\"Marcus\",\n         \"full_name\":\"Florine Marcus\",\n         \"title\":\"President\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(746) 162-2314\",\n         \"phone_mobile\":\"(941) 088-2874\",\n         \"phone_work\":\"(827) 541-9614\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"primary_address_street\":\"1715 Scott Dr\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Alabama\",\n         \"primary_address_state\":\"NY\",\n         \"primary_address_postalcode\":\"70187\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Related_Records/index.html"}
{"id": "8cc42f064174-4", "text": "\"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Employee\",\n         \"account_name\":\"MTM Investment Bank F S B\",\n         \"account_id\":\"e8c641ca-1b8c-74c1-d08d-56fedbdd3187\",\n         \"dnb_principal_id\":\"\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"birthdate\":\"\",\n         \"portal_name\":\"FlorineMarcus119\",\n         \"portal_active\":true,\n         \"portal_password\":true,\n         \"portal_password1\":null,\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"accept_status_calls\":\"\",\n         \"accept_status_meetings\":\"\",\n         \"sync_contact\":false,\n         \"mkto_sync\":false,\n         \"mkto_id\":null,\n         \"mkto_lead_score\":null,\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Contacts\"\n      },\n      {\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"527cc1a9-7984-91fe-4148-56fedbc356aa\",\n         \"name\":\"Shaneka Aceto\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Related_Records/index.html"}
{"id": "8cc42f064174-5", "text": "\"name\":\"Shaneka Aceto\",\n         \"date_entered\":\"2016-04-01T15:34:00-05:00\",\n         \"date_modified\":\"2016-04-01T15:34:00-05:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"user_favorites\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_will_id\",\n         \"assigned_user_name\":\"Will Westin\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":true\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":false\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"support17@example.cn\",\n               \"primary_address\":true,\n               \"reply_to_address\":false,\n               \"invalid_email\":false,\n               \"opt_out\":false\n            },\n            {\n               \"email_address\":\"section.sugar.the@example.tv\",\n               \"primary_address\":false,\n               \"reply_to_address\":false,\n               \"invalid_email\":false,\n               \"opt_out\":true\n            }\n         ],\n         \"email1\":\"support17@example.cn\",\n         \"email2\":\"\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"salutation\":\"\",\n         \"first_name\":\"Shaneka\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Related_Records/index.html"}
{"id": "8cc42f064174-6", "text": "\"salutation\":\"\",\n         \"first_name\":\"Shaneka\",\n         \"last_name\":\"Aceto\",\n         \"full_name\":\"Shaneka Aceto\",\n         \"title\":\"IT Developer\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(502) 528-5151\",\n         \"phone_mobile\":\"(816) 719-3739\",\n         \"phone_work\":\"(994) 769-5855\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"primary_address_street\":\"123 Anywhere Street\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"NY\",\n         \"primary_address_postalcode\":\"15128\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Email\",\n         \"account_name\":\"MTM Investment Bank F S B\",\n         \"account_id\":\"e8c641ca-1b8c-74c1-d08d-56fedbdd3187\",\n         \"dnb_principal_id\":\"\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Related_Records/index.html"}
{"id": "8cc42f064174-7", "text": "\"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"birthdate\":\"\",\n         \"portal_name\":\"ShanekaAceto151\",\n         \"portal_active\":true,\n         \"portal_password\":true,\n         \"portal_password1\":null,\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"accept_status_calls\":\"\",\n         \"accept_status_meetings\":\"\",\n         \"sync_contact\":false,\n         \"mkto_sync\":false,\n         \"mkto_id\":null,\n         \"mkto_lead_score\":null,\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Contacts\"\n      },\n      {\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"42d703ed-f834-f87c-967d-56fedb044051\",\n         \"name\":\"Johnnie Pina\",\n         \"date_entered\":\"2016-04-01T15:34:00-05:00\",\n         \"date_modified\":\"2016-04-01T15:34:00-05:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"user_favorites\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_will_id\",\n         \"assigned_user_name\":\"Will Westin\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Related_Records/index.html"}
{"id": "8cc42f064174-8", "text": "\"assigned_user_name\":\"Will Westin\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":true\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":false\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"sugar.support.hr@example.co.uk\",\n               \"primary_address\":true,\n               \"reply_to_address\":false,\n               \"invalid_email\":false,\n               \"opt_out\":false\n            },\n            {\n               \"email_address\":\"support.im@example.tw\",\n               \"primary_address\":false,\n               \"reply_to_address\":false,\n               \"invalid_email\":false,\n               \"opt_out\":true\n            }\n         ],\n         \"email1\":\"sugar.support.hr@example.co.uk\",\n         \"email2\":\"\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"salutation\":\"\",\n         \"first_name\":\"Johnnie\",\n         \"last_name\":\"Pina\",\n         \"full_name\":\"Johnnie Pina\",\n         \"title\":\"VP Operations\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(159) 335-1423\",\n         \"phone_mobile\":\"(580) 140-4050\",\n         \"phone_work\":\"(418) 792-9611\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"primary_address_street\":\"345 Sugar Blvd.\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Related_Records/index.html"}
{"id": "8cc42f064174-9", "text": "\"phone_fax\":\"\",\n         \"primary_address_street\":\"345 Sugar Blvd.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"NY\",\n         \"primary_address_postalcode\":\"70648\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Direct Mail\",\n         \"account_name\":\"MTM Investment Bank F S B\",\n         \"account_id\":\"e8c641ca-1b8c-74c1-d08d-56fedbdd3187\",\n         \"dnb_principal_id\":\"\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"birthdate\":\"\",\n         \"portal_name\":\"JohnniePina194\",\n         \"portal_active\":true,\n         \"portal_password\":true,\n         \"portal_password1\":null,\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"accept_status_calls\":\"\",\n         \"accept_status_meetings\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Related_Records/index.html"}
{"id": "8cc42f064174-10", "text": "\"accept_status_calls\":\"\",\n         \"accept_status_meetings\":\"\",\n         \"sync_contact\":false,\n         \"mkto_sync\":false,\n         \"mkto_id\":null,\n         \"mkto_lead_score\":null,\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Contacts\"\n      }\n   ]\n}\nDownload\nYou can download the full API example here\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Related_Records/index.html"}
{"id": "14a02c6efd90-0", "text": "How to Unfavorite a Record\nOverview\nA PHP example demonstrating how to unfavorite a record using the v11 /<module>/:record/unfavorite REST PUT\u00c2\u00a0endpoint.\nUnfavoriting a Record\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\n<?php\n$instance_url = \"http://{site_url}/rest/v11\";\n$username = \"admin\";\n$password = \"password\";\n//Login - POST /oauth2/token\n$auth_url = $instance_url . \"/oauth2/token\";\n$oauth2_token_arguments = array(\n    \"grant_type\" => \"password\",\n    //client id - default is sugar. \n    //It is recommended to create your own in Admin > OAuth Keys\n    \"client_id\" => \"sugar\", \n    \"client_secret\" => \"\",\n    \"username\" => $username,\n    \"password\" => $password,\n    //platform type - default is base.\n    //It is recommend to change the platform to a custom name such as \"custom_api\" to avoid authentication conflicts.\n    \"platform\" => \"custom_api\" \n);\n$auth_request = curl_init($auth_url);\ncurl_setopt($auth_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($auth_request, CURLOPT_HEADER, false);\ncurl_setopt($auth_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($auth_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($auth_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($auth_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\"\n));\n//convert arguments to json\n$json_arguments = json_encode($oauth2_token_arguments);\ncurl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Unfavorite_a_Record/index.html"}
{"id": "14a02c6efd90-1", "text": "curl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$oauth2_token_response = curl_exec($auth_request);\n//decode oauth2 response to get token\n$oauth2_token_response_obj = json_decode($oauth2_token_response);\n$oauth_token = $oauth2_token_response_obj->access_token;\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nUnfavoriting a Record\nNext, we can unfavorite\u00c2\u00a0a specific record\u00c2\u00a0using the /<module>/:record/unfavorite\u00c2\u00a0endpoint.\n//Unfavorite record - PUT //:record/unfavorite\n$unfavorite_url = $instance_url . \"/Accounts/ae8b1783-404a-fcb8-1e1e-56f1cc52cd1a/unfavorite\";\n$unfavorite_request = curl_init($unfavorite_url);\ncurl_setopt($unfavorite_request, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_setopt($unfavorite_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($unfavorite_request, CURLOPT_HEADER, false);\ncurl_setopt($unfavorite_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($unfavorite_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($unfavorite_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($unfavorite_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//execute request\n$unfavorite_response = curl_exec($unfavorite_request);\nMore information on the unfavorite API\u00c2\u00a0can be found in the /<module>/:record/unfavorite PUT\u00c2\u00a0documentation.\nRequest Payload\nThe data sent to the server is shown below:\nThis endpoint does not accept any request arguments.\nResponse", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Unfavorite_a_Record/index.html"}
{"id": "14a02c6efd90-2", "text": "This endpoint does not accept any request arguments.\nResponse\nThe data received from the server is shown below:\n{\n    \"id\": \"ae8b1783-404a-fcb8-1e1e-56f1cc52cd1a\",\n    \"name\": \"Union Bank\",\n    \"date_entered\": \"2016-03-22T17:49:50-05:00\",\n    \"date_modified\": \"2016-03-30T17:44:20-05:00\",\n    \"modified_user_id\": \"1\",\n    \"modified_by_name\": \"Administrator\",\n    \"modified_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": [],\n            \"delete\": \"no\",\n            \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n        }\n    },\n    \"created_by\": \"1\",\n    \"created_by_name\": \"Administrator\",\n    \"created_by_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": [],\n            \"delete\": \"no\",\n            \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n        }\n    },\n    \"description\": \"\",\n    \"deleted\": false,\n    \"facebook\": \"\",\n    \"twitter\": \"\",\n    \"googleplus\": \"\",\n    \"account_type\": \"Customer\",\n    \"industry\": \"Banking\",\n    \"annual_revenue\": \"\",\n    \"phone_fax\": \"\",\n    \"billing_address_street\": \"67321 West Siam St.\",\n    \"billing_address_street_2\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Unfavorite_a_Record/index.html"}
{"id": "14a02c6efd90-3", "text": "\"billing_address_street_2\": \"\",\n    \"billing_address_street_3\": \"\",\n    \"billing_address_street_4\": \"\",\n    \"billing_address_city\": \"Ohio\",\n    \"billing_address_state\": \"CA\",\n    \"billing_address_postalcode\": \"25159\",\n    \"billing_address_country\": \"USA\",\n    \"rating\": \"\",\n    \"phone_office\": \"(065) 489-6104\",\n    \"phone_alternate\": \"\",\n    \"website\": \"www.qahr.edu\",\n    \"ownership\": \"\",\n    \"employees\": \"\",\n    \"ticker_symbol\": \"\",\n    \"shipping_address_street\": \"67321 West Siam St.\",\n    \"shipping_address_street_2\": \"\",\n    \"shipping_address_street_3\": \"\",\n    \"shipping_address_street_4\": \"\",\n    \"shipping_address_city\": \"Ohio\",\n    \"shipping_address_state\": \"CA\",\n    \"shipping_address_postalcode\": \"25159\",\n    \"shipping_address_country\": \"USA\",\n    \"parent_id\": \"\",\n    \"sic_code\": \"\",\n    \"duns_num\": \"\",\n    \"parent_name\": \"\",\n    \"member_of\": {\n        \"name\": \"\",\n        \"id\": \"\",\n        \"_acl\": {\n            \"fields\": [],\n            \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n        }\n    },\n    \"campaign_id\": \"\",\n    \"campaign_name\": \"\",\n    \"campaign_accounts\": {\n        \"name\": \"\",\n        \"id\": \"\",\n        \"_acl\": {\n            \"fields\": [],\n            \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n        }\n    },\n    \"following\": true,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Unfavorite_a_Record/index.html"}
{"id": "14a02c6efd90-4", "text": "}\n    },\n    \"following\": true,\n    \"my_favorite\": false,\n    \"tag\": [],\n    \"assigned_user_id\": \"seed_sarah_id\",\n    \"assigned_user_name\": \"Sarah Smith\",\n    \"assigned_user_link\": {\n        \"full_name\": \"Sarah Smith\",\n        \"id\": \"seed_sarah_id\",\n        \"_acl\": {\n            \"fields\": [],\n            \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n        }\n    },\n    \"team_count\": \"\",\n    \"team_count_link\": {\n        \"team_count\": \"\",\n        \"id\": \"West\",\n        \"_acl\": {\n            \"fields\": [],\n            \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n        }\n    },\n    \"team_name\": [{\n        \"id\": \"East\",\n        \"name\": \"East\",\n        \"name_2\": \"\",\n        \"primary\": false\n    }, {\n        \"id\": 1,\n        \"name\": \"Global\",\n        \"name_2\": \"\",\n        \"primary\": false\n    }, {\n        \"id\": \"West\",\n        \"name\": \"West\",\n        \"name_2\": \"\",\n        \"primary\": true\n    }],\n    \"email\": [{\n        \"email_address\": \"hr.support.kid@example.info\",\n        \"invalid_email\": false,\n        \"opt_out\": false,\n        \"primary_address\": true,\n        \"reply_to_address\": false\n    }, {\n        \"email_address\": \"info.support.the@example.com\",\n        \"invalid_email\": false,\n        \"opt_out\": false,\n        \"primary_address\": false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Unfavorite_a_Record/index.html"}
{"id": "14a02c6efd90-5", "text": "\"opt_out\": false,\n        \"primary_address\": false,\n        \"reply_to_address\": false\n    }],\n    \"email1\": \"hr.support.kid@example.info\",\n    \"email2\": \"info.support.the@example.com\",\n    \"invalid_email\": false,\n    \"email_opt_out\": false,\n    \"email_addresses_non_primary\": \"\",\n    \"_acl\": {\n        \"fields\": {}\n    },\n    \"_module\": \"Accounts\"\n}\nDownload\nYou can download the full API example here.\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Unfavorite_a_Record/index.html"}
{"id": "2792dd08c8db-0", "text": "How to Use the Global Search\nOverview\nA PHP example\u00c2\u00a0demonstrating how to globally search for records\u00c2\u00a0using the REST v11 /search GET endpoint.\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\n<?php\n$instance_url = \"http://{site_url}/rest/v11\";\n$username = \"admin\";\n$password = \"password\";\n//Login - POST /oauth2/token\n$auth_url = $instance_url . \"/oauth2/token\";\n$oauth2_token_arguments = array(\n    \"grant_type\" => \"password\",\n    //client id - default is sugar. \n    //It is recommended to create your own in Admin > OAuth Keys\n    \"client_id\" => \"sugar\", \n    \"client_secret\" => \"\",\n    \"username\" => $username,\n    \"password\" => $password,\n    //platform type - default is base.\n    //It is recommend to change the platform to a custom name such as \"custom_api\" to avoid authentication conflicts.\n    \"platform\" => \"custom_api\" \n);\n$auth_request = curl_init($auth_url);\ncurl_setopt($auth_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($auth_request, CURLOPT_HEADER, false);\ncurl_setopt($auth_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($auth_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($auth_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($auth_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\"\n));\n//convert arguments to json\n$json_arguments = json_encode($oauth2_token_arguments);\ncurl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Use_the_Global_Search/index.html"}
{"id": "2792dd08c8db-1", "text": "curl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$oauth2_token_response = curl_exec($auth_request);\n//decode oauth2 response to get token\n$oauth2_token_response_obj = json_decode($oauth2_token_response);\n$oauth_token = $oauth2_token_response_obj->access_token;\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nSearching Records\nSo, we will need to identify the records we want to see using the /search endpoint. In this case, we are going to search for all records that have the email address of 'jsmith@sugar.com'.\u00c2\u00a0 In this example, there are 3 records, an Account, a Contact and a Lead.\n//Set up the search parameters - GET /search\n$search_url = $instance_url . \"/search\";\n$search_arguments = array(\n    \"q\" => 'jsmith@sugar.com',\n    \"max_num\" => 3,\n    \"offset\" => 0,\n    \"fields\" => \"\",\n    \"order_by\" => \"\",\n    \"favorites\" => false,\n    \"my_items\" => false,\n);\n//As this request is a GET we will add the arguments to the URL\n$search_url .= \"?\" . http_build_query($search_arguments);\n$search_request = curl_init($search_url);\ncurl_setopt($search_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($search_request, CURLOPT_HEADER, false);\ncurl_setopt($search_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($search_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($search_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($search_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Use_the_Global_Search/index.html"}
{"id": "2792dd08c8db-2", "text": "\"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//execute request\n$search_response = curl_exec($search_request);\n//decode json\n$search_response_obj = json_decode($search_response);\nMore information on the search API\u00c2\u00a0can be found in the /search documentation.\nRequest\nhttp://{site_url}/rest/v11/search?q=jsmith%40sugar.com&max_num=3&offset=0&fields=&order_by=&favorites=0&my_items=0\nResponse\nThe data received from the server is shown below:\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"f31b2f00-468c-3d35-1e88-56fedbd3921d\",\n         \"name\":\"Kaycee Gibney\",\n         \"date_entered\":\"2016-04-01T20:34:00+00:00\",\n         \"date_modified\":\"2016-04-06T15:16:24+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"user_favorites\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_jim_id\",\n         \"assigned_user_name\":\"Jim Brennan\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Use_the_Global_Search/index.html"}
{"id": "2792dd08c8db-3", "text": "\"email\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"sales.kid.dev@example.info\",\n               \"invalid_email\":false,\n               \"opt_out\":true,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"email1\":\"jsmith@sugar.com\",\n         \"email2\":\"sales.kid.dev@example.info\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"salutation\":\"\",\n         \"first_name\":\"Kaycee\",\n         \"last_name\":\"Gibney\",\n         \"full_name\":\"Kaycee Gibney\",\n         \"title\":\"Mgr Operations\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(599) 165-2396\",\n         \"phone_mobile\":\"(215) 591-9574\",\n         \"phone_work\":\"(771) 945-3648\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"primary_address_street\":\"321 University Ave.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Santa Monica\",\n         \"primary_address_state\":\"NY\",\n         \"primary_address_postalcode\":\"96154\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Use_the_Global_Search/index.html"}
{"id": "2792dd08c8db-4", "text": "\"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Existing Customer\",\n         \"account_name\":\"Tracker Com LP\",\n         \"account_id\":\"72ad6f00-e345-1cab-b370-56fedbd23deb\",\n         \"dnb_principal_id\":\"\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"birthdate\":\"\",\n         \"portal_name\":\"KayceeGibney33\",\n         \"portal_active\":true,\n         \"portal_password\":true,\n         \"portal_password1\":null,\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"accept_status_calls\":\"\",\n         \"accept_status_meetings\":\"\",\n         \"sync_contact\":false,\n         \"mkto_sync\":false,\n         \"mkto_id\":null,\n         \"mkto_lead_score\":null,\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Contacts\",\n         \"_search\":{\n            \"score\":0.70710677,\n            \"highlighted\":{\n               \"email1\":{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Use_the_Global_Search/index.html"}
{"id": "2792dd08c8db-5", "text": "\"highlighted\":{\n               \"email1\":{\n                  \"text\":\"\\u003Cstrong\\u003Ejsmith@sugar.com\\u003C\\/strong\\u003E\",\n                  \"module\":\"Contacts\",\n                  \"label\":\"LBL_EMAIL_ADDRESS\"\n               }\n            }\n         }\n      },\n      {\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"e8c641ca-1b8c-74c1-d08d-56fedbdd3187\",\n         \"name\":\"MTM Investment Bank F S B\",\n         \"date_entered\":\"2016-04-01T20:34:00+00:00\",\n         \"date_modified\":\"2016-04-06T15:16:52+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"user_favorites\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_will_id\",\n         \"assigned_user_name\":\"Will Westin\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":true\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":false\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Use_the_Global_Search/index.html"}
{"id": "2792dd08c8db-6", "text": "\"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"the60@example.us\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"email1\":\"jsmith@sugar.com\",\n         \"email2\":\"the60@example.us\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"account_type\":\"Customer\",\n         \"industry\":\"a\",\n         \"annual_revenue\":\"\",\n         \"phone_fax\":\"\",\n         \"billing_address_street\":\"67321 West Siam St.\",\n         \"billing_address_street_2\":\"\",\n         \"billing_address_street_3\":\"\",\n         \"billing_address_street_4\":\"\",\n         \"billing_address_city\":\"Alabama\",\n         \"billing_address_state\":\"NY\",\n         \"billing_address_postalcode\":\"52272\",\n         \"billing_address_country\":\"USA\",\n         \"rating\":\"\",\n         \"phone_office\":\"(012) 704-8075\",\n         \"phone_alternate\":\"\",\n         \"website\":\"www.salesqa.it\",\n         \"ownership\":\"\",\n         \"employees\":\"\",\n         \"ticker_symbol\":\"\",\n         \"shipping_address_street\":\"67321 West Siam St.\",\n         \"shipping_address_street_2\":\"\",\n         \"shipping_address_street_3\":\"\",\n         \"shipping_address_street_4\":\"\",\n         \"shipping_address_city\":\"Alabama\",\n         \"shipping_address_state\":\"NY\",\n         \"shipping_address_postalcode\":\"52272\",\n         \"shipping_address_country\":\"USA\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Use_the_Global_Search/index.html"}
{"id": "2792dd08c8db-7", "text": "\"shipping_address_country\":\"USA\",\n         \"parent_id\":\"\",\n         \"sic_code\":\"\",\n         \"duns_num\":\"\",\n         \"parent_name\":\"\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Accounts\",\n         \"_search\":{\n            \"score\":0.70710677,\n            \"highlighted\":{\n               \"email1\":{\n                  \"text\":\"\\u003Cstrong\\u003Ejsmith@sugar.com\\u003C\\/strong\\u003E\",\n                  \"module\":\"Accounts\",\n                  \"label\":\"LBL_EMAIL_ADDRESS\"\n               }\n            }\n         }\n      },\n      {\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"f3951f4d-2d17-7939-c5ec-56fedbb9e92f\",\n         \"name\":\"Talia Knupp\",\n         \"date_entered\":\"2016-04-01T20:34:00+00:00\",\n         \"date_modified\":\"2016-04-06T15:33:24+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"user_favorites\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_will_id\",\n         \"assigned_user_name\":\"Will Westin\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":true", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Use_the_Global_Search/index.html"}
{"id": "2792dd08c8db-8", "text": "\"name_2\":\"\",\n               \"primary\":true\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":false\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"cjsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"email1\":\"jsmith@sugar.com\",\n         \"email2\":\"cjsmith@sugar.com\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"salutation\":\"\",\n         \"first_name\":\"Talia\",\n         \"last_name\":\"Knupp\",\n         \"full_name\":\"Talia Knupp\",\n         \"title\":\"Senior Product Manager\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(963) 741-3689\",\n         \"phone_mobile\":\"(600) 831-9872\",\n         \"phone_work\":\"(680) 991-2837\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"primary_address_street\":\"111 Silicon Valley Road\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Sunnyvale\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Use_the_Global_Search/index.html"}
{"id": "2792dd08c8db-9", "text": "\"primary_address_city\":\"Sunnyvale\",\n         \"primary_address_state\":\"NY\",\n         \"primary_address_postalcode\":\"99452\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"converted\":false,\n         \"refered_by\":\"\",\n         \"lead_source\":\"Word of mouth\",\n         \"lead_source_description\":\"\",\n         \"status\":\"In Process\",\n         \"status_description\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"dnb_principal_id\":\"\",\n         \"account_name\":\"First National S\\/B\",\n         \"account_description\":\"\",\n         \"contact_id\":\"\",\n         \"contact_name\":\"\",\n         \"account_id\":\"\",\n         \"opportunity_id\":\"\",\n         \"opportunity_name\":\"\",\n         \"opportunity_amount\":\"\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"accept_status_calls\":\"\",\n         \"accept_status_meetings\":\"\",\n         \"webtolead_email1\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"cjsmith@sugar.com\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Use_the_Global_Search/index.html"}
{"id": "2792dd08c8db-10", "text": "},\n            {\n               \"email_address\":\"cjsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"webtolead_email2\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"cjsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"webtolead_email_opt_out\":\"\",\n         \"webtolead_invalid_email\":\"\",\n         \"birthdate\":\"\",\n         \"portal_name\":\"\",\n         \"portal_app\":\"\",\n         \"website\":\"\",\n         \"preferred_language\":\"\",\n         \"mkto_sync\":false,\n         \"mkto_id\":null,\n         \"mkto_lead_score\":null,\n         \"fruits_c\":\"Apples\",\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Leads\",\n         \"_search\":{\n            \"score\":0.70710677,\n            \"highlighted\":{\n               \"email1\":{\n                  \"text\":\"\\u003Cstrong\\u003Ejsmith@sugar.com\\u003C\\/strong\\u003E\",\n                  \"module\":\"Leads\",\n                  \"label\":\"LBL_EMAIL_ADDRESS\"\n               }\n            }\n         }\n      }\n   ]\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Use_the_Global_Search/index.html"}
{"id": "2792dd08c8db-11", "text": "}\n            }\n         }\n      }\n   ]\n}\nThere are 3 records shown above, the _module field tells you if the record is from Accounts, Contacts or Leads.\u00c2\u00a0 The _search field is an array that tells you where in the record it found the search string.\u00c2\u00a0 It gives you back a highlighted string that you can use for display.\nDownloads\nYou can download the full API example here\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Use_the_Global_Search/index.html"}
{"id": "6f506096f703-0", "text": "How to Manipulate Records (CRUD)\nOverview\nA PHP example\u00c2\u00a0demonstrating how to use the CRUD (Create, Read, Update, Delete) endpoints in the REST v11 API.\nCRUD Operations\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\n<?php\n$instance_url = \"http://{site_url}/rest/v11\";\n$username = \"admin\";\n$password = \"password\";\n//Login - POST /oauth2/token\n$auth_url = $instance_url . \"/oauth2/token\";\n$oauth2_token_arguments = array(\n    \"grant_type\" => \"password\",\n    //client id - default is sugar. \n    //It is recommended to create your own in Admin > OAuth Keys\n    \"client_id\" => \"sugar\", \n    \"client_secret\" => \"\",\n    \"username\" => $username,\n    \"password\" => $password,\n    //platform type - default is base.\n    //It is recommend to change the platform to a custom name such as \"custom_api\" to avoid authentication conflicts.\n    \"platform\" => \"custom_api\" \n);\n$auth_request = curl_init($auth_url);\ncurl_setopt($auth_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($auth_request, CURLOPT_HEADER, false);\ncurl_setopt($auth_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($auth_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($auth_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($auth_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\"\n));\n//convert arguments to json\n$json_arguments = json_encode($oauth2_token_arguments);\ncurl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "6f506096f703-1", "text": "curl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$oauth2_token_response = curl_exec($auth_request);\n//decode oauth2 response to get token\n$oauth2_token_response_obj = json_decode($oauth2_token_response);\n$oauth_token = $oauth2_token_response_obj->access_token;\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nCreating a Record\nNext, we need to submit the record to the Sugar instance\u00c2\u00a0using the /<module>\u00c2\u00a0endpoint. In this example\u00c2\u00a0we are going to create an Account record with a Name of 'Test Record' and an email of 'test@sugar.com'.\n//Create Records - POST /<module>\n$url = $instance_url . \"/Accounts\";\n//Set up the Record details\n$record = array(\n    'name' => 'Test Record',\n    'email' => array(\n        array(\n            'email_address' => 'test@sugar.com',\n            'primary_address' => true\n        )\n    ),\n);\n$curl_request = curl_init($url);\ncurl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($curl_request, CURLOPT_HEADER, false);\ncurl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($curl_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//convert arguments to json\n$json_arguments = json_encode($record);\ncurl_setopt($curl_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "6f506096f703-2", "text": "curl_setopt($curl_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$curl_response = curl_exec($curl_request);\n//decode json\n$createdRecord = json_decode($curl_response);\n//display the created record\nprint_r($createdRecord);\ncurl_close($curl_request);\nMore information on this API endpoint can be found in the /<module> - POST\u00c2\u00a0documentation.\nRequest Payload\nThe data sent to the server is shown below:\n{\n    \"name\": \"Test Record\",\n    \"email\": [{ \"email_address\": \"test@sugar.com\", \"primary_address\": true }]\n}\nResponse\nThe data received from the server is shown below:\n{\n    \"id\": \"ae78a068-7a0c-11e8-8b9e-6a0001bcacb0\",\n    \"name\": \"Test Record\",\n    \"date_entered\": \"2018-06-27T15:19:11+02:00\",\n    \"date_modified\": \"2018-06-27T15:19:11+02:00\",\n    \"modified_user_id\": \"1\",\n    \"modified_by_name\": \"Administrator\",\n    \"modified_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"created_by\": \"1\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "6f506096f703-3", "text": "}\n    },\n    \"created_by\": \"1\",\n    \"created_by_name\": \"Administrator\",\n    \"created_by_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"description\": \"\",\n    \"deleted\": false,\n    \"facebook\": \"\",\n    \"twitter\": \"\",\n    \"googleplus\": \"\",\n    \"account_type\": \"\",\n    \"industry\": \"\",\n    \"annual_revenue\": \"\",\n    \"phone_fax\": \"\",\n    \"billing_address_street\": \"\",\n    \"billing_address_street_2\": \"\",\n    \"billing_address_street_3\": \"\",\n    \"billing_address_street_4\": \"\",\n    \"billing_address_city\": \"\",\n    \"billing_address_state\": \"\",\n    \"billing_address_postalcode\": \"\",\n    \"billing_address_country\": \"\",\n    \"rating\": \"\",\n    \"phone_office\": \"\",\n    \"phone_alternate\": \"\",\n    \"website\": \"\",\n    \"ownership\": \"\",\n    \"employees\": \"\",\n    \"ticker_symbol\": \"\",\n    \"shipping_address_street\": \"\",\n    \"shipping_address_street_2\": \"\",\n    \"shipping_address_street_3\": \"\",\n    \"shipping_address_street_4\": \"\",\n    \"shipping_address_city\": \"\",\n    \"shipping_address_state\": \"\",\n    \"shipping_address_postalcode\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "6f506096f703-4", "text": "\"shipping_address_state\": \"\",\n    \"shipping_address_postalcode\": \"\",\n    \"shipping_address_country\": \"\",\n    \"parent_id\": \"\",\n    \"sic_code\": \"\",\n    \"duns_num\": \"\",\n    \"parent_name\": \"\",\n    \"member_of\": {\n        \"name\": \"\",\n        \"id\": \"\",\n        \"_acl\": { \"fields\": [], \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\" }\n    },\n    \"campaign_id\": \"\",\n    \"campaign_name\": \"\",\n    \"campaign_accounts\": {\n        \"name\": \"\",\n        \"id\": \"\",\n        \"_acl\": { \"fields\": [], \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\" }\n    },\n    \"following\": true,\n    \"my_favorite\": false,\n    \"tag\": [],\n    \"locked_fields\": [],\n    \"assigned_user_id\": \"\",\n    \"assigned_user_name\": \"\",\n    \"assigned_user_link\": {\n        \"full_name\": \"\",\n        \"id\": \"\",\n        \"_acl\": { \"fields\": [], \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\" }\n    },\n    \"team_count\": \"\",\n    \"team_count_link\": {\n        \"team_count\": \"\",\n        \"id\": \"1\",\n        \"_acl\": { \"fields\": [], \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\" }\n    },\n    \"team_name\": [\n        {\n            \"id\": \"1\",\n            \"name\": \"Global\",\n            \"name_2\": \"\",\n            \"primary\": true,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "6f506096f703-5", "text": "\"name_2\": \"\",\n            \"primary\": true,\n            \"selected\": false\n        }\n    ],\n    \"email\": [\n        {\n            \"email_address\": \"test@sugar.com\",\n            \"invalid_email\": false,\n            \"opt_out\": false,\n            \"email_address_id\": \"85125194-7a0a-11e8-9c17-6a0001bcacb0\",\n            \"primary_address\": true,\n            \"reply_to_address\": false\n        }\n    ],\n    \"email1\": \"test@sugar.com\",\n    \"email2\": \"\",\n    \"invalid_email\": false,\n    \"email_opt_out\": false,\n    \"email_addresses_non_primary\": \"\",\n    \"test_c\": \"\",\n    \"dri_workflow_template_id\": \"\",\n    \"dri_workflow_template_name\": \"\",\n    \"dri_workflow_template_link\": {\n        \"name\": \"\",\n        \"id\": \"\",\n        \"_acl\": { \"fields\": [], \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\" }\n    },\n    \"_acl\": { \"fields\": {} },\n    \"_module\": \"Accounts\"\n}\nGetting a Record\nNext, we can\u00c2\u00a0get the created record from\u00c2\u00a0the Sugar instance\u00c2\u00a0using the /<module>/:record\u00c2\u00a0endpoint. In this example,\u00c2\u00a0we are going to get\u00c2\u00a0an Account record by it's ID, but only request the Name, Email, and Industry fields.\n$id = $createdRecord->id;\n//Get Record - GET //:record\n$url = $instance_url . \"/Accounts/$id\";\n//Setup request to only return some fields on module\n$data = array(\n    'fields' => 'name,email1,industry'", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "6f506096f703-6", "text": "$data = array(\n    'fields' => 'name,email1,industry'\n);\n//Add data to the URL\n$url = $url.\"?\".http_build_query($data);\n$curl_request = curl_init($url);\ncurl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($curl_request, CURLOPT_HEADER, false);\ncurl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($curl_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//execute request\n$curl_response = curl_exec($curl_request);\n//decode json\n$record = json_decode($curl_response);\n//display the created record\nprint_r($record);\ncurl_close($curl_request);\nUpdating a Record\nNext, we can\u00c2\u00a0update \u00c2\u00a0the record in\u00c2\u00a0the Sugar instance\u00c2\u00a0using the /<module>/:record\u00c2\u00a0endpoint, and the PUT Http method. In this example,\u00c2\u00a0we are going to update the\u00c2\u00a0Account record and change it's name to \"Updated Test Record\".\n$id = $record->id;\n//Update Record - PUT /<module>/:record\n$url = $instance_url . \"/Accounts/$id\";\n//Set up the Record details\n$record->name = 'Updated Test Record';\n$curl_request = curl_init($url);\ncurl_setopt($curl_request, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($curl_request, CURLOPT_HEADER, false);\ncurl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "6f506096f703-7", "text": "curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($curl_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//convert arguments to json\n$json_arguments = json_encode($record);\ncurl_setopt($curl_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$curl_response = curl_exec($curl_request);\n//decode json\n$updatedRecord = json_decode($curl_response);\n//display the created record\necho \"Updated Record Name:\".$updatedRecord->name;\ncurl_close($curl_request);\nMore information on this API endpoint can be found in the /<module>/:record - PUT\u00c2\u00a0documentation.\nRequest Payload\nThe URL\u00c2\u00a0sent to the server is shown below:\n{\"name\":\"Updated Test Record\"}\nResponse\nThe data received from the server is shown below:\n{\n    \"id\": \"ae78a068-7a0c-11e8-8b9e-6a0001bcacb0\",\n    \"name\": \"Updated Test Record\",\n    \"date_entered\": \"2018-06-27T15:19:11+02:00\",\n    \"date_modified\": \"2018-06-27T15:23:19+02:00\",\n    \"modified_user_id\": \"1\",\n    \"modified_by_name\": \"Administrator\",\n    \"modified_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "6f506096f703-8", "text": "\"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"created_by\": \"1\",\n    \"created_by_name\": \"Administrator\",\n    \"created_by_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"description\": \"\",\n    \"deleted\": false,\n    \"facebook\": \"\",\n    \"twitter\": \"\",\n    \"googleplus\": \"\",\n    \"account_type\": \"\",\n    \"industry\": \"\",\n    \"annual_revenue\": \"\",\n    \"phone_fax\": \"\",\n    \"billing_address_street\": \"\",\n    \"billing_address_street_2\": \"\",\n    \"billing_address_street_3\": \"\",\n    \"billing_address_street_4\": \"\",\n    \"billing_address_city\": \"\",\n    \"billing_address_state\": \"\",\n    \"billing_address_postalcode\": \"\",\n    \"billing_address_country\": \"\",\n    \"rating\": \"\",\n    \"phone_office\": \"\",\n    \"phone_alternate\": \"\",\n    \"website\": \"\",\n    \"ownership\": \"\",\n    \"employees\": \"\",\n    \"ticker_symbol\": \"\",\n    \"shipping_address_street\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "6f506096f703-9", "text": "\"ticker_symbol\": \"\",\n    \"shipping_address_street\": \"\",\n    \"shipping_address_street_2\": \"\",\n    \"shipping_address_street_3\": \"\",\n    \"shipping_address_street_4\": \"\",\n    \"shipping_address_city\": \"\",\n    \"shipping_address_state\": \"\",\n    \"shipping_address_postalcode\": \"\",\n    \"shipping_address_country\": \"\",\n    \"parent_id\": \"\",\n    \"sic_code\": \"\",\n    \"duns_num\": \"\",\n    \"parent_name\": \"\",\n    \"member_of\": {\n        \"name\": \"\",\n        \"id\": \"\",\n        \"_acl\": { \"fields\": [], \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\" }\n    },\n    \"campaign_id\": \"\",\n    \"campaign_name\": \"\",\n    \"campaign_accounts\": {\n        \"name\": \"\",\n        \"id\": \"\",\n        \"_acl\": { \"fields\": [], \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\" }\n    },\n    \"following\": true,\n    \"my_favorite\": false,\n    \"tag\": [],\n    \"locked_fields\": [],\n    \"assigned_user_id\": \"\",\n    \"assigned_user_name\": \"\",\n    \"assigned_user_link\": {\n        \"full_name\": \"\",\n        \"id\": \"\",\n        \"_acl\": { \"fields\": [], \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\" }\n    },\n    \"team_count\": \"\",\n    \"team_count_link\": {\n        \"team_count\": \"\",\n        \"id\": \"1\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "6f506096f703-10", "text": "\"team_count\": \"\",\n        \"id\": \"1\",\n        \"_acl\": { \"fields\": [], \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\" }\n    },\n    \"team_name\": [\n        {\n            \"id\": \"1\",\n            \"name\": \"Global\",\n            \"name_2\": \"\",\n            \"primary\": true,\n            \"selected\": false\n        }\n    ],\n    \"email\": [\n        {\n            \"email_address\": \"test@sugar.com\",\n            \"invalid_email\": false,\n            \"opt_out\": false,\n            \"email_address_id\": \"85125194-7a0a-11e8-9c17-6a0001bcacb0\",\n            \"primary_address\": true,\n            \"reply_to_address\": false\n        }\n    ],\n    \"email1\": \"test@sugar.com\",\n    \"email2\": \"\",\n    \"invalid_email\": false,\n    \"email_opt_out\": false,\n    \"email_addresses_non_primary\": \"\",\n    \"test_c\": \"\",\n    \"dri_workflow_template_id\": \"\",\n    \"dri_workflow_template_name\": \"\",\n    \"dri_workflow_template_link\": {\n        \"name\": \"\",\n        \"id\": \"\",\n        \"_acl\": { \"fields\": [], \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\" }\n    },\n    \"_acl\": { \"fields\": {} },\n    \"_module\": \"Accounts\"\n}\nDeleting a Record\nNext, we can delete\u00c2\u00a0the record from\u00c2\u00a0the Sugar instance\u00c2\u00a0using the /<module>/:record\u00c2\u00a0endpoint, by using the DELETE Http Method.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "6f506096f703-11", "text": "$id = $updatedRecord->id;\n//Delete Record - DELETE /<module>/:record\n$url = $instance_url . \"/Accounts/$id\";\n$curl_request = curl_init($url);\ncurl_setopt($curl_request, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($curl_request, CURLOPT_HEADER, false);\ncurl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($curl_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//execute request\n$curl_response = curl_exec($curl_request);\n//decode json\n$deletedRecord = json_decode($curl_response);\n//display the created record\necho \"Deleted Record:\".$deletedRecord->id;\ncurl_close($curl_request);\nMore information on this API endpoint can be found in the /<module>/:record - DELETE\u00c2\u00a0documentation.\nRequest Payload\nThe URL\u00c2\u00a0sent to the server is shown below:\nNo payload is sent for this request.\nResponse\nThe data received from the server is shown below:\n{\"id\":\"ae78a068-7a0c-11e8-8b9e-6a0001bcacb0\"}\nDownload\nYou can download the full API example here.\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "37567405c6cd-0", "text": "How to Favorite a Record\nOverview\nA PHP example\u00c2\u00a0demonstrating how to favorite a record using the v11 <module>/:record/favorite REST PUT API endpoint.\nFavoriting a Record\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\n<?php\n$instance_url = \"http://{site_url}/rest/v11\";\n$username = \"admin\";\n$password = \"password\";\n//Login - POST /oauth2/token\n$auth_url = $instance_url . \"/oauth2/token\";\n$oauth2_token_arguments = array(\n    \"grant_type\" => \"password\",\n    //client id - default is sugar. \n    //It is recommended to create your own in Admin > OAuth Keys\n    \"client_id\" => \"sugar\", \n    \"client_secret\" => \"\",\n    \"username\" => $username,\n    \"password\" => $password,\n    //platform type - default is base.\n    //It is recommend to change the platform to a custom name such as \"custom_api\" to avoid authentication conflicts.\n    \"platform\" => \"custom_api\" \n);\n$auth_request = curl_init($auth_url);\ncurl_setopt($auth_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($auth_request, CURLOPT_HEADER, false);\ncurl_setopt($auth_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($auth_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($auth_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($auth_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\"\n));\n//convert arguments to json\n$json_arguments = json_encode($oauth2_token_arguments);\ncurl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Favorite_a_Record/index.html"}
{"id": "37567405c6cd-1", "text": "curl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$oauth2_token_response = curl_exec($auth_request);\n//decode oauth2 response to get token\n$oauth2_token_response_obj = json_decode($oauth2_token_response);\n$oauth_token = $oauth2_token_response_obj->access_token;\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nFavoriting a Record\nNext, we can favorite\u00c2\u00a0a specific record\u00c2\u00a0using the /<module>/:record/favorite\u00c2\u00a0endpoint.\n//Favorite record - PUT //:record/favorite\n$favorite_url = $instance_url . \"/Accounts/ae8b1783-404a-fcb8-1e1e-56f1cc52cd1a/favorite\";\n$favorite_request = curl_init($favorite_url);\ncurl_setopt($favorite_request, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_setopt($favorite_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($favorite_request, CURLOPT_HEADER, false);\ncurl_setopt($favorite_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($favorite_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($favorite_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($favorite_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//execute request\n$favorite_response = curl_exec($favorite_request);\nMore information on theunfavorite API\u00c2\u00a0can be found in the /<module>/:record/favorite PUT\u00c2\u00a0documentation.\nRequest Payload\nThe data sent to the server is shown below:\nThis endpoint does not accept any request arguments.\nResponse\nThe data received from the server is shown below:\n{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Favorite_a_Record/index.html"}
{"id": "37567405c6cd-2", "text": "Response\nThe data received from the server is shown below:\n{\n    \"id\": \"ae8b1783-404a-fcb8-1e1e-56f1cc52cd1a\",\n    \"name\": \"Union Bank\",\n    \"date_entered\": \"2016-03-22T17:49:50-05:00\",\n    \"date_modified\": \"2016-03-30T17:44:20-05:00\",\n    \"modified_user_id\": \"1\",\n    \"modified_by_name\": \"Administrator\",\n    \"modified_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": [],\n            \"delete\": \"no\",\n            \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n        }\n    },\n    \"created_by\": \"1\",\n    \"created_by_name\": \"Administrator\",\n    \"created_by_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": [],\n            \"delete\": \"no\",\n            \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n        }\n    },\n    \"description\": \"\",\n    \"deleted\": false,\n    \"facebook\": \"\",\n    \"twitter\": \"\",\n    \"googleplus\": \"\",\n    \"account_type\": \"Customer\",\n    \"industry\": \"Banking\",\n    \"annual_revenue\": \"\",\n    \"phone_fax\": \"\",\n    \"billing_address_street\": \"67321 West Siam St.\",\n    \"billing_address_street_2\": \"\",\n    \"billing_address_street_3\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Favorite_a_Record/index.html"}
{"id": "37567405c6cd-3", "text": "\"billing_address_street_2\": \"\",\n    \"billing_address_street_3\": \"\",\n    \"billing_address_street_4\": \"\",\n    \"billing_address_city\": \"Ohio\",\n    \"billing_address_state\": \"CA\",\n    \"billing_address_postalcode\": \"25159\",\n    \"billing_address_country\": \"USA\",\n    \"rating\": \"\",\n    \"phone_office\": \"(065) 489-6104\",\n    \"phone_alternate\": \"\",\n    \"website\": \"www.qahr.edu\",\n    \"ownership\": \"\",\n    \"employees\": \"\",\n    \"ticker_symbol\": \"\",\n    \"shipping_address_street\": \"67321 West Siam St.\",\n    \"shipping_address_street_2\": \"\",\n    \"shipping_address_street_3\": \"\",\n    \"shipping_address_street_4\": \"\",\n    \"shipping_address_city\": \"Ohio\",\n    \"shipping_address_state\": \"CA\",\n    \"shipping_address_postalcode\": \"25159\",\n    \"shipping_address_country\": \"USA\",\n    \"parent_id\": \"\",\n    \"sic_code\": \"\",\n    \"duns_num\": \"\",\n    \"parent_name\": \"\",\n    \"member_of\": {\n        \"name\": \"\",\n        \"id\": \"\",\n        \"_acl\": {\n            \"fields\": [],\n            \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n        }\n    },\n    \"campaign_id\": \"\",\n    \"campaign_name\": \"\",\n    \"campaign_accounts\": {\n        \"name\": \"\",\n        \"id\": \"\",\n        \"_acl\": {\n            \"fields\": [],\n            \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n        }\n    },\n    \"following\": true,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Favorite_a_Record/index.html"}
{"id": "37567405c6cd-4", "text": "}\n    },\n    \"following\": true,\n    \"my_favorite\": true,\n    \"tag\": [],\n    \"assigned_user_id\": \"seed_sarah_id\",\n    \"assigned_user_name\": \"Sarah Smith\",\n    \"assigned_user_link\": {\n        \"full_name\": \"Sarah Smith\",\n        \"id\": \"seed_sarah_id\",\n        \"_acl\": {\n            \"fields\": [],\n            \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n        }\n    },\n    \"team_count\": \"\",\n    \"team_count_link\": {\n        \"team_count\": \"\",\n        \"id\": \"West\",\n        \"_acl\": {\n            \"fields\": [],\n            \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n        }\n    },\n    \"team_name\": [{\n        \"id\": \"East\",\n        \"name\": \"East\",\n        \"name_2\": \"\",\n        \"primary\": false\n    }, {\n        \"id\": 1,\n        \"name\": \"Global\",\n        \"name_2\": \"\",\n        \"primary\": false\n    }, {\n        \"id\": \"West\",\n        \"name\": \"West\",\n        \"name_2\": \"\",\n        \"primary\": true\n    }],\n    \"email\": [{\n        \"email_address\": \"hr.support.kid@example.info\",\n        \"invalid_email\": false,\n        \"opt_out\": false,\n        \"primary_address\": true,\n        \"reply_to_address\": false\n    }, {\n        \"email_address\": \"info.support.the@example.com\",\n        \"invalid_email\": false,\n        \"opt_out\": false,\n        \"primary_address\": false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Favorite_a_Record/index.html"}
{"id": "37567405c6cd-5", "text": "\"opt_out\": false,\n        \"primary_address\": false,\n        \"reply_to_address\": false\n    }],\n    \"email1\": \"hr.support.kid@example.info\",\n    \"email2\": \"info.support.the@example.com\",\n    \"invalid_email\": false,\n    \"email_opt_out\": false,\n    \"email_addresses_non_primary\": \"\",\n    \"_acl\": {\n        \"fields\": {}\n    },\n    \"_module\": \"Accounts\"\n}\nDownload\nYou can download the full API example here.\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Favorite_a_Record/index.html"}
{"id": "c96812c094f3-0", "text": "How to Follow a Record\nOverview\nA PHP example demonstrating how to\u00c2\u00a0follow a record using the v11 /<module>/:record/subscribe REST POST\u00c2\u00a0endpoint.\nFollowing a Record\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\n<?php\n$instance_url = \"http://{site_url}/rest/v11\";\n$username = \"admin\";\n$password = \"password\";\n//Login - POST /oauth2/token\n$auth_url = $instance_url . \"/oauth2/token\";\n$oauth2_token_arguments = array(\n    \"grant_type\" => \"password\",\n    //client id - default is sugar. \n    //It is recommended to create your own in Admin > OAuth Keys\n    \"client_id\" => \"sugar\", \n    \"client_secret\" => \"\",\n    \"username\" => $username,\n    \"password\" => $password,\n    //platform type - default is base.\n    //It is recommend to change the platform to a custom name such as \"custom_api\" to avoid authentication conflicts.\n    \"platform\" => \"custom_api\" \n);\n$auth_request = curl_init($auth_url);\ncurl_setopt($auth_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($auth_request, CURLOPT_HEADER, false);\ncurl_setopt($auth_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($auth_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($auth_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($auth_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\"\n));\n//convert arguments to json\n$json_arguments = json_encode($oauth2_token_arguments);\ncurl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Follow_a_Record/index.html"}
{"id": "c96812c094f3-1", "text": "curl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$oauth2_token_response = curl_exec($auth_request);\n//decode oauth2 response to get token\n$oauth2_token_response_obj = json_decode($oauth2_token_response);\n$oauth_token = $oauth2_token_response_obj->access_token;\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nFollowing a Record\nNext, we can follow a specific record\u00c2\u00a0using the /<module>/:record/subscribe\u00c2\u00a0endpoint.\n//Subscribe to record - POST //:record/subscribe\n$subscribe_url = $instance_url . \"/Accounts/ae8b1783-404a-fcb8-1e1e-56f1cc52cd1a/subscribe\";\n$subscribe_request = curl_init($subscribe_url);\ncurl_setopt($subscribe_request, CURLOPT_POST, 1);\ncurl_setopt($subscribe_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($subscribe_request, CURLOPT_HEADER, false);\ncurl_setopt($subscribe_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($subscribe_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($subscribe_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($subscribe_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//execute request\n$subscribe_response = curl_exec($subscribe_request);\nMore information on the subscribe API\u00c2\u00a0can be found in the /<module>/:record/subscribe POST\u00c2\u00a0documentation.\nRequest Payload\nThe data sent to the server is shown below:\nThis endpoint does not accept any request arguments.\nResponse\nThe data received from the server is shown below:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Follow_a_Record/index.html"}
{"id": "c96812c094f3-2", "text": "Response\nThe data received from the server is shown below:\n\"58f96315-9e75-6562-42e9-5705917d2cdc\"\nDownload\nYou can download the full API example here.\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Follow_a_Record/index.html"}
{"id": "cdbc86e7b62e-0", "text": "How to Filter a List of Records\nOverview\nA PHP example\u00c2\u00a0demonstrating how to filter records\u00c2\u00a0using the v11 /<module>/filter REST POST endpoints.\nFiltering Records\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\n<?php\n$instance_url = \"http://{site_url}/rest/v11\";\n$username = \"admin\";\n$password = \"password\";\n//Login - POST /oauth2/token\n$auth_url = $instance_url . \"/oauth2/token\";\n$oauth2_token_arguments = array(\n    \"grant_type\" => \"password\",\n    //client id - default is sugar. \n    //It is recommended to create your own in Admin > OAuth Keys\n    \"client_id\" => \"sugar\", \n    \"client_secret\" => \"\",\n    \"username\" => $username,\n    \"password\" => $password,\n    //platform type - default is base.\n    //It is recommend to change the platform to a custom name such as \"custom_api\" to avoid authentication conflicts.\n    \"platform\" => \"custom_api\" \n);\n$auth_request = curl_init($auth_url);\ncurl_setopt($auth_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($auth_request, CURLOPT_HEADER, false);\ncurl_setopt($auth_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($auth_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($auth_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($auth_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\"\n));\n//convert arguments to json\n$json_arguments = json_encode($oauth2_token_arguments);\ncurl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Filter_a_List_of_Records/index.html"}
{"id": "cdbc86e7b62e-1", "text": "curl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$oauth2_token_response = curl_exec($auth_request);\n//decode oauth2 response to get token\n$oauth2_token_response_obj = json_decode($oauth2_token_response);\n$oauth_token = $oauth2_token_response_obj->access_token;\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nFiltering Records\nNext, we can\u00c2\u00a0filter\u00c2\u00a0the records we want to return\u00c2\u00a0using the /<module>/filter\u00c2\u00a0endpoint with a POST request.\n//Identify records to export - POST /<module>/filter\n$filter_url = $instance_url . \"/Accounts/filter\";\n$filter_arguments = array(\n    \"filter\" => array(\n        array(\n            '$or' => array(\n                array(\n                    //name starts with 'a'\n                    \"name\" => array(\n                        '$starts'=>\"A\",\n                    )\n                ),\n                array(\n                    //name starts with 'b'\n                    \"name\" => array(\n                        '$starts'=>\"b\",\n                    )\n                )\n            ),\n        ),\n    ),\n    \"max_num\" => 2,\n    \"offset\" => 0,\n    \"fields\" => \"id\",\n    \"order_by\" => \"date_entered\",\n    \"favorites\" => false,\n    \"my_items\" => false,\n);\n$filter_request = curl_init($filter_url);\ncurl_setopt($filter_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($filter_request, CURLOPT_HEADER, false);\ncurl_setopt($filter_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($filter_request, CURLOPT_RETURNTRANSFER, 1);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Filter_a_List_of_Records/index.html"}
{"id": "cdbc86e7b62e-2", "text": "curl_setopt($filter_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($filter_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($filter_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//convert arguments to json\n$json_arguments = json_encode($filter_arguments);\ncurl_setopt($filter_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$filter_response = curl_exec($filter_request);\n//decode json\n$filter_response_obj = json_decode($filter_response);\nMore information on the filter API\u00c2\u00a0can be found in the /<module>/filter documentation.\nNote : The\u00c2\u00a0/<module>/filter endpoint can be called using a GET request as well, though long URL requests can have issues so the POST request is recommended.\u00c2\u00a0\nRequest Payload\nThe data sent to the server is shown below:\n{  \n   \"filter\":[  \n      {  \n         \"$or\":[  \n            {  \n               \"name\":{  \n                  \"$starts\":\"A\"\n               }\n            },\n            {  \n               \"name\":{  \n                  \"$starts\":\"b\"\n               }\n            }\n         ]\n      }\n   ],\n   \"max_num\":2,\n   \"offset\":0,\n   \"fields\":\"id\",\n   \"order_by\":\"date_entered\",\n   \"favorites\":false,\n   \"my_items\":false\n}\nResponse\nThe data received from the server is shown below:\n{  \n   \"next_offset\":2,\n   \"records\":[  \n      {  \n         \"id\":\"f16760a4-3a52-f77d-1522-5703ca28925f\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Filter_a_List_of_Records/index.html"}
{"id": "cdbc86e7b62e-3", "text": "\"date_modified\":\"2016-04-05T10:23:28-04:00\",\n         \"_acl\":{  \n            \"fields\":{  \n            }\n         },\n         \"_module\":\"Accounts\"\n      },\n      {  \n         \"id\":\"ec409fbb-2b22-4f32-7fa1-5703caf78dc3\",\n         \"date_modified\":\"2016-04-05T10:23:28-04:00\",\n         \"_acl\":{  \n            \"fields\":{  \n            }\n         },\n         \"_module\":\"Accounts\"\n      }\n   ]\n}\nDownload\nYou can download the full API example using POST\u00c2\u00a0here\u00c2\u00a0and using GET here.\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Filter_a_List_of_Records/index.html"}
{"id": "46418eb08c53-0", "text": "How to Ping\nOverview\nA PHP example\u00c2\u00a0demonstrating how to ping\u00c2\u00a0using the REST v11 /ping GET\u00c2\u00a0endpoint.\nPinging\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\n<?php\n$instance_url = \"http://{site_url}/rest/v11\";\n$username = \"admin\";\n$password = \"password\";\n//Login - POST /oauth2/token\n$auth_url = $instance_url . \"/oauth2/token\";\n$oauth2_token_arguments = array(\n    \"grant_type\" => \"password\",\n    //client id - default is sugar. \n    //It is recommended to create your own in Admin > OAuth Keys\n    \"client_id\" => \"sugar\", \n    \"client_secret\" => \"\",\n    \"username\" => $username,\n    \"password\" => $password,\n    //platform type - default is base.\n    //It is recommend to change the platform to a custom name such as \"custom_api\" to avoid authentication conflicts.\n    \"platform\" => \"custom_api\" \n);\n$auth_request = curl_init($auth_url);\ncurl_setopt($auth_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($auth_request, CURLOPT_HEADER, false);\ncurl_setopt($auth_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($auth_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($auth_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($auth_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\"\n));\n//convert arguments to json\n$json_arguments = json_encode($oauth2_token_arguments);\ncurl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$oauth2_token_response = curl_exec($auth_request);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Ping/index.html"}
{"id": "46418eb08c53-1", "text": "//execute request\n$oauth2_token_response = curl_exec($auth_request);\n//decode oauth2 response to get token\n$oauth2_token_response_obj = json_decode($oauth2_token_response);\n$oauth_token = $oauth2_token_response_obj->access_token;\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nPinging\nOnce we have authenticated, we can now ping the system as shown below.\n//Ping - GET /ping \n$ping_url = $instance_url . \"/ping\";\n$ping_request = curl_init($ping_url);\ncurl_setopt($ping_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($ping_request, CURLOPT_HEADER, false); //needed to return file headers\ncurl_setopt($ping_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($ping_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($ping_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($ping_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n$ping_response = curl_exec($ping_request);\nMore information on pinging\u00c2\u00a0can be found in the /ping\u00c2\u00a0documentation.\nResponse\n\"pong\"\nDownload\nYou can download the full API example here.\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Ping/index.html"}
{"id": "d392f943d990-0", "text": "How to Fetch Recently Viewed Records\nOverview\nA PHP example\u00c2\u00a0demonstrating how to retrieve recently viewed records\u00c2\u00a0using the v11 /recent REST GET endpoint.\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\n<?php\n$instance_url = \"http://{site_url}/rest/v11\";\n$username = \"admin\";\n$password = \"password\";\n//Login - POST /oauth2/token\n$auth_url = $instance_url . \"/oauth2/token\";\n$oauth2_token_arguments = array(\n    \"grant_type\" => \"password\",\n    //client id - default is sugar. \n    //It is recommended to create your own in Admin > OAuth Keys\n    \"client_id\" => \"sugar\", \n    \"client_secret\" => \"\",\n    \"username\" => $username,\n    \"password\" => $password,\n    //platform type - default is base.\n    //It is recommend to change the platform to a custom name such as \"custom_api\" to avoid authentication conflicts.\n    \"platform\" => \"custom_api\" \n);\n$auth_request = curl_init($auth_url);\ncurl_setopt($auth_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($auth_request, CURLOPT_HEADER, false);\ncurl_setopt($auth_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($auth_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($auth_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($auth_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\"\n));\n//convert arguments to json\n$json_arguments = json_encode($oauth2_token_arguments);\ncurl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "d392f943d990-1", "text": "curl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$oauth2_token_response = curl_exec($auth_request);\n//decode oauth2 response to get token\n$oauth2_token_response_obj = json_decode($oauth2_token_response);\n$oauth_token = $oauth2_token_response_obj->access_token;\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\u00c2\u00a0\nRecently Viewed Records\nNext, we will need to identify the records we want to see using the /recent endpoint. In this case, we are going to request Accounts, Contacts and Leads.\n//Set up the search parameters - GET /recent\n$recent_url = $instance_url . \"/recent\";\n$recent_arguments = array(\n    \"module_list\" => 'Accounts,Contacts,Leads',\n);\n//As this request is a GET we will add the arguments to the URL\n$recent_url .= \"?\" . http_build_query($recent_arguments);\n$recent_request = curl_init($recent_url);\ncurl_setopt($recent_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($recent_request, CURLOPT_HEADER, false);\ncurl_setopt($recent_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($recent_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($recent_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($recent_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//execute request\n$recent_response = curl_exec($recent_request);\n//decode json\n$recent_response_obj = json_decode($recent_response);\nMore information on the search API\u00c2\u00a0can be found in the /recent documentation.\nRequest", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "d392f943d990-2", "text": "More information on the search API\u00c2\u00a0can be found in the /recent documentation.\nRequest\nhttp://{site_url}/rest/v11/recent?module_list=Accounts%2CContacts%2CLeads\nResponse\nThe data received from the server is shown below:\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"f3951f4d-2d17-7939-c5ec-56fedbb9e92f\",\n         \"name\":\"Talia Knupp\",\n         \"date_entered\":\"2016-04-01T15:34:00-05:00\",\n         \"date_modified\":\"2016-04-06T10:33:24-05:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"user_favorites\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_will_id\",\n         \"assigned_user_name\":\"Will Westin\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":true\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":false\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "d392f943d990-3", "text": "\"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"cjsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"email1\":\"jsmith@sugar.com\",\n         \"email2\":\"cjsmith@sugar.com\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"salutation\":\"\",\n         \"first_name\":\"Talia\",\n         \"last_name\":\"Knupp\",\n         \"full_name\":\"Talia Knupp\",\n         \"title\":\"Senior Product Manager\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(963) 741-3689\",\n         \"phone_mobile\":\"(600) 831-9872\",\n         \"phone_work\":\"(680) 991-2837\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"primary_address_street\":\"111 Silicon Valley Road\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Sunnyvale\",\n         \"primary_address_state\":\"NY\",\n         \"primary_address_postalcode\":\"99452\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "d392f943d990-4", "text": "\"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"converted\":false,\n         \"refered_by\":\"\",\n         \"lead_source\":\"Word of mouth\",\n         \"lead_source_description\":\"\",\n         \"status\":\"In Process\",\n         \"status_description\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"dnb_principal_id\":\"\",\n         \"account_name\":\"First National S\\/B\",\n         \"account_description\":\"\",\n         \"contact_id\":\"\",\n         \"contact_name\":\"\",\n         \"account_id\":\"\",\n         \"opportunity_id\":\"\",\n         \"opportunity_name\":\"\",\n         \"opportunity_amount\":\"\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"accept_status_calls\":\"\",\n         \"accept_status_meetings\":\"\",\n         \"webtolead_email1\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"cjsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"webtolead_email2\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "d392f943d990-5", "text": "\"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"cjsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"webtolead_email_opt_out\":\"\",\n         \"webtolead_invalid_email\":\"\",\n         \"birthdate\":\"\",\n         \"portal_name\":\"\",\n         \"portal_app\":\"\",\n         \"website\":\"\",\n         \"preferred_language\":\"\",\n         \"mkto_sync\":false,\n         \"mkto_id\":null,\n         \"mkto_lead_score\":null,\n         \"fruits_c\":\"Apples\",\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Leads\",\n         \"_last_viewed_date\":\"2016-04-06T10:33:24-05:00\"\n      },\n      {\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"e8c641ca-1b8c-74c1-d08d-56fedbdd3187\",\n         \"name\":\"MTM Investment Bank F S B\",\n         \"date_entered\":\"2016-04-01T15:34:00-05:00\",\n         \"date_modified\":\"2016-04-06T10:16:52-05:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"user_favorites\":\"\",\n         \"description\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "d392f943d990-6", "text": "\"user_favorites\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_will_id\",\n         \"assigned_user_name\":\"Will Westin\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":true\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":false\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"the60@example.us\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"email1\":\"jsmith@sugar.com\",\n         \"email2\":\"the60@example.us\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"account_type\":\"Customer\",\n         \"industry\":\"a\",\n         \"annual_revenue\":\"\",\n         \"phone_fax\":\"\",\n         \"billing_address_street\":\"67321 West Siam St.\",\n         \"billing_address_street_2\":\"\",\n         \"billing_address_street_3\":\"\",\n         \"billing_address_street_4\":\"\",\n         \"billing_address_city\":\"Alabama\",\n         \"billing_address_state\":\"NY\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "d392f943d990-7", "text": "\"billing_address_city\":\"Alabama\",\n         \"billing_address_state\":\"NY\",\n         \"billing_address_postalcode\":\"52272\",\n         \"billing_address_country\":\"USA\",\n         \"rating\":\"\",\n         \"phone_office\":\"(012) 704-8075\",\n         \"phone_alternate\":\"\",\n         \"website\":\"www.salesqa.it\",\n         \"ownership\":\"\",\n         \"employees\":\"\",\n         \"ticker_symbol\":\"\",\n         \"shipping_address_street\":\"67321 West Siam St.\",\n         \"shipping_address_street_2\":\"\",\n         \"shipping_address_street_3\":\"\",\n         \"shipping_address_street_4\":\"\",\n         \"shipping_address_city\":\"Alabama\",\n         \"shipping_address_state\":\"NY\",\n         \"shipping_address_postalcode\":\"52272\",\n         \"shipping_address_country\":\"USA\",\n         \"parent_id\":\"\",\n         \"sic_code\":\"\",\n         \"duns_num\":\"\",\n         \"parent_name\":\"\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Accounts\",\n         \"_last_viewed_date\":\"2016-04-06T10:16:52-05:00\"\n      },\n      {\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"f31b2f00-468c-3d35-1e88-56fedbd3921d\",\n         \"name\":\"Kaycee Gibney\",\n         \"date_entered\":\"2016-04-01T15:34:00-05:00\",\n         \"date_modified\":\"2016-04-06T10:16:24-05:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "d392f943d990-8", "text": "\"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"user_favorites\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_jim_id\",\n         \"assigned_user_name\":\"Jim Brennan\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"sales.kid.dev@example.info\",\n               \"invalid_email\":false,\n               \"opt_out\":true,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"email1\":\"jsmith@sugar.com\",\n         \"email2\":\"sales.kid.dev@example.info\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"salutation\":\"\",\n         \"first_name\":\"Kaycee\",\n         \"last_name\":\"Gibney\",\n         \"full_name\":\"Kaycee Gibney\",\n         \"title\":\"Mgr Operations\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(599) 165-2396\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "d392f943d990-9", "text": "\"phone_home\":\"(599) 165-2396\",\n         \"phone_mobile\":\"(215) 591-9574\",\n         \"phone_work\":\"(771) 945-3648\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"primary_address_street\":\"321 University Ave.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Santa Monica\",\n         \"primary_address_state\":\"NY\",\n         \"primary_address_postalcode\":\"96154\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Existing Customer\",\n         \"account_name\":\"Tracker Com LP\",\n         \"account_id\":\"72ad6f00-e345-1cab-b370-56fedbd23deb\",\n         \"dnb_principal_id\":\"\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"birthdate\":\"\",\n         \"portal_name\":\"KayceeGibney33\",\n         \"portal_active\":true,\n         \"portal_password\":true,\n         \"portal_password1\":null,\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "d392f943d990-10", "text": "\"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"accept_status_calls\":\"\",\n         \"accept_status_meetings\":\"\",\n         \"sync_contact\":false,\n         \"mkto_sync\":false,\n         \"mkto_id\":null,\n         \"mkto_lead_score\":null,\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Contacts\",\n         \"_last_viewed_date\":\"2016-04-06T10:16:24-05:00\"\n      }\n   ]\n}\nThere are 3 records shown above, the _module field tells you if the record is from Accounts, Contacts or Leads.\u00c2\u00a0 The _last_viewed_date\u00c2\u00a0will tell you when the record was last seen.\nDownloads\nYou can download the full API example here\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "4e5e97249978-0", "text": "How to Unfollow a Record\nOverview\nA PHP example demonstrating how to unfollow a record using the v11 /<module>/:record/unsubscribe REST DELETE\u00c2\u00a0endpoint.\nUnfollowing a Record\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\n<?php\n$instance_url = \"http://{site_url}/rest/v11\";\n$username = \"admin\";\n$password = \"password\";\n//Login - POST /oauth2/token\n$auth_url = $instance_url . \"/oauth2/token\";\n$oauth2_token_arguments = array(\n    \"grant_type\" => \"password\",\n    //client id - default is sugar. \n    //It is recommended to create your own in Admin > OAuth Keys\n    \"client_id\" => \"sugar\", \n    \"client_secret\" => \"\",\n    \"username\" => $username,\n    \"password\" => $password,\n    //platform type - default is base.\n    //It is recommend to change the platform to a custom name such as \"custom_api\" to avoid authentication conflicts.\n    \"platform\" => \"custom_api\" \n);\n$auth_request = curl_init($auth_url);\ncurl_setopt($auth_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($auth_request, CURLOPT_HEADER, false);\ncurl_setopt($auth_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($auth_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($auth_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($auth_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\"\n));\n//convert arguments to json\n$json_arguments = json_encode($oauth2_token_arguments);\ncurl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Unfollow_a_Record/index.html"}
{"id": "4e5e97249978-1", "text": "curl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$oauth2_token_response = curl_exec($auth_request);\n//decode oauth2 response to get token\n$oauth2_token_response_obj = json_decode($oauth2_token_response);\n$oauth_token = $oauth2_token_response_obj->access_token;\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nUnfollowing a Record\nNext, we can unfollow a specific record\u00c2\u00a0using the /<module>/:record/unsubscribe\u00c2\u00a0endpoint.\n//Unfollow a record - DELETE /<module>/:record/unsubscribe\n$unsubscribe_url = $instance_url . \"/Accounts/ae8b1783-404a-fcb8-1e1e-56f1cc52cd1a/unsubscribe\";\n$unsubscribe_request = curl_init($unsubscribe_url);\ncurl_setopt($unsubscribe_request, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_setopt($unsubscribe_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($unsubscribe_request, CURLOPT_HEADER, false);\ncurl_setopt($unsubscribe_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($unsubscribe_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($unsubscribe_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($unsubscribe_request, CURLOPT_HTTPHEADER, array(\n \"Content-Type: application/json\",\n \"oauth-token: {$oauth_token}\"\n));\n//execute request\n$unsubscribe_response = curl_exec($unsubscribe_request);\nMore information on the unsubscribe API\u00c2\u00a0can be found in the /<module>/:record/unsubscribe DELETE  documentation.\nRequest Payload\nThe data sent to the server is shown below:\nThis endpoint does not accept any request arguments.\nResponse\nThe data received from the server is shown below:\ntrue\nDownload", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Unfollow_a_Record/index.html"}
{"id": "4e5e97249978-2", "text": "Response\nThe data received from the server is shown below:\ntrue\nDownload\nYou can download the full API example here.\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Unfollow_a_Record/index.html"}
{"id": "4fd927f5575b-0", "text": "How to Authenticate and Log Out\nOverview\nA PHP example on how to authenticate and logout of the v11 REST API using the /oauth2/token\u00c2\u00a0and /oauth2/logout POST endpoints.\nAuthenticating\nThe example below demonstrates how to authenticate to the REST v11 API. It is important to note that the oauth2 token arguments takes in several parameters that you should be aware of. The platform argument tends to cause confusion in that it is used to authenticate a user to a specific platform. Since Sugar only allows 1 user in the system at a time per platform, authenticating an integration script with a platform type of \"base\"\u00c2\u00a0will logout any current users in the system using those credentials. To work around this, your custom scripts should have a new platform type specified such as \"custom_api\" or any other static text you prefer. The client_id and client_secret\u00c2\u00a0parameters can be used for additional security based on client types. You can create your own client type\u00c2\u00a0in Admin > OAuth Keys. More information can be found in the /oauth2/token documentation. An example script is shown below:\n<?php\n$instance_url = \"http://{site_url}/rest/v11\";\n$username = \"admin\";\n$password = \"password\";\n//Login - POST /oauth2/token\n$auth_url = $instance_url . \"/oauth2/token\";\n$oauth2_token_arguments = array(\n    \"grant_type\" => \"password\",\n    //client id - default is sugar. \n    //It is recommended to create your own in Admin > OAuth Keys\n    \"client_id\" => \"sugar\", \n    \"client_secret\" => \"\",\n    \"username\" => $username,\n    \"password\" => $password,\n    //platform type - default is base.\n    //It is recommend to change the platform to a custom name such as \"custom_api\" to avoid authentication conflicts.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Authenticate_and_Log_Out/index.html"}
{"id": "4fd927f5575b-1", "text": "\"platform\" => \"custom_api\" \n);\n$auth_request = curl_init($auth_url);\ncurl_setopt($auth_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($auth_request, CURLOPT_HEADER, false);\ncurl_setopt($auth_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($auth_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($auth_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($auth_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\"\n));\n//convert arguments to json\n$json_arguments = json_encode($oauth2_token_arguments);\ncurl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$oauth2_token_response = curl_exec($auth_request);\nRequest Payload\nThe data sent to the server is shown below:\n{\n   \"grant_type\":\"password\",\n   \"client_id\":\"sugar\",\n   \"client_secret\":\"\",\n   \"username\":\"admin\",\n   \"password\":\"password\",\n   \"platform\":\"custom_api\"\n}\nResponse\nThe data received from the server is shown below:\n{\n   \"access_token\":\"c6d495c9-bb25-81d2-5f81-533ef6479f9b\",\n   \"expires_in\":3600,\n   \"token_type\":\"bearer\",\n   \"scope\":null,\n   \"refresh_token\":\"cbc40e67-12bc-4b56-a1d9-533ef62f2601\",\n   \"refresh_expires_in\":1209600,\n   \"download_token\":\"cc5d1a9f-6627-3349-96e5-533ef6b1a493\"\n}\nLogout", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Authenticate_and_Log_Out/index.html"}
{"id": "4fd927f5575b-2", "text": "}\nLogout\nTo log out of\u00c2\u00a0a session,\u00c2\u00a0a request\u00c2\u00a0can be made to the \u00c2\u00a0/oauth2/logout POST endpoint. More information can be found in the /oauth2/logout documentation.\u00c2\u00a0An example extending off of the above authentication example\u00c2\u00a0is shown\u00c2\u00a0below:\n//Logout - POST /oauth2/logout\n$logout_url = $instance_url . \"/oauth2/logout\";\n//decode oauth2 repsonse to get token\n$oauth2_token_response_obj = json_decode($oauth2_token_response);\n$oauth_token = $oauth2_token_response_obj->access_token;\n$logout_request = curl_init($logout_url);\ncurl_setopt($logout_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($logout_request, CURLOPT_HEADER, false);\ncurl_setopt($logout_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($logout_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($logout_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($logout_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//set empty post fields\ncurl_setopt($logout_request, CURLOPT_POSTFIELDS, array());\n//execute request\n$oauth2_logout_response = curl_exec($logout_request);\nResponse\nThe data received from the server is shown below:\n{\n    \"success\":true\n}\nDownload\nYou can download the full\u00c2\u00a0API example here.\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Authenticate_and_Log_Out/index.html"}
{"id": "5905bb4e9118-0", "text": "How to Manipulate Quotes\nOverview\nA PHP example\u00c2\u00a0demonstrating how to manipulate Quotes and related record data such as ProductBundles, Products, and ProductBundleNotes.\u00c2\u00a0\nManipulating Quotes\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\n<?php\n$instance_url = \"http://{site_url}/rest/v11\";\n$username = \"admin\";\n$password = \"password\";\n//Login - POST /oauth2/token\n$auth_url = $instance_url . \"/oauth2/token\";\n$oauth2_token_arguments = array(\n    \"grant_type\" => \"password\",\n    //client id - default is sugar. \n    //It is recommended to create your own in Admin > OAuth Keys\n    \"client_id\" => \"sugar\", \n    \"client_secret\" => \"\",\n    \"username\" => $username,\n    \"password\" => $password,\n    //platform type - default is base.\n    //It is recommend to change the platform to a custom name such as \"custom_api\" to avoid authentication conflicts.\n    \"platform\" => \"custom_api\" \n);\n$auth_request = curl_init($auth_url);\ncurl_setopt($auth_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($auth_request, CURLOPT_HEADER, false);\ncurl_setopt($auth_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($auth_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($auth_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($auth_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\"\n));\n//convert arguments to json\n$json_arguments = json_encode($oauth2_token_arguments);\ncurl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Quotes/index.html"}
{"id": "5905bb4e9118-1", "text": "curl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$oauth2_token_response = curl_exec($auth_request);\n//decode oauth2 response to get token\n$oauth2_token_response_obj = json_decode($oauth2_token_response);\n$oauth_token = $oauth2_token_response_obj->access_token;\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nCreating a Quote\nOnce authenticated, we can submit a Quote record using the <module> endpoint. Since a\u00c2\u00a0Quote record is a sum of its parts (i.e. ProductBundles and Products) you can submit the related ProductBundles and Products in the same request payload using the relationship Links and the \"create\" property.\n//Create Records - POST /<module>\n$url = $instance_url . \"/Quotes\";\n//Set up the Record details\n$DateTime = new DateTime();\n//Expected Close Date in 1 Month\n$DateTime->add(new DateInterval(\"P1M\"));\n//Quote Record\n$quote = array(\n    'name' => 'Test Quote',\n    'quote_stage' => 'Draft',\n    'date_quote_expected_closed' => $DateTime->format(DateTime::ISO8601),\n    //Create Product Bundles\n    'product_bundles' => array(\n        'create' => array(\n            array(\n                \"name\" => \"Product Bundle 1\",\n                \"bundle_stage\" => \"Draft\",\n                \"currency_id\" => \":-99\",\n                \"base_rate\" => \"1.0\",\n                \"shipping\" => \"0.00\",\n                \"products\" => array(\n                    //Create Product in Bundle 1\n                    \"create\" => array(\n                        array(\n                            \"tax_class\" => \"Taxable\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Quotes/index.html"}
{"id": "5905bb4e9118-2", "text": "array(\n                            \"tax_class\" => \"Taxable\",\n                            \"quantity\" => 1000.00,\n                            \"name\" => \"Test Product 1\",\n                            \"description\" => \"My Test Product\",\n                            \"mft_part_num\" => \"mft100012021\",\n                            \"cost_price\" =>  \"100.00\",\n                            \"list_price\" =>  \"200.00\",\n                            \"discount_price\" =>  \"175.00\",\n                            \"discount_amount\" =>  \"0.00\",\n                            \"discount_select\" =>  0,\n                            \"product_template_id\" =>  \"\",\n                            \"type_id\"  =>  \"\",\n                            \"status\"  =>  \"Quotes\"\n                        )\n                    )\n                ),\n                //Create Product Bundle Note in Bundle 1\n                \"product_bundle_notes\" => array(\n                    \"create\" => array(\n                        array(\n                            \"description\" => \"Free shipping\",\n                            \"position\" => 1\n                        )\n                    )\n                )\n            ),\n            array(\n                \"name\" => \"Product Bundle 2\",\n                \"bundle_stage\" => \"Draft\",\n                \"currency_id\" => \":-99\",\n                \"base_rate\" => \"1.0\",\n                \"shipping\" => \"25.00\",\n                \"products\" => array(\n                    //Create Products in Bundle 2\n                    \"create\" => array(\n                        array(\n                            \"quantity\" => 1000.00,\n                            \"name\" => \"Test Product 2\",\n                            \"description\" => \"My Other Product\",\n                            \"mft_part_num\" => \"mft100012234\",\n                            \"cost_price\" =>  \"150.00\",\n                            \"list_price\" =>  \"300.00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Quotes/index.html"}
{"id": "5905bb4e9118-3", "text": "\"list_price\" =>  \"300.00\",\n                            \"discount_price\" =>  \"275.00\",\n                            \"discount_amount\" =>  \"0.00\",\n                            \"discount_select\" =>  0,\n                            \"product_template_id\" =>  \"\",\n                            \"type_id\"  =>  \"\",\n                            \"status\"  =>  \"Quotes\"\n                        ),\n                        array(\n                            \"quantity\" => 500.00,\n                            \"name\" => \"Test Product 3\",\n                            \"description\" => \"My Other Other Product\",\n                            \"mft_part_num\" => \"mft100012123\",\n                            \"cost_price\" =>  \"10.00\",\n                            \"list_price\" =>  \"500.00\",\n                            \"discount_price\" =>  \"400.00\",\n                            \"discount_amount\" =>  \"0.00\",\n                            \"discount_select\" =>  0,\n                            \"product_template_id\" =>  \"\",\n                            \"type_id\"  =>  \"\",\n                            \"status\"  =>  \"Quotes\"\n                        )\n                    )\n                )\n            )\n        ),\n    )\n);\n$curl_request = curl_init($url);\ncurl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($curl_request, CURLOPT_HEADER, false);\ncurl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($curl_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//convert arguments to json\n$json_arguments = json_encode($quote);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Quotes/index.html"}
{"id": "5905bb4e9118-4", "text": "));\n//convert arguments to json\n$json_arguments = json_encode($quote);\ncurl_setopt($curl_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$curl_response = curl_exec($curl_request);\n//decode json\n$createdQuote = json_decode($curl_response);\n//display the created record\nprint_r($createdQuote);\ncurl_close($curl_request);\nRequest Payload\nThe data sent to the server is shown below:\n{\n  \"name\": \"Test Quote\",\n  \"quote_stage\": \"Draft\",\n  \"date_quote_expected_closed\": \"2017-06-12T11:51:57-0400\",\n  \"product_bundles\": {\n    \"create\": [\n      {\n        \"name\": \"Product Bundle 1\",\n        \"bundle_stage\": \"Draft\",\n        \"currency_id\": \":-99\",\n        \"base_rate\": \"1.0\",\n        \"shipping\": \"0.00\",\n        \"products\": {\n          \"create\": [\n            {\n              \"tax_class\": \"Taxable\",\n              \"quantity\": 1000,\n              \"name\": \"Test Product 1\",\n              \"description\": \"My Test Product\",\n              \"mft_part_num\": \"mft100012021\",\n              \"cost_price\": \"100.00\",\n              \"list_price\": \"200.00\",\n              \"discount_price\": \"175.00\",\n              \"discount_amount\": \"0.00\",\n              \"discount_select\": 0,\n              \"product_template_id\": \"\",\n              \"type_id\": \"\",\n              \"status\": \"Quotes\"\n            }\n          ]\n        },\n        \"product_bundle_notes\": {\n          \"create\": [\n            {\n              \"description\": \"Free shipping\",\n              \"position\": 1\n            }", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Quotes/index.html"}
{"id": "5905bb4e9118-5", "text": "\"description\": \"Free shipping\",\n              \"position\": 1\n            }\n          ]\n        }\n      },\n      {\n        \"name\": \"Product Bundle 2\",\n        \"bundle_stage\": \"Draft\",\n        \"currency_id\": \":-99\",\n        \"base_rate\": \"1.0\",\n        \"shipping\": \"25.00\",\n        \"products\": {\n          \"create\": [\n            {\n              \"quantity\": 1000,\n              \"name\": \"Test Product 2\",\n              \"description\": \"My Other Product\",\n              \"mft_part_num\": \"mft100012234\",\n              \"cost_price\": \"150.00\",\n              \"list_price\": \"300.00\",\n              \"discount_price\": \"275.00\",\n              \"discount_amount\": \"0.00\",\n              \"discount_select\": 0,\n              \"product_template_id\": \"\",\n              \"type_id\": \"\",\n              \"status\": \"Quotes\"\n            },\n            {\n              \"quantity\": 500,\n              \"name\": \"Test Product 3\",\n              \"description\": \"My Other Other Product\",\n              \"mft_part_num\": \"mft100012123\",\n              \"cost_price\": \"10.00\",\n              \"list_price\": \"500.00\",\n              \"discount_price\": \"400.00\",\n              \"discount_amount\": \"0.00\",\n              \"discount_select\": 0,\n              \"product_template_id\": \"\",\n              \"type_id\": \"\",\n              \"status\": \"Quotes\"\n            }\n          ]\n        }\n      }\n    ]\n  }\n}\nResponse\nThe data received from the server is shown below:\n{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Quotes/index.html"}
{"id": "5905bb4e9118-6", "text": "}\n}\nResponse\nThe data received from the server is shown below:\n{\n  \"id\": \"ee1e1ae8-372a-11e7-8bf4-3c15c2c94fb0\",\n  \"name\": \"Test Quote\",\n  \"date_entered\": \"2017-05-12T11:51:57-04:00\",\n  \"date_modified\": \"2017-05-12T11:51:57-04:00\",\n  \"modified_user_id\": \"1\",\n  \"modified_by_name\": \"Administrator\",\n  \"modified_user_link\": {\n    \"full_name\": \"Administrator\",\n    \"id\": \"1\",\n    \"_acl\": {\n      \"fields\": {\n        \"pwd_last_changed\": {\n          \"write\": \"no\",\n          \"create\": \"no\"\n        },\n        \"last_login\": {\n          \"write\": \"no\",\n          \"create\": \"no\"\n        }\n      },\n      \"delete\": \"no\",\n      \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n    }\n  },\n  \"created_by\": \"1\",\n  \"created_by_name\": \"Administrator\",\n  \"created_by_link\": {\n    \"full_name\": \"Administrator\",\n    \"id\": \"1\",\n    \"_acl\": {\n      \"fields\": {\n        \"pwd_last_changed\": {\n          \"write\": \"no\",\n          \"create\": \"no\"\n        },\n        \"last_login\": {\n          \"write\": \"no\",\n          \"create\": \"no\"\n        }\n      },\n      \"delete\": \"no\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Quotes/index.html"}
{"id": "5905bb4e9118-7", "text": "}\n      },\n      \"delete\": \"no\",\n      \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n    }\n  },\n  \"description\": \"\",\n  \"deleted\": false,\n  \"shipper_id\": \"\",\n  \"shipper_name\": \"\",\n  \"shippers\": {\n    \"name\": \"\",\n    \"id\": \"\",\n    \"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n    }\n  },\n  \"taxrate_id\": \"\",\n  \"taxrate_name\": \"\",\n  \"taxrates\": {\n    \"name\": \"\",\n    \"id\": \"\",\n    \"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n    }\n  },\n  \"taxrate_value\": \"0.000000\",\n  \"show_line_nums\": true,\n  \"quote_type\": \"Quotes\",\n  \"date_quote_expected_closed\": \"2017-06-12\",\n  \"original_po_date\": \"\",\n  \"payment_terms\": \"\",\n  \"date_quote_closed\": \"\",\n  \"date_order_shipped\": \"\",\n  \"order_stage\": \"\",\n  \"quote_stage\": \"Draft\",\n  \"purchase_order_num\": \"\",\n  \"quote_num\": 2,\n  \"subtotal\": \"650000.000000\",\n  \"subtotal_usdollar\": \"650000.000000\",\n  \"shipping\": \"0.000000\",\n  \"shipping_usdollar\": \"0.000000\",\n  \"discount\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Quotes/index.html"}
{"id": "5905bb4e9118-8", "text": "\"shipping_usdollar\": \"0.000000\",\n  \"discount\": \"\",\n  \"deal_tot\": \"0.00\",\n  \"deal_tot_discount_percentage\": \"0.00\",\n  \"deal_tot_usdollar\": \"0.00\",\n  \"new_sub\": \"650000.000000\",\n  \"new_sub_usdollar\": \"650000.000000\",\n  \"taxable_subtotal\": \"650000.000000\",\n  \"tax\": \"0.000000\",\n  \"tax_usdollar\": \"0.000000\",\n  \"total\": \"650000.000000\",\n  \"total_usdollar\": \"650000.000000\",\n  \"billing_address_street\": \"\",\n  \"billing_address_city\": \"\",\n  \"billing_address_state\": \"\",\n  \"billing_address_postalcode\": \"\",\n  \"billing_address_country\": \"\",\n  \"shipping_address_street\": \"\",\n  \"shipping_address_city\": \"\",\n  \"shipping_address_state\": \"\",\n  \"shipping_address_postalcode\": \"\",\n  \"shipping_address_country\": \"\",\n  \"system_id\": 1,\n  \"shipping_account_name\": \"\",\n  \"shipping_accounts\": {\n    \"name\": \"\",\n    \"id\": \"\",\n    \"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n    }\n  },\n  \"shipping_account_id\": \"\",\n  \"shipping_contact_name\": \"\",\n  \"shipping_contacts\": {\n    \"full_name\": \"\",\n    \"id\": \"\",\n    \"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Quotes/index.html"}
{"id": "5905bb4e9118-9", "text": "},\n    \"last_name\": \"\"\n  },\n  \"shipping_contact_id\": \"\",\n  \"account_name\": \"\",\n  \"billing_accounts\": {\n    \"name\": \"\",\n    \"id\": \"\",\n    \"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n    }\n  },\n  \"account_id\": \"\",\n  \"billing_account_name\": \"\",\n  \"billing_account_id\": \"\",\n  \"billing_contact_name\": \"\",\n  \"billing_contacts\": {\n    \"full_name\": \"\",\n    \"id\": \"\",\n    \"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n    },\n    \"last_name\": \"\"\n  },\n  \"billing_contact_id\": \"\",\n  \"opportunity_name\": \"\",\n  \"opportunities\": {\n    \"name\": \"\",\n    \"id\": \"\",\n    \"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n    }\n  },\n  \"opportunity_id\": \"\",\n  \"following\": \"\",\n  \"my_favorite\": false,\n  \"tag\": [\n  ],\n  \"locked_fields\": [\n  ],\n  \"assigned_user_id\": \"\",\n  \"assigned_user_name\": \"\",\n  \"assigned_user_link\": {\n    \"full_name\": \"\",\n    \"id\": \"\",\n    \"_acl\": {\n      \"fields\": [\n      ],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Quotes/index.html"}
{"id": "5905bb4e9118-10", "text": "\"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n    }\n  },\n  \"team_count\": \"\",\n  \"team_count_link\": {\n    \"team_count\": \"\",\n    \"id\": \"1\",\n    \"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n    }\n  },\n  \"team_name\": [\n    {\n      \"id\": \"a0512788-3680-11e7-b42f-3c15c2c94fb0\",\n      \"name\": \"Administrator\",\n      \"name_2\": \"\",\n      \"primary\": false,\n      \"selected\": false\n    },\n    {\n      \"id\": \"1\",\n      \"name\": \"Global\",\n      \"name_2\": \"\",\n      \"primary\": true,\n      \"selected\": false\n    }\n  ],\n  \"currency_id\": \"-99\",\n  \"base_rate\": \"1.000000\",\n  \"currency_name\": \"\",\n  \"currencies\": {\n    \"name\": \"\",\n    \"id\": \"-99\",\n    \"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n    },\n    \"symbol\": \"\"\n  },\n  \"currency_symbol\": \"\",\n  \"_acl\": {\n    \"fields\": {\n    }\n  },\n  \"_module\": \"Quotes\"\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Quotes/index.html"}
{"id": "5905bb4e9118-11", "text": "}\n  },\n  \"_module\": \"Quotes\"\n}\nYou might notice that the Response does not contain the related data. To view the related data use the <module>/<record_id>/link/<link_name> - GET Endpoint.\nModifying the Quote's Product Bundles\nOnce the quote is created, you might need to add or remove Product Bundles from the Quote. This can be done using the /<module>/<record> - PUT\u00c2\u00a0endpoint.\n//Create a new ProductBundle\n$url = $instance_url . \"/ProductBundles\";\n$productBundle = array(\n        \"name\" => \"Product Bundle 3\",\n        \"bundle_stage\" => \"Draft\",\n        \"currency_id\" => \":-99\",\n        \"base_rate\" => \"1.0\",\n        \"shipping\" => \"0.00\",\n        \"products\" => array(\n            //Create Product in Bundle 3\n            \"create\" => array(\n                array(\n                    \"tax_class\" => \"Taxable\",\n                    \"quantity\" => 100.00,\n                    \"name\" => \"Test Product 3\",\n                    \"description\" => \"Test Product 3\",\n                    \"mft_part_num\" => \"mft100012021\",\n                    \"cost_price\" =>  \"100.00\",\n                    \"list_price\" =>  \"250.00\",\n                    \"discount_price\" =>  \"175.00\",\n                    \"discount_amount\" =>  \"0.00\",\n                    \"discount_select\" =>  0,\n                    \"product_template_id\" =>  \"\",\n                    \"type_id\"  =>  \"\",\n                    \"status\"  =>  \"Quotes\",\n                    \"position\" => 0\n                )\n            )\n        ),\n        //Create Product Bundle Note in Bundle 3", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Quotes/index.html"}
{"id": "5905bb4e9118-12", "text": ")\n            )\n        ),\n        //Create Product Bundle Note in Bundle 3\n        \"product_bundle_notes\" => array(\n            \"create\" => array(\n                array(\n                    \"description\" => \"Free shipping\",\n                    \"position\" => 1\n                )\n            )\n        )\n    );\n$curl_request = curl_init($url);\ncurl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($curl_request, CURLOPT_HEADER, false);\ncurl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($curl_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//convert arguments to json\n$json_arguments = json_encode($productBundle);\ncurl_setopt($curl_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$curl_response = curl_exec($curl_request);\n//decode json\n$createdBundle = json_decode($curl_response);\n//display the created record\nprint_r($createdBundle);\ncurl_close($curl_request);\n//Add Bundle to Previously Created Quote\n//PUT to /Quotes/<record_id>\n$url = $instance_url . \"/Quotes/\".$createdQuote->id;\n$quote = array(\n    'product_bundles' => array(\n        'delete' => array(\n            'some_bundle_id'\n        ),\n        'add' => array(\n            $createdBundle->id\n        )\n    )\n);\n$curl_request = curl_init($url);\ncurl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Quotes/index.html"}
{"id": "5905bb4e9118-13", "text": "curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($curl_request, CURLOPT_HEADER, false);\ncurl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($curl_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//convert arguments to json\n$json_arguments = json_encode($quote);\ncurl_setopt($curl_request, CURLOPT_POSTFIELDS, $json_arguments);\n//PUT Request\ncurl_setopt($curl_request, CURLOPT_CUSTOMREQUEST, \"PUT\");\n//execute request\n$curl_response = curl_exec($curl_request);\n//decode json\n$updatedQuote = json_decode($curl_response);\n//display the updated quote record\nprint_r($updatedQuote);\ncurl_close($curl_request);\n\u00c2\u00a0The above script removes a previously related Product Bundle from the Quote and adds the Product Bundle that was created before it in the script.\nRequest Payload\nThe data sent to the server to alter the Quotes Product Bundles is shown below:\n{\n  \"product_bundles\": {\n    \"delete\": [\n      \"some_bundle_id\"\n    ],\n    \"add\": [\n      \"803972ea-3741-11e7-8edc-3c15c2c94fb0\"\n    ]\n  }\n}\nResponse Payload\nThe response payload will match the standard /<module>/<record> - PUT Endpoint Response which is the entire values of the updated record. The previous Response for Creating the quote is the same as shown above.\nDownload\nYou can download the full API example here.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Quotes/index.html"}
{"id": "5905bb4e9118-14", "text": "Download\nYou can download the full API example here.\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Quotes/index.html"}
{"id": "1a30b7e9854f-0", "text": "How to Export a List of Records\nOverview\nAn PHP example\u00c2\u00a0demonstrating how to export a list of records using the v11 /<module>/export/:record_list_id\u00c2\u00a0REST GET endpoint.\nExporting Records\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\n<?php\n$instance_url = \"http://{site_url}/rest/v11\";\n$username = \"admin\";\n$password = \"password\";\n//Login - POST /oauth2/token\n$auth_url = $instance_url . \"/oauth2/token\";\n$oauth2_token_arguments = array(\n    \"grant_type\" => \"password\",\n    //client id - default is sugar. \n    //It is recommended to create your own in Admin > OAuth Keys\n    \"client_id\" => \"sugar\", \n    \"client_secret\" => \"\",\n    \"username\" => $username,\n    \"password\" => $password,\n    //platform type - default is base.\n    //It is recommend to change the platform to a custom name such as \"custom_api\" to avoid authentication conflicts.\n    \"platform\" => \"custom_api\" \n);\n$auth_request = curl_init($auth_url);\ncurl_setopt($auth_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($auth_request, CURLOPT_HEADER, false);\ncurl_setopt($auth_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($auth_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($auth_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($auth_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\"\n));\n//convert arguments to json\n$json_arguments = json_encode($oauth2_token_arguments);\ncurl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Export_a_List_of_Records/index.html"}
{"id": "1a30b7e9854f-1", "text": "curl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$oauth2_token_response = curl_exec($auth_request);\n//decode oauth2 response to get token\n$oauth2_token_response_obj = json_decode($oauth2_token_response);\n$oauth_token = $oauth2_token_response_obj->access_token;\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nFiltering Records\nNext, we will need to identify the records we want to export using the /<module>/filter\u00c2\u00a0endpoint.\n//Identify records to export - POST /<module>/filter\n$filter_url = $instance_url . \"/Accounts/filter\";\n$filter_arguments = array(\n    \"filter\" => array(\n        array(\n            '$or' => array(\n                array(\n                    //name starts with 'a'\n                    \"name\" => array(\n                        '$starts'=>\"A\",\n                    )\n                ),\n                array(\n                    //name starts with 'b'\n                    \"name\" => array(\n                        '$starts'=>\"b\",\n                    )\n                )\n            ),\n        ),\n    ),\n    \"max_num\" => 2,\n    \"offset\" => 0,\n    \"fields\" => \"id\",\n    \"order_by\" => \"date_entered\",\n    \"favorites\" => false,\n    \"my_items\" => false,\n);\n$filter_request = curl_init($filter_url);\ncurl_setopt($filter_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($filter_request, CURLOPT_HEADER, false);\ncurl_setopt($filter_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($filter_request, CURLOPT_RETURNTRANSFER, 1);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Export_a_List_of_Records/index.html"}
{"id": "1a30b7e9854f-2", "text": "curl_setopt($filter_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($filter_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($filter_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//convert arguments to json\n$json_arguments = json_encode($filter_arguments);\ncurl_setopt($filter_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$filter_response = curl_exec($filter_request);\n//decode json\n$filter_response_obj = json_decode($filter_response);\n//store ids of records to export\n$export_ids = array();\nforeach ($filter_response_obj->records as $record)\n{\n    $export_ids[] = $record->id;\n}\nMore information on the filter API\u00c2\u00a0can be found in the /<module>/filter documentation.\nRequest Payload\nThe data sent to the server is shown below:\n{  \n   \"filter\":[  \n      {  \n         \"$or\":[  \n            {  \n               \"name\":{  \n                  \"$starts\":\"A\"\n               }\n            },\n            {  \n               \"name\":{  \n                  \"$starts\":\"b\"\n               }\n            }\n         ]\n      }\n   ],\n   \"max_num\":2,\n   \"offset\":0,\n   \"fields\":\"id\",\n   \"order_by\":\"date_entered\",\n   \"favorites\":false,\n   \"my_items\":false\n}\nResponse\nThe data received from the server is shown below:\n{  \n   \"next_offset\":2,\n   \"records\":[  \n      {  \n         \"id\":\"f16760a4-3a52-f77d-1522-5703ca28925f\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Export_a_List_of_Records/index.html"}
{"id": "1a30b7e9854f-3", "text": "\"date_modified\":\"2016-04-05T10:23:28-04:00\",\n         \"_acl\":{  \n            \"fields\":{  \n            }\n         },\n         \"_module\":\"Accounts\"\n      },\n      {  \n         \"id\":\"ec409fbb-2b22-4f32-7fa1-5703caf78dc3\",\n         \"date_modified\":\"2016-04-05T10:23:28-04:00\",\n         \"_acl\":{  \n            \"fields\":{  \n            }\n         },\n         \"_module\":\"Accounts\"\n      }\n   ]\n}\nCreating a Record List\nOnce we have the list of ids, we then need to create a record list in Sugar that consists of those ids.\n//Create a record list - POST /<module>/record_list\n$record_list_url = $instance_url . \"/Accounts/record_list\";\n$record_list_arguments = array(\n    \"records\" => $export_ids,\n);\n$record_list_request = curl_init($record_list_url);\ncurl_setopt($record_list_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($record_list_request, CURLOPT_HEADER, false);\ncurl_setopt($record_list_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($record_list_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($record_list_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($record_list_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//convert arguments to json\n$json_arguments = json_encode($record_list_arguments);\ncurl_setopt($record_list_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Export_a_List_of_Records/index.html"}
{"id": "1a30b7e9854f-4", "text": "curl_setopt($record_list_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$record_list_response = curl_exec($record_list_request);\nRequest Payload\nThe data sent to the server is shown below:\n{  \n   \"records\":[  \n      \"f16760a4-3a52-f77d-1522-5703ca28925f\",\n      \"ec409fbb-2b22-4f32-7fa1-5703caf78dc3\"\n   ]\n}\nResponse\nThe data received from the server is shown below:\n{  \n   \"id\":\"ef963176-4845-bc55-b03e-570430b4173c\",\n   \"assigned_user_id\":\"1\",\n   \"module_name\":\"Accounts\",\n   \"records\":[  \n      \"f16760a4-3a52-f77d-1522-5703ca28925f\",\n      \"ec409fbb-2b22-4f32-7fa1-5703caf78dc3\"\n   ],\n   \"date_modified\":\"2016-04-05 21:39:19\"\n}\nExporting Records\nOnce we have the record list created, we can then export the CSV file.\n//Export Records - GET /<module>/export/:record_list_id\n$export_url = $instance_url . \"/Accounts/export/\" . $record_list_response_obj->id;\n$export_request = curl_init($export_url);\ncurl_setopt($export_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($export_request, CURLOPT_HEADER, true); //needed to return file headers\ncurl_setopt($export_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($export_request, CURLOPT_RETURNTRANSFER, 1);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Export_a_List_of_Records/index.html"}
{"id": "1a30b7e9854f-5", "text": "curl_setopt($export_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($export_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($export_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n$export_response = curl_exec($export_request);\n//set headers from response\nlist($headers, $content) = explode(\"\\r\\n\\r\\n\", $export_response ,2);\nforeach (explode(\"\\r\\n\",$headers) as $header) {\n    header($header);\n}\n$content = trim($content);\necho $content;\nMore information on exporting records can be found in the /<module>/export/:record_list_id\u00c2\u00a0documentation.\nResponse\nThe data received from the server is shown below:\nHTTP/1.1 200 OK \nDate: Tue, 05 Apr 2016 21:50:32 \nGMT Server: Apache/2.2.29 (Unix) \nDAV/2 PHP/5.3.29 mod_ssl/2.2.29 \nOpenSSL/0.9.8zg X-Powered-By: \nPHP/5.3.29 Expires: \nCache-Control: max-age=10, \nprivate Pragma: \nContent-Disposition: attachment; filename=Accounts.csv \nContent-transfer-encoding: binary \nLast-Modified: Tue, 05 Apr 2016 21:50:32 \nGMT ETag: 9b34f5d74e0298aaf7fd1f27d02e14f2 \nContent-Length: 1703 \nConnection: close \nContent-Type: application/octet-stream; charset=ISO-8859-1", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Export_a_List_of_Records/index.html"}
{"id": "1a30b7e9854f-6", "text": "Content-Type: application/octet-stream; charset=ISO-8859-1 \n\"Name\",\"ID\",\"Website\",\"Office Phone\",\"Alternate Phone\",\"Fax\",\"Billing Street\",\"Billing City\",\"Billing State\",\"Billing Postal Code\",\"Billing Country\",\"Shipping Street\",\"Shipping City\",\"Shipping State\",\"Shipping Postal Code\",\"Shipping Country\",\"Description\",\"Type\",\"Industry\",\"Annual Revenue\",\"Employees\",\"SIC Code\",\"Ticker Symbol\",\"Parent Account ID\",\"Ownership\",\"Campaign ID\",\"Rating\",\"Assigned User Name\",\"Assigned User ID\",\"Team ID\",\"Teams\",\"Team Set ID\",\"Date Created\",\"Date Modified\",\"Modified By Name\",\"Modified By ID\",\"Created By\",\"Created By ID\",\"Deleted\",\"test\",\"Facebook Account\",\"Twitter Account\",\"Google Plus ID\",\"DUNS\",\"Email\",\"Invalid Email\",\"Email Opt Out\",\"Non-primary emails\" \n\"Arts & Crafts Inc\",\"ec409fbb-2b22-4f32-7fa1-5703caf78dc3\",\"www.hrinfo.tw\",\"(252) 456-8602\",\"\",\"\",\"777 West Filmore Ln\",\"Los Angeles\",\"CA\",\"77076\",\"USA\",\"777 West Filmore Ln\",\"Los Angeles\",\"CA\",\"77076\",\"USA\",\"\",\"Customer\",\"Hospitality\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"Max Jensen\",\"seed_max_id\",\"West\",\"West, East, Global\",\"dec43cb2-5273-8be2-968a-5703cadee75f\",\"2016-04-05 10:23\",\"2016-04-05 10:23\",\"Administrator\",\"1\",\"Administrator\",\"1\",\"0\",\"\",\"\",\"\",\"\",\"\",\"sugar.sugar.section@example.org\",\"0\",\"0\",\"dev.phone@example.biz,0,0\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Export_a_List_of_Records/index.html"}
{"id": "1a30b7e9854f-7", "text": "\"B.H. Edwards Inc\",\"f16760a4-3a52-f77d-1522-5703ca28925f\",\"www.sectiondev.edu\",\"(361) 765-0216\",\"\",\"\",\"111 Silicon Valley Road\",\"Persistance\",\"CA\",\"29709\",\"USA\",\"111 Silicon Valley Road\",\"Persistance\",\"CA\",\"29709\",\"USA\",\"\",\"Customer\",\"Apparel\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"Sally Bronsen\",\"seed_sally_id\",\"West\",\"West\",\"West\",\"2016-04-05 10:23\",\"2016-04-05 10:23\",\"Administrator\",\"1\",\"Administrator\",\"1\",\"0\",\"\",\"\",\"\",\"\",\"\",\"info.sugar@example.de\",\"0\",\"1\",\"phone.sales.section@example.tv,0,0\"\nDownload\nYou can download the full API example here.\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Export_a_List_of_Records/index.html"}
{"id": "493af35ddb40-0", "text": "How to Fetch the Current Users Time\nOverview\nA PHP example\u00c2\u00a0demonstrating how to fetch the current users time with the v11 /ping/whattimeisit REST GET endpoint.\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\n<?php\n$instance_url = \"http://{site_url}/rest/v11\";\n$username = \"admin\";\n$password = \"password\";\n//Login - POST /oauth2/token\n$auth_url = $instance_url . \"/oauth2/token\";\n$oauth2_token_arguments = array(\n    \"grant_type\" => \"password\",\n    //client id - default is sugar. \n    //It is recommended to create your own in Admin > OAuth Keys\n    \"client_id\" => \"sugar\", \n    \"client_secret\" => \"\",\n    \"username\" => $username,\n    \"password\" => $password,\n    //platform type - default is base.\n    //It is recommend to change the platform to a custom name such as \"custom_api\" to avoid authentication conflicts.\n    \"platform\" => \"custom_api\" \n);\n$auth_request = curl_init($auth_url);\ncurl_setopt($auth_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($auth_request, CURLOPT_HEADER, false);\ncurl_setopt($auth_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($auth_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($auth_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($auth_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\"\n));\n//convert arguments to json\n$json_arguments = json_encode($oauth2_token_arguments);\ncurl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_the_Current_Users_Time/index.html"}
{"id": "493af35ddb40-1", "text": "curl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$oauth2_token_response = curl_exec($auth_request);\n//decode oauth2 response to get token\n$oauth2_token_response_obj = json_decode($oauth2_token_response);\n$oauth_token = $oauth2_token_response_obj->access_token;\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nGetting the Current Time and Date for the User\n//Set up the time parameters - GET /ping/whattimeisit\n$time_url = $instance_url . \"/ping/whattimeisit\";\n$time_request = curl_init($search_url);\ncurl_setopt($time_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($time_request, CURLOPT_HEADER, false);\ncurl_setopt($time_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($time_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($time_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($time_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//execute request\n$time_response = curl_exec($time_request);\n//decode json\n$time_response_obj = json_decode($time_response);\nRequest\nhttp://{site_url}/rest/v11/ping/whattimeisit\nResponse\n\"2014-04-08T14:59:13-04:00\"\nDownloads\nYou can download the full API example here\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Fetch_the_Current_Users_Time/index.html"}
{"id": "213e16c1815c-0", "text": "How to Get the Most Active Users\nOverview\nA PHP example demonstrating how to fetch the most active users for meetings, calls, inbound emails, and outbound emails using the v11 /mostactiveusers REST GET\u00c2\u00a0endpoint.\nGet Most Active Users\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\n<?php\n$instance_url = \"http://{site_url}/rest/v11\";\n$username = \"admin\";\n$password = \"password\";\n//Login - POST /oauth2/token\n$auth_url = $instance_url . \"/oauth2/token\";\n$oauth2_token_arguments = array(\n    \"grant_type\" => \"password\",\n    //client id - default is sugar. \n    //It is recommended to create your own in Admin > OAuth Keys\n    \"client_id\" => \"sugar\", \n    \"client_secret\" => \"\",\n    \"username\" => $username,\n    \"password\" => $password,\n    //platform type - default is base.\n    //It is recommend to change the platform to a custom name such as \"custom_api\" to avoid authentication conflicts.\n    \"platform\" => \"custom_api\" \n);\n$auth_request = curl_init($auth_url);\ncurl_setopt($auth_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($auth_request, CURLOPT_HEADER, false);\ncurl_setopt($auth_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($auth_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($auth_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($auth_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\"\n));\n//convert arguments to json\n$json_arguments = json_encode($oauth2_token_arguments);\ncurl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Get_the_Most_Active_Users/index.html"}
{"id": "213e16c1815c-1", "text": "curl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$oauth2_token_response = curl_exec($auth_request);\n//decode oauth2 response to get token\n$oauth2_token_response_obj = json_decode($oauth2_token_response);\n$oauth_token = $oauth2_token_response_obj->access_token;\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nActive Users\nNext, we can retrieve\u00c2\u00a0the most active users\u00c2\u00a0using the /mostactiveusers\u00c2\u00a0endpoint.\n//Fetch users - GET /mostactiveusers\n$most_active_arguments = array(\n    \"days\" => 30,\n);\n$most_active_url = $instance_url . \"/mostactiveusers\";\n$most_active_url .= \"?\" . http_build_query($most_active_arguments);\n$most_active_request = curl_init($most_active_url);\ncurl_setopt($most_active_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($most_active_request, CURLOPT_HEADER, false);\ncurl_setopt($most_active_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($most_active_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($most_active_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($most_active_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//execute request\n$most_active_response = curl_exec($most_active_request);\n//decode json\n$most_active_response_obj = json_decode($most_active_response);\nMore information on the mostactiveusers API\u00c2\u00a0can be found in the /mostactiveusers documentation.\nRequest\nThe URL\u00c2\u00a0sent to the server is shown below:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Get_the_Most_Active_Users/index.html"}
{"id": "213e16c1815c-2", "text": "Request\nThe URL\u00c2\u00a0sent to the server is shown below:\nhttp://{site_url}/rest/v11/mostactiveusers?days=30\nResponse\nThe data received from the server is shown below:\n{\n    \"meetings\": {\n        \"user_id\": \"seed_max_id\",\n        \"count\": \"21\",\n        \"first_name\": \"Max\",\n        \"last_name\": \"Jensen\"\n    },\n    \"calls\": {\n        \"user_id\": \"seed_chris_id\",\n        \"count\": \"4\",\n        \"first_name\": \"Chris\",\n        \"last_name\": \"Olliver\"\n    },\n    \"inbound_emails\": {\n        \"user_id\": \"seed_chris_id\",\n        \"count\": \"23\",\n        \"first_name\": \"Chris\",\n        \"last_name\": \"Olliver\"\n    },\n    \"outbound_emails\": {\n        \"user_id\": \"seed_sarah_id\",\n        \"count\": \"20\",\n        \"first_name\": \"Sarah\",\n        \"last_name\": \"Smith\"\n    }\n}\nDownload\nYou can download the full API example here.\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Get_the_Most_Active_Users/index.html"}
{"id": "3cb612707889-0", "text": "How to Manipulate Tags (CRUD)\nOverview\nA PHP example\u00c2\u00a0demonstrating how to work with tags using the v11 REST\u00c2\u00a0endpoints.\nAuthentication\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\n<?php\n$instance_url = \"http://{site_url}/rest/v11\";\n$username = \"admin\";\n$password = \"password\";\n//Login - POST /oauth2/token\n$auth_url = $instance_url . \"/oauth2/token\";\n$oauth2_token_arguments = array(\n    \"grant_type\" => \"password\",\n    //client id - default is sugar. \n    //It is recommended to create your own in Admin > OAuth Keys\n    \"client_id\" => \"sugar\", \n    \"client_secret\" => \"\",\n    \"username\" => $username,\n    \"password\" => $password,\n    //platform type - default is base.\n    //It is recommend to change the platform to a custom name such as \"custom_api\" to avoid authentication conflicts.\n    \"platform\" => \"custom_api\" \n);\n$auth_request = curl_init($auth_url);\ncurl_setopt($auth_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($auth_request, CURLOPT_HEADER, false);\ncurl_setopt($auth_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($auth_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($auth_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($auth_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\"\n));\n//convert arguments to json\n$json_arguments = json_encode($oauth2_token_arguments);\ncurl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$oauth2_token_response = curl_exec($auth_request);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "3cb612707889-1", "text": "//execute request\n$oauth2_token_response = curl_exec($auth_request);\n//decode oauth2 response to get token\n$oauth2_token_response_obj = json_decode($oauth2_token_response);\n$oauth_token = $oauth2_token_response_obj->access_token;\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout POST endpoint documentation.\nCreating Tags\nOnce you get oauth_token you would need to use it in the following API Calls to create tags.\u00c2\u00a0\n//Create Tags - /Tags POST\n$url = $instance_url . \"/Tags\";\n//Set up the tag name\n$record = array(\n    'name' => 'Tag Name',\n);\n$curl_request = curl_init($url);\ncurl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($curl_request, CURLOPT_HEADER, false);\ncurl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($curl_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//convert arguments to json\n$json_arguments = json_encode($record);\ncurl_setopt($curl_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$curl_response = curl_exec($curl_request);\n//decode json\n$createdRecord = json_decode($curl_response);\n//display the created record\nprint_r($createdRecord);\ncurl_close($curl_request);\nMore information on this API endpoint can be found in the /<module> POST documentation.\nRequest Payload\n{\"name\":\"Tag Name\"}\nResponse\n{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "3cb612707889-2", "text": "Request Payload\n{\"name\":\"Tag Name\"}\nResponse\n{\n    \"id\": \"12c6ee48-1000-11e8-8838-6a0001bcacb0\",\n    \"name\": \"Tag Name\",\n    \"date_entered\": \"2018-02-12T15:21:52+01:00\",\n    \"date_modified\": \"2018-02-12T15:21:52+01:00\",\n    \"modified_user_id\": \"1\",\n    \"modified_by_name\": \"Administrator\",\n    \"modified_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"created_by\": \"1\",\n    \"created_by_name\": \"Administrator\",\n    \"created_by_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"description\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "3cb612707889-3", "text": "}\n    },\n    \"description\": \"\",\n    \"deleted\": false,\n    \"name_lower\": \"tag name\",\n    \"following\": \"\",\n    \"my_favorite\": false,\n    \"locked_fields\": [],\n    \"source_id\": \"\",\n    \"source_type\": \"\",\n    \"source_meta\": \"\",\n    \"assigned_user_id\": \"1\",\n    \"assigned_user_name\": \"Administrator\",\n    \"assigned_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"_acl\": { \"fields\": {} },\n    \"_module\": \"Tags\"\n}\nCreating Records with Tags\nYou can also create tags when\u00c2\u00a0creating new\u00c2\u00a0records. All you need to do populate the tag field as an array when creating a record.\u00c2\u00a0Here is\u00c2\u00a0an example that demonstrates using the\u00c2\u00a0/<module> POST\u00c2\u00a0endpoint.\n//Create Records with Tags - / POST\n$url = $instance_url . \"/Accounts\";\n//Set up the Record details with Tags\n$record = array(\n    'name' => 'Test Record',\n    'tag' => array(\n        'First Tag',\n        'Second Tag'\n    )\n);\n$curl_request = curl_init($url);\ncurl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "3cb612707889-4", "text": "curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($curl_request, CURLOPT_HEADER, false);\ncurl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($curl_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//convert arguments to json\n$json_arguments = json_encode($record);\ncurl_setopt($curl_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$curl_response = curl_exec($curl_request);\n//decode json\n$createdRecord = json_decode($curl_response);\n//display the created record\nprint_r($createdRecord);\ncurl_close($curl_request);\nMore information on this API endpoint can be found in the /<module> POST documentation.\nRequest Payload\nThe data sent to the server is shown below:\n{ \n    \"name\": \"Test Record\",\n    \"tag\": [\n        \"First Tag\",\n        \"Second Tag\"\n    ]\n}\nResponse\nThe data sent to the server is shown below:\n{\n    \"id\": \"ea507760-0ffd-11e8-bcf5-6a0001bcacb0\",\n    \"name\": \"Test Record\",\n    \"date_entered\": \"2018-02-12T15:06:25+01:00\",\n    \"date_modified\": \"2018-02-12T15:06:25+01:00\",\n    \"modified_user_id\": \"1\",\n    \"modified_by_name\": \"Administrator\",\n    \"modified_user_link\": {\n        \"full_name\": \"Administrator\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "3cb612707889-5", "text": "\"modified_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"created_by\": \"1\",\n    \"created_by_name\": \"Administrator\",\n    \"created_by_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"description\": \"\",\n    \"deleted\": false,\n    \"facebook\": \"\",\n    \"twitter\": \"\",\n    \"googleplus\": \"\",\n    \"account_type\": \"\",\n    \"industry\": \"\",\n    \"annual_revenue\": \"\",\n    \"phone_fax\": \"\",\n    \"billing_address_street\": \"\",\n    \"billing_address_street_2\": \"\",\n    \"billing_address_street_3\": \"\",\n    \"billing_address_street_4\": \"\",\n    \"billing_address_city\": \"\",\n    \"billing_address_state\": \"\",\n    \"billing_address_postalcode\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "3cb612707889-6", "text": "\"billing_address_state\": \"\",\n    \"billing_address_postalcode\": \"\",\n    \"billing_address_country\": \"\",\n    \"rating\": \"\",\n    \"phone_office\": \"\",\n    \"phone_alternate\": \"\",\n    \"website\": \"\",\n    \"ownership\": \"\",\n    \"employees\": \"\",\n    \"ticker_symbol\": \"\",\n    \"shipping_address_street\": \"\",\n    \"shipping_address_street_2\": \"\",\n    \"shipping_address_street_3\": \"\",\n    \"shipping_address_street_4\": \"\",\n    \"shipping_address_city\": \"\",\n    \"shipping_address_state\": \"\",\n    \"shipping_address_postalcode\": \"\",\n    \"shipping_address_country\": \"\",\n    \"parent_id\": \"\",\n    \"sic_code\": \"\",\n    \"duns_num\": \"\",\n    \"parent_name\": \"\",\n    \"member_of\": {\n        \"name\": \"\",\n        \"id\": \"\",\n        \"_acl\": { \"fields\": [], \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\" }\n    },\n    \"campaign_id\": \"\",\n    \"campaign_name\": \"\",\n    \"campaign_accounts\": {\n        \"name\": \"\",\n        \"id\": \"\",\n        \"_acl\": { \"fields\": [], \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\" }\n    },\n    \"following\": true,\n    \"my_favorite\": false,\n    \"tag\": [\n        {\n            \"id\": \"ea69c120-0ffd-11e8-b5f6-6a0001bcacb0\",\n            \"name\": \"First Tag\",\n            \"tags__name_lower\": \"first tag\"\n        },\n        {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "3cb612707889-7", "text": "\"tags__name_lower\": \"first tag\"\n        },\n        {\n            \"id\": \"eafb28e0-0ffd-11e8-8d80-6a0001bcacb0\",\n            \"name\": \"Second Tag\",\n            \"tags__name_lower\": \"second tag\"\n        }\n    ],\n    \"locked_fields\": [],\n    \"assigned_user_id\": \"\",\n    \"assigned_user_name\": \"\",\n    \"assigned_user_link\": {\n        \"full_name\": \"\",\n        \"id\": \"\",\n        \"_acl\": { \"fields\": [], \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\" }\n    },\n    \"team_count\": \"\",\n    \"team_count_link\": {\n        \"team_count\": \"\",\n        \"id\": \"1\",\n        \"_acl\": { \"fields\": [], \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\" }\n    },\n    \"team_name\": [\n        {\n            \"id\": \"1\",\n            \"name\": \"Global\",\n            \"name_2\": \"\",\n            \"primary\": true,\n            \"selected\": false\n        }\n    ],\n    \"email\": [],\n    \"email1\": \"\",\n    \"email2\": \"\",\n    \"invalid_email\": \"\",\n    \"email_opt_out\": \"\",\n    \"email_addresses_non_primary\": \"\",\n    \"calculated_c\": \"\",\n    \"_acl\": { \"fields\": {} },\n    \"_module\": \"Accounts\"\n}\nReading/Retrieving Tags", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "3cb612707889-8", "text": "\"_module\": \"Accounts\"\n}\nReading/Retrieving Tags\nNext, we can retrieve the records using the\u00c2\u00a0/Tags/:record\u00c2\u00a0GET endpoint. An\u00c2\u00a0example\u00c2\u00a0for\u00c2\u00a0retrieving the tag\u00c2\u00a0records is shown below.\u00c2\u00a0\n//Reading/Retrieving Tags - /Tags GET\n$url = $instance_url . \"/Tags/12c6ee48-1000-11e8-8838-6a0001bcacb0\";\n$curl_request = curl_init($url);\ncurl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($curl_request, CURLOPT_HEADER, false);\ncurl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($curl_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//convert arguments to json\n$json_arguments = json_encode($record);\ncurl_setopt($curl_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$curl_response = curl_exec($curl_request);\n//decode json\n$createdRecord = json_decode($curl_response);\n//display the created record\nprint_r($createdRecord);\ncurl_close($curl_request);\nMore information on this API endpoint can be found in the /<module>/:record GET documentation.\u00c2\u00a0\nRequest Payload\nNo payload is sent for this request.\nResponse\n{\n    \"id\": \"12c6ee48-1000-11e8-8838-6a0001bcacb0\",\n    \"name\": \"Tag Name\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "3cb612707889-9", "text": "\"name\": \"Tag Name\",\n    \"date_entered\": \"2018-02-12T15:21:52+01:00\",\n    \"date_modified\": \"2018-02-12T15:21:52+01:00\",\n    \"modified_user_id\": \"1\",\n    \"modified_by_name\": \"Administrator\",\n    \"modified_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"created_by\": \"1\",\n    \"created_by_name\": \"Administrator\",\n    \"created_by_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"description\": \"\",\n    \"deleted\": false,\n    \"name_lower\": \"tag name\",\n    \"following\": \"\",\n    \"my_favorite\": false,\n    \"locked_fields\": [],\n    \"source_id\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "3cb612707889-10", "text": "\"locked_fields\": [],\n    \"source_id\": \"\",\n    \"source_type\": \"\",\n    \"source_meta\": \"\",\n    \"assigned_user_id\": \"1\",\n    \"assigned_user_name\": \"Administrator\",\n    \"assigned_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"_acl\": { \"fields\": {} },\n    \"_module\": \"Tags\"\n}\nUpdating Tags\nYou\u00c2\u00a0can\u00c2\u00a0update a tag using the\u00c2\u00a0/Tags/:record PUT endpoint.\u00c2\u00a0In this example, we are going to update the\u00c2\u00a0Tag record that we created in Creating Tags section and change its name to \"Renamed Tag Name\".\n//Update Tags - /Tags PUT\n$url = $instance_url . \"/Tags/12c6ee48-1000-11e8-8838-6a0001bcacb0\";\n//Set up the new tag name\n$record = array(\n    'name' => 'Renamed Tag Name',\n);\n$curl_request = curl_init($url);\ncurl_setopt($curl_request, CURLOPT_CUSTOMREQUEST, \"PUT\");\ncurl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($curl_request, CURLOPT_HEADER, false);\ncurl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "3cb612707889-11", "text": "curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($curl_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//convert arguments to json\n$json_arguments = json_encode($record);\ncurl_setopt($curl_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$curl_response = curl_exec($curl_request);\n//decode json\n$updatedRecord = json_decode($curl_response);\n//display the created record\necho \"Updated Record Name:\" . $updatedRecord->name;\ncurl_close($curl_request);\nMore information on this API endpoint can be found in the\u00c2\u00a0/<module>/:record\u00c2\u00a0PUT documentation.\nRequest Payload\n{\"name\": \"Renamed Tag Name\"}\nResponse\n{\n    \"id\": \"12c6ee48-1000-11e8-8838-6a0001bcacb0\",\n    \"name\": \"Renamed Tag Name\",\n    \"date_entered\": \"2018-02-12T15:21:52+01:00\",\n    \"date_modified\": \"2018-02-12T16:07:18+01:00\",\n    \"modified_user_id\": \"1\",\n    \"modified_by_name\": \"Administrator\",\n    \"modified_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "3cb612707889-12", "text": "},\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"created_by\": \"1\",\n    \"created_by_name\": \"Administrator\",\n    \"created_by_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"description\": \"\",\n    \"deleted\": false,\n    \"name_lower\": \"renamed tag name\",\n    \"following\": \"\",\n    \"my_favorite\": false,\n    \"locked_fields\": [],\n    \"source_id\": \"\",\n    \"source_type\": \"\",\n    \"source_meta\": \"\",\n    \"assigned_user_id\": \"1\",\n    \"assigned_user_name\": \"Administrator\",\n    \"assigned_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "3cb612707889-13", "text": "}\n    },\n    \"_acl\": { \"fields\": {} },\n    \"_module\": \"Tags\"\n}\nDeleting Tags\nFinally, we\u00c2\u00a0can\u00c2\u00a0delete\u00c2\u00a0the record we created using the\u00c2\u00a0/Tags/:record DELETE API request.\n//Delete Tags - /Tags DELETE\n$url = $instance_url . \"/Tags/12c6ee48-1000-11e8-8838-6a0001bcacb0\";\n$curl_request = curl_init($url);\ncurl_setopt($curl_request, CURLOPT_CUSTOMREQUEST, \"DELETE\");\ncurl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($curl_request, CURLOPT_HEADER, false);\ncurl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($curl_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//execute request\n$curl_response = curl_exec($curl_request);\n//decode json\n$deletedRecord = json_decode($curl_response);\n//display the created record\necho \"Deleted Record:\" . $deletedRecord->id;\ncurl_close($curl_request);\nMore information on this API endpoint can be found in the\u00c2\u00a0/<module>/:record\u00c2\u00a0DELETE documentation.\u00c2\u00a0\nRequest Payload\nNo payload is sent for this request.\nResponse\n{\"id\":\"12c6ee48-1000-11e8-8838-6a0001bcacb0\"}\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "ad5536074330-0", "text": "How to Manipulate File Attachments\nOverview\nA PHP example\u00c2\u00a0demonstrating how to attach a file to a record using the v11 <module>/:record/file/:field\u00c2\u00a0REST POST\u00c2\u00a0API endpoint, then retrieve it with the GET endpoint.\nManipulating File Attachments\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\n<?php\n$instance_url = \"http://{site_url}/rest/v11\";\n$username = \"admin\";\n$password = \"password\";\n//Login - POST /oauth2/token\n$auth_url = $instance_url . \"/oauth2/token\";\n$oauth2_token_arguments = array(\n    \"grant_type\" => \"password\",\n    //client id - default is sugar. \n    //It is recommended to create your own in Admin > OAuth Keys\n    \"client_id\" => \"sugar\", \n    \"client_secret\" => \"\",\n    \"username\" => $username,\n    \"password\" => $password,\n    //platform type - default is base.\n    //It is recommend to change the platform to a custom name such as \"custom_api\" to avoid authentication conflicts.\n    \"platform\" => \"custom_api\" \n);\n$auth_request = curl_init($auth_url);\ncurl_setopt($auth_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($auth_request, CURLOPT_HEADER, false);\ncurl_setopt($auth_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($auth_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($auth_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($auth_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\"\n));\n//convert arguments to json\n$json_arguments = json_encode($oauth2_token_arguments);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_File_Attachments/index.html"}
{"id": "ad5536074330-1", "text": "));\n//convert arguments to json\n$json_arguments = json_encode($oauth2_token_arguments);\ncurl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$oauth2_token_response = curl_exec($auth_request);\n//decode oauth2 response to get token\n$oauth2_token_response_obj = json_decode($oauth2_token_response);\n$oauth_token = $oauth2_token_response_obj->access_token;\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nSubmitting a File Attachment\nNext, we can create a Note record using the /<module endpoint, and then\u00c2\u00a0submit\u00c2\u00a0a File to the Note\u00c2\u00a0record\u00c2\u00a0using the /<module>/:record/file/:field\u00c2\u00a0endpoint.\n//Create Note - POST /\n$url = $instance_url . \"/Notes\";\n//Set up the Record details\n$record = array(\n    'name' => 'Test Note'\n);\n$curl_request = curl_init($url);\ncurl_setopt($curl_request, CURLOPT_POST, 1);\ncurl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($curl_request, CURLOPT_HEADER, false);\ncurl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($curl_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//convert arguments to json\n$json_arguments = json_encode($record);\ncurl_setopt($curl_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$curl_response = curl_exec($curl_request);\n//decode json", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_File_Attachments/index.html"}
{"id": "ad5536074330-2", "text": "//execute request\n$curl_response = curl_exec($curl_request);\n//decode json\n$noteRecord = json_decode($curl_response);\n//display the created record\necho \"Created Record: \". $noteRecord->id;\ncurl_close($curl_request);\n//Add An Attachment to the Note\n$url = $instance_url . \"/Notes/{$noteRecord->id}/file/filename\";\n$file_arguments = array(\n    \"format\" => \"sugar-html-json\",\n    \"delete_if_fails\" => true,\n    \"oauth_token\" => $oauth_token,\n);\nif ((version_compare(PHP_VERSION, '5.5') >= 0)) {\n    $file_arguments['filename'] = new CURLFile($path);\n} else {\n    $file_arguments['filename'] = '@'.$path;\n}\n$curl_request = curl_init($url);\ncurl_setopt($curl_request, CURLOPT_POST, 1);\ncurl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($curl_request, CURLOPT_HEADER, false);\ncurl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\n//Do NOT set Content Type Header to JSON\ncurl_setopt($curl_request, CURLOPT_HTTPHEADER, array(\n    \"oauth-token: {$oauth_token}\"\n));\ncurl_setopt($curl_request, CURLOPT_POSTFIELDS, $file_arguments);\n//execute request\n$curl_response = curl_exec($curl_request);\n//decode json\n$noteRecord = json_decode($curl_response);\n//print Note with attachment details\nprint_r($noteRecord);\ncurl_close($curl_request);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_File_Attachments/index.html"}
{"id": "ad5536074330-3", "text": "print_r($noteRecord);\ncurl_close($curl_request);\nNote: As of PHP 5.6, the '@' upload modifier is disabled for security reasons by the CURLOPT_SAFE_UPLOAD option. We recommending using CURLFILE if using PHP >= 5.5, If you would prefer\u00c2\u00a0to use the upload modifier, you can set the CURLOPT_SAFE_UPLOAD option to false.\ncurl_setopt($ch, CURLOPT_SAFE_UPLOAD, false);\nRequest\n//Raw Post - not json encoded\nArray\n(\n    [format] => sugar-html-json\n    [delete_if_fails] => 1\n    [oauth_token] => 09eac950-c99e-4786-8b10-a3670f38fb3f\n    [filename] => CURLFile Object\n        (\n            [name] => /Library/WebServer/Documents/file_attachment_manipulation/testfile.txt\n            [mime] => \n            [postname] => \n        )\n)\nResponse\n{\n  \"filename\":{\n     \"content-type\":\"text\\/plain\",\n     \"content-length\":13,\n     \"name\":\"upload.txt\",\n     \"uri\":\"http:\\/\\/<site url>\\/rest\\/v11\\/Notes\\/7b49aebd-8734-9773-8ef1-53553fa369c7\\/file\\/filename\"\n  },\n  \"record\":{\n     \"my_favorite\":false,\n     \"following\":true,\n     \"id\":\"7b49aebd-8734-9773-8ef1-53553fa369c7\",\n     \"name\":\"My Note\",\n     \"date_modified\":\"2014-04-21T11:53:53-04:00\",\n     \"modified_user_id\":\"1\",\n     \"modified_by_name\":\"admin\",\n     \"created_by\":\"1\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_File_Attachments/index.html"}
{"id": "ad5536074330-4", "text": "\"modified_by_name\":\"admin\",\n     \"created_by\":\"1\",\n     \"created_by_name\":\"Administrator\",\n     \"doc_owner\":\"\",\n     \"user_favorites\":[\n     ],\n     \"description\":\"\",\n     \"deleted\":false,\n     \"assigned_user_id\":\"\",\n     \"assigned_user_name\":\"\",\n     \"team_count\":\"\",\n     \"team_name\":[\n        {\n           \"id\":1,\n           \"name\":\"Global\",\n           \"name_2\":\"\",\n           \"primary\":true\n        }\n     ],\n     \"file_mime_type\":\"text\\/plain\",\n     \"file_url\":\"\",\n     \"filename\":\"upload.txt\",\n     \"parent_type\":\"\",\n     \"parent_id\":\"\",\n     \"contact_id\":\"\",\n     \"portal_flag\":false,\n     \"embed_flag\":false,\n     \"parent_name\":\"\",\n     \"contact_name\":\"\",\n     \"contact_phone\":\"\",\n     \"contact_email\":\"\",\n     \"account_id\":\"\",\n     \"opportunity_id\":\"\",\n     \"acase_id\":\"\",\n     \"lead_id\":\"\",\n     \"product_id\":\"\",\n     \"quote_id\":\"\",\n     \"_acl\":{\n        \"fields\":{\n        }\n     },\n     \"_module\":\"Notes\"\n  }\n}\nGetting a File Attachment\nNext, we can retrieve\u00c2\u00a0the file attachment stored in Sugar by utilizing the\u00c2\u00a0/<module>/:record/file/:field\u00c2\u00a0GET endpoint. The following code example, works when being accessed via a web browser, as it receives the response from Sugar, and sets the Headers received from Sugar on itself, so that the browser knows to download a\u00c2\u00a0file.\n//Get An Attachment on a Note\n$url = $instance_url . \"/Notes/{$noteRecord->id}/file/filename\";", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_File_Attachments/index.html"}
{"id": "ad5536074330-5", "text": "$url = $instance_url . \"/Notes/{$noteRecord->id}/file/filename\";\n$curl_request = curl_init($url);\ncurl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\n//Return Headers\ncurl_setopt($curl_request, CURLOPT_HEADER, true);\ncurl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\n//DO NOT set Content Type Header to JSON\ncurl_setopt($curl_request, CURLOPT_HTTPHEADER, array(\n    \"oauth-token: {$oauth_token}\"\n));\n//execute request\n$curl_response = curl_exec($curl_request);\n//Get Return Headers\n$header_size = curl_getinfo($curl_request,CURLINFO_HEADER_SIZE);\n$headers = substr($curl_response, 0, $header_size);\n//Outputting the file contents\necho 'File saved to download.txt';\n$file = substr($curl_response, $header_size);\nfile_put_contents('download.txt', $file);\ncurl_close($curl_request);\nRequest\nhttp://{site_url}/rest/v11/Notes/bd490e66-2ea7-9349-19cf-535569400cca/file/filename\nNote: GET request arguments are passed in the form of a query string.\nResponse\nHTTP/1.1 200 OK\nDate: Wed, 12 Mar 2014 15:15:03 GMT\nServer: Apache/2.2.22 (Unix) PHP/5.3.14 mod_ssl/2.2.22 OpenSSL/0.9.8o\nX-Powered-By: PHP/5.3.14 ZendServer/5.0\nSet-Cookie: ZDEDebuggerPresent=php,phtml,php3; path=/\nExpires:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_File_Attachments/index.html"}
{"id": "ad5536074330-6", "text": "Expires:\nCache-Control: max-age=0, private\nPragma:\nContent-Disposition: attachment; filename=\"upload.txt\"\nX-Content-Type-Options: nosniff\nETag: d41d8cd98f00b204e9800998ecf8427e\nContent-Length: 16\nConnection: close\nContent-Type: application/octet-stream\nThis is the file contents.\nDownload\nYou can download the full API example here.\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Manipulate_File_Attachments/index.html"}
{"id": "66272cebee73-0", "text": "How to Check for Duplicate Records\nOverview\nAn PHP example\u00c2\u00a0demonstrating how to check for duplicate\u00c2\u00a0records using the v11 /<module>/duplicateCheck\u00c2\u00a0REST POST\u00c2\u00a0endpoint.\nDuplicate Records\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\n<?php\n$instance_url = \"http://{site_url}/rest/v11\";\n$username = \"admin\";\n$password = \"password\";\n//Login - POST /oauth2/token\n$auth_url = $instance_url . \"/oauth2/token\";\n$oauth2_token_arguments = array(\n    \"grant_type\" => \"password\",\n    //client id - default is sugar. \n    //It is recommended to create your own in Admin > OAuth Keys\n    \"client_id\" => \"sugar\", \n    \"client_secret\" => \"\",\n    \"username\" => $username,\n    \"password\" => $password,\n    //platform type - default is base.\n    //It is recommend to change the platform to a custom name such as \"custom_api\" to avoid authentication conflicts.\n    \"platform\" => \"custom_api\" \n);\n$auth_request = curl_init($auth_url);\ncurl_setopt($auth_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($auth_request, CURLOPT_HEADER, false);\ncurl_setopt($auth_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($auth_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($auth_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($auth_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\"\n));\n//convert arguments to json\n$json_arguments = json_encode($oauth2_token_arguments);\ncurl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Check_for_Duplicate_Records/index.html"}
{"id": "66272cebee73-1", "text": "curl_setopt($auth_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$oauth2_token_response = curl_exec($auth_request);\n//decode oauth2 response to get token\n$oauth2_token_response_obj = json_decode($oauth2_token_response);\n$oauth_token = $oauth2_token_response_obj->access_token;\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nRetrieving Duplicates\nNext, we will need to identify the records that are duplicates\u00c2\u00a0using the /<module>/duplicateCheck\u00c2\u00a0endpoint.\n//Check for duplicate records - POST /<module>/duplicateCheck\n$url = $instance_url . \"/Accounts/duplicateCheck\";\n//Set up the Record details\n$record = array(\n    'name' => 'Test Record',\n);\n$curl_request = curl_init($url);\ncurl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);\ncurl_setopt($curl_request, CURLOPT_HEADER, false);\ncurl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);\ncurl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);\ncurl_setopt($curl_request, CURLOPT_HTTPHEADER, array(\n    \"Content-Type: application/json\",\n    \"oauth-token: {$oauth_token}\"\n));\n//convert arguments to json\n$json_arguments = json_encode($record);\ncurl_setopt($curl_request, CURLOPT_POSTFIELDS, $json_arguments);\n//execute request\n$curl_response = curl_exec($curl_request);\n//decode json\n$createdRecord = json_decode($curl_response);\n//display the created record\nprint_r($createdRecord);\ncurl_close($curl_request);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Check_for_Duplicate_Records/index.html"}
{"id": "66272cebee73-2", "text": "//display the created record\nprint_r($createdRecord);\ncurl_close($curl_request);\nMore information on the filter API\u00c2\u00a0can be found in the /<module>/duplicateCheck documentation.\nRequest Payload\nThe data sent to the server is shown below:\n{\n   \"name\":\"Test Record\"\n}\nResponse\nThe data received from the server is shown below:\n{\n    \"next_offset\": -1,\n    \"records\": [{\n        \"id\": \"7f6ea7be-60d6-11e6-8885-a0999b033b33\",\n        \"name\": \"Test Record\",\n        \"date_entered\": \"2016-08-12T14:48:25-07:00\",\n        \"date_modified\": \"2016-08-12T14:48:25-07:00\",\n        \"modified_user_id\": \"1\",\n        \"modified_by_name\": \"Administrator\",\n        \"modified_user_link\": {\n            \"full_name\": \"Administrator\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": [],\n                \"delete\": \"no\",\n                \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n            }\n        },\n        \"created_by\": \"1\",\n        \"created_by_name\": \"Administrator\",\n        \"created_by_link\": {\n            \"full_name\": \"Administrator\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": [],\n                \"delete\": \"no\",\n                \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n            }\n        },\n        \"description\": \"Test Data 1\",\n        \"deleted\": false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Check_for_Duplicate_Records/index.html"}
{"id": "66272cebee73-3", "text": "\"description\": \"Test Data 1\",\n        \"deleted\": false,\n        \"facebook\": \"\",\n        \"twitter\": \"\",\n        \"googleplus\": \"\",\n        \"account_type\": \"\",\n        \"industry\": \"\",\n        \"annual_revenue\": \"\",\n        \"phone_fax\": \"\",\n        \"billing_address_street\": \"\",\n        \"billing_address_street_2\": \"\",\n        \"billing_address_street_3\": \"\",\n        \"billing_address_street_4\": \"\",\n        \"billing_address_city\": \"\",\n        \"billing_address_state\": \"\",\n        \"billing_address_postalcode\": \"\",\n        \"billing_address_country\": \"\",\n        \"rating\": \"\",\n        \"phone_office\": \"\",\n        \"phone_alternate\": \"\",\n        \"website\": \"\",\n        \"ownership\": \"\",\n        \"employees\": \"\",\n        \"ticker_symbol\": \"\",\n        \"shipping_address_street\": \"\",\n        \"shipping_address_street_2\": \"\",\n        \"shipping_address_street_3\": \"\",\n        \"shipping_address_street_4\": \"\",\n        \"shipping_address_city\": \"\",\n        \"shipping_address_state\": \"\",\n        \"shipping_address_postalcode\": \"\",\n        \"shipping_address_country\": \"\",\n        \"parent_id\": \"\",\n        \"sic_code\": \"\",\n        \"duns_num\": \"\",\n        \"parent_name\": \"\",\n        \"member_of\": {\n            \"name\": \"\",\n            \"id\": \"\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"campaign_id\": \"\",\n        \"campaign_name\": \"\",\n        \"campaign_accounts\": {\n            \"name\": \"\",\n            \"id\": \"\",\n            \"_acl\": {\n                \"fields\": [],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Check_for_Duplicate_Records/index.html"}
{"id": "66272cebee73-4", "text": "\"id\": \"\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"following\": true,\n        \"my_favorite\": false,\n        \"tag\": [],\n        \"assigned_user_id\": \"1\",\n        \"assigned_user_name\": \"Administrator\",\n        \"assigned_user_link\": {\n            \"full_name\": \"Administrator\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": [],\n                \"delete\": \"no\",\n                \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n            }\n        },\n        \"team_count\": \"\",\n        \"team_count_link\": {\n            \"team_count\": \"\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"team_name\": [{\n            \"id\": \"1\",\n            \"name\": \"Global\",\n            \"name_2\": \"\",\n            \"primary\": true\n        }],\n        \"email\": [],\n        \"email1\": \"\",\n        \"email2\": \"\",\n        \"invalid_email\": \"\",\n        \"email_opt_out\": \"\",\n        \"email_addresses_non_primary\": \"\",\n        \"_acl\": {\n            \"fields\": {}\n        },\n        \"_module\": \"Accounts\",\n        \"duplicate_check_rank\": 8\n    }, {\n        \"id\": \"868b4f16-60d6-11e6-bdfc-a0999b033b33\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Check_for_Duplicate_Records/index.html"}
{"id": "66272cebee73-5", "text": "\"name\": \"Test Record\",\n        \"date_entered\": \"2016-08-12T14:48:37-07:00\",\n        \"date_modified\": \"2016-08-12T14:48:37-07:00\",\n        \"modified_user_id\": \"1\",\n        \"modified_by_name\": \"Administrator\",\n        \"modified_user_link\": {\n            \"full_name\": \"Administrator\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": [],\n                \"delete\": \"no\",\n                \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n            }\n        },\n        \"created_by\": \"1\",\n        \"created_by_name\": \"Administrator\",\n        \"created_by_link\": {\n            \"full_name\": \"Administrator\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": [],\n                \"delete\": \"no\",\n                \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n            }\n        },\n        \"description\": \"Test Data 2\",\n        \"deleted\": false,\n        \"facebook\": \"\",\n        \"twitter\": \"\",\n        \"googleplus\": \"\",\n        \"account_type\": \"\",\n        \"industry\": \"\",\n        \"annual_revenue\": \"\",\n        \"phone_fax\": \"\",\n        \"billing_address_street\": \"\",\n        \"billing_address_street_2\": \"\",\n        \"billing_address_street_3\": \"\",\n        \"billing_address_street_4\": \"\",\n        \"billing_address_city\": \"\",\n        \"billing_address_state\": \"\",\n        \"billing_address_postalcode\": \"\",\n        \"billing_address_country\": \"\",\n        \"rating\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Check_for_Duplicate_Records/index.html"}
{"id": "66272cebee73-6", "text": "\"billing_address_country\": \"\",\n        \"rating\": \"\",\n        \"phone_office\": \"\",\n        \"phone_alternate\": \"\",\n        \"website\": \"\",\n        \"ownership\": \"\",\n        \"employees\": \"\",\n        \"ticker_symbol\": \"\",\n        \"shipping_address_street\": \"\",\n        \"shipping_address_street_2\": \"\",\n        \"shipping_address_street_3\": \"\",\n        \"shipping_address_street_4\": \"\",\n        \"shipping_address_city\": \"\",\n        \"shipping_address_state\": \"\",\n        \"shipping_address_postalcode\": \"\",\n        \"shipping_address_country\": \"\",\n        \"parent_id\": \"\",\n        \"sic_code\": \"\",\n        \"duns_num\": \"\",\n        \"parent_name\": \"\",\n        \"member_of\": {\n            \"name\": \"\",\n            \"id\": \"\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"campaign_id\": \"\",\n        \"campaign_name\": \"\",\n        \"campaign_accounts\": {\n            \"name\": \"\",\n            \"id\": \"\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"following\": true,\n        \"my_favorite\": false,\n        \"tag\": [],\n        \"assigned_user_id\": \"1\",\n        \"assigned_user_name\": \"Administrator\",\n        \"assigned_user_link\": {\n            \"full_name\": \"Administrator\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": [],\n                \"delete\": \"no\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Check_for_Duplicate_Records/index.html"}
{"id": "66272cebee73-7", "text": "\"_acl\": {\n                \"fields\": [],\n                \"delete\": \"no\",\n                \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n            }\n        },\n        \"team_count\": \"\",\n        \"team_count_link\": {\n            \"team_count\": \"\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"team_name\": [{\n            \"id\": \"1\",\n            \"name\": \"Global\",\n            \"name_2\": \"\",\n            \"primary\": true\n        }],\n        \"email\": [],\n        \"email1\": \"\",\n        \"email2\": \"\",\n        \"invalid_email\": \"\",\n        \"email_opt_out\": \"\",\n        \"email_addresses_non_primary\": \"\",\n        \"_acl\": {\n            \"fields\": {}\n        },\n        \"_module\": \"Accounts\",\n        \"duplicate_check_rank\": 8\n    }]\n}\nDownload\nYou can download the full API example here.\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/PHP/How_to_Check_for_Duplicate_Records/index.html"}
{"id": "b866039dc539-0", "text": "Bash\nBash cURL\u00c2\u00a0examples of integrating with\u00c2\u00a0the REST v11 API.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/index.html"}
{"id": "b866039dc539-1", "text": "TopicsHow to Export a List of RecordsAn example in bash script demonstrating how to export a list of records using the v11 /<module>/export/:record_list_id REST GET endpoint.How to Filter a List of RecordsAn example in bash script demonstrating how to filter records using the v11 /<module>/filter REST POST endpoints.How to Favorite a RecordAn example in bash script demonstrating how to favorite a record using the v11 <module>/:record/favorite REST PUT API endpoint.How to Manipulate File AttachmentsAn example in bash script demonstrating how to attach a file to a record using the v11 <module>/:record/file/:field REST POST API endpoint, then retrieve it with the GET endpoint.How to Fetch Related RecordsAn example in bash script demonstrating how to fetch related records using the v11 /<module>/:record/link/:link REST GET endpoints.How to Manipulate Records (CRUD)The following page will provide examples in bash script demonstrating how to use the CRUD (Create, Read, Update, Delete) endpoints in the REST v11 API.How to Follow a RecordAn example in bash script demonstrating how to follow a record using the v11 /<module>/:record/subscribe REST POST endpoint.How to Unfavorite a RecordAn example in bash script demonstrating how to unfavorite a record using the v11 /<module>/:record/unfavorite REST PUT endpoint.How to Unfollow a RecordAn example in bash script demonstrating how to unfollow a record using the v11 /<module>/:record/unsubscribe REST DELETE endpoint.How to Get the Most Active UsersAn example in bash script demonstrating how to fetch the most active users for meetings, calls, inbound emails, and outbound emails using the v11 /mostactiveusers REST GET endpoint.How to Authenticate and Log OutAn example in bash script on how to authenticate and logout of the v11 REST API using the /oauth2/token and /oauth2/logout POST endpoints.How to PingAn example in bash script demonstrating how", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/index.html"}
{"id": "b866039dc539-2", "text": "and /oauth2/logout POST endpoints.How to PingAn example in bash script demonstrating how to ping using the REST v11 /ping GET endpoint.How to Fetch the Current Users TimeAn example in bash script demonstrating how to fetch the current users time with the v11 /ping/whattimeisit REST GET endpoint.How to Fetch Recently Viewed RecordsAn example in bash script demonstrating how to retrieve recently viewed records using the v11 /recent REST GET endpoint.How to Use the Global SearchAn example in bash script demonstrating how to globally search for records using the REST v11 /search GET endpoint.How to Check for Duplicate RecordsAn example in bash script demonstrating how to check for duplicate records using the v11 /<module>/duplicateCheck REST POST endpoint.How to Manipulate QuotesA Bash example demonstrating how to manipulate Quotes and related record data such as ProductBundles, Products, and ProductBundleNotes.How to Manipulate Tags (CRUD)The following page will provide examples of bash script demonstrating how to use the CRUD (Create, Read, Update, Delete) endpoints for tags in the REST v11 API.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/index.html"}
{"id": "b866039dc539-3", "text": "Last modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/index.html"}
{"id": "586db57b4003-0", "text": "How to Fetch Related Records\nOverview\nAn example\u00c2\u00a0in bash script demonstrating how to fetch related records\u00c2\u00a0using the v11\u00c2\u00a0/<module>/:record/link/:link REST GET endpoints.\nFetching Related Records\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\ncurl -X POST -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{ \n \"grant_type\":\"password\",\n \"client_id\":\"sugar\",\n \"client_secret\":\"\",\n \"username\":\"admin\",\n \"password\":\"password\",\n \"platform\":\"custom_api\"\n}' https://{site_url}/rest/v11/oauth2/token\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nFetching Related Records\nNext, we can fetch the related records we want to return\u00c2\u00a0using the\u00c2\u00a0/<module>/:record/link/:link endpoint with a GET request where\nElement\nMeaning\n<module>\nThe parent module name\n:record\nThe parent records ID\nlink\nthe actual word \"link\"\n:link\nThe name of the relationship to fetch\u00c2\u00a0\nIn this example we will fetch the related Contacts for an Account :\ncurl -s -X GET -H OAuth-Token:{access_token} -H Cache-Control:no-cache https://{site_url}/rest/v11/Accounts/e8c641ca-1b8c-74c1-d08d-56fedbdd3187/link/contacts\nResponse\nThe data received from the server is shown below:\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"819f4149-b007-a6da-a5fa-56fedbf2de77\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_Related_Records/index.html"}
{"id": "586db57b4003-1", "text": "\"name\":\"Florine Marcus\",\n         \"date_entered\":\"2016-04-01T15:34:00-05:00\",\n         \"date_modified\":\"2016-04-01T15:34:00-05:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"user_favorites\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_will_id\",\n         \"assigned_user_name\":\"Will Westin\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":true\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":false\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"support27@example.tv\",\n               \"primary_address\":true,\n               \"reply_to_address\":false,\n               \"invalid_email\":false,\n               \"opt_out\":false\n            },\n            {\n               \"email_address\":\"support.support.kid@example.net\",\n               \"primary_address\":false,\n               \"reply_to_address\":false,\n               \"invalid_email\":false,\n               \"opt_out\":true\n            }\n         ],\n         \"email1\":\"support27@example.tv\",\n         \"email2\":\"\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"salutation\":\"\",\n         \"first_name\":\"Florine\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_Related_Records/index.html"}
{"id": "586db57b4003-2", "text": "\"salutation\":\"\",\n         \"first_name\":\"Florine\",\n         \"last_name\":\"Marcus\",\n         \"full_name\":\"Florine Marcus\",\n         \"title\":\"President\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(746) 162-2314\",\n         \"phone_mobile\":\"(941) 088-2874\",\n         \"phone_work\":\"(827) 541-9614\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"primary_address_street\":\"1715 Scott Dr\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Alabama\",\n         \"primary_address_state\":\"NY\",\n         \"primary_address_postalcode\":\"70187\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Employee\",\n         \"account_name\":\"MTM Investment Bank F S B\",\n         \"account_id\":\"e8c641ca-1b8c-74c1-d08d-56fedbdd3187\",\n         \"dnb_principal_id\":\"\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_Related_Records/index.html"}
{"id": "586db57b4003-3", "text": "\"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"birthdate\":\"\",\n         \"portal_name\":\"FlorineMarcus119\",\n         \"portal_active\":true,\n         \"portal_password\":true,\n         \"portal_password1\":null,\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"accept_status_calls\":\"\",\n         \"accept_status_meetings\":\"\",\n         \"sync_contact\":false,\n         \"mkto_sync\":false,\n         \"mkto_id\":null,\n         \"mkto_lead_score\":null,\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Contacts\"\n      },\n      {\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"527cc1a9-7984-91fe-4148-56fedbc356aa\",\n         \"name\":\"Shaneka Aceto\",\n         \"date_entered\":\"2016-04-01T15:34:00-05:00\",\n         \"date_modified\":\"2016-04-01T15:34:00-05:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"user_favorites\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_will_id\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_Related_Records/index.html"}
{"id": "586db57b4003-4", "text": "\"deleted\":false,\n         \"assigned_user_id\":\"seed_will_id\",\n         \"assigned_user_name\":\"Will Westin\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":true\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":false\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"support17@example.cn\",\n               \"primary_address\":true,\n               \"reply_to_address\":false,\n               \"invalid_email\":false,\n               \"opt_out\":false\n            },\n            {\n               \"email_address\":\"section.sugar.the@example.tv\",\n               \"primary_address\":false,\n               \"reply_to_address\":false,\n               \"invalid_email\":false,\n               \"opt_out\":true\n            }\n         ],\n         \"email1\":\"support17@example.cn\",\n         \"email2\":\"\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"salutation\":\"\",\n         \"first_name\":\"Shaneka\",\n         \"last_name\":\"Aceto\",\n         \"full_name\":\"Shaneka Aceto\",\n         \"title\":\"IT Developer\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(502) 528-5151\",\n         \"phone_mobile\":\"(816) 719-3739\",\n         \"phone_work\":\"(994) 769-5855\",\n         \"phone_other\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_Related_Records/index.html"}
{"id": "586db57b4003-5", "text": "\"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"primary_address_street\":\"123 Anywhere Street\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"NY\",\n         \"primary_address_postalcode\":\"15128\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Email\",\n         \"account_name\":\"MTM Investment Bank F S B\",\n         \"account_id\":\"e8c641ca-1b8c-74c1-d08d-56fedbdd3187\",\n         \"dnb_principal_id\":\"\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"birthdate\":\"\",\n         \"portal_name\":\"ShanekaAceto151\",\n         \"portal_active\":true,\n         \"portal_password\":true,\n         \"portal_password1\":null,\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"accept_status_calls\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_Related_Records/index.html"}
{"id": "586db57b4003-6", "text": "\"accept_status_name\":\"\",\n         \"accept_status_calls\":\"\",\n         \"accept_status_meetings\":\"\",\n         \"sync_contact\":false,\n         \"mkto_sync\":false,\n         \"mkto_id\":null,\n         \"mkto_lead_score\":null,\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Contacts\"\n      },\n      {\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"42d703ed-f834-f87c-967d-56fedb044051\",\n         \"name\":\"Johnnie Pina\",\n         \"date_entered\":\"2016-04-01T15:34:00-05:00\",\n         \"date_modified\":\"2016-04-01T15:34:00-05:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"user_favorites\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_will_id\",\n         \"assigned_user_name\":\"Will Westin\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":true\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":false\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"sugar.support.hr@example.co.uk\",\n               \"primary_address\":true,\n               \"reply_to_address\":false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_Related_Records/index.html"}
{"id": "586db57b4003-7", "text": "\"primary_address\":true,\n               \"reply_to_address\":false,\n               \"invalid_email\":false,\n               \"opt_out\":false\n            },\n            {\n               \"email_address\":\"support.im@example.tw\",\n               \"primary_address\":false,\n               \"reply_to_address\":false,\n               \"invalid_email\":false,\n               \"opt_out\":true\n            }\n         ],\n         \"email1\":\"sugar.support.hr@example.co.uk\",\n         \"email2\":\"\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"salutation\":\"\",\n         \"first_name\":\"Johnnie\",\n         \"last_name\":\"Pina\",\n         \"full_name\":\"Johnnie Pina\",\n         \"title\":\"VP Operations\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(159) 335-1423\",\n         \"phone_mobile\":\"(580) 140-4050\",\n         \"phone_work\":\"(418) 792-9611\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"primary_address_street\":\"345 Sugar Blvd.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"NY\",\n         \"primary_address_postalcode\":\"70648\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_Related_Records/index.html"}
{"id": "586db57b4003-8", "text": "\"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Direct Mail\",\n         \"account_name\":\"MTM Investment Bank F S B\",\n         \"account_id\":\"e8c641ca-1b8c-74c1-d08d-56fedbdd3187\",\n         \"dnb_principal_id\":\"\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"birthdate\":\"\",\n         \"portal_name\":\"JohnniePina194\",\n         \"portal_active\":true,\n         \"portal_password\":true,\n         \"portal_password1\":null,\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"accept_status_calls\":\"\",\n         \"accept_status_meetings\":\"\",\n         \"sync_contact\":false,\n         \"mkto_sync\":false,\n         \"mkto_id\":null,\n         \"mkto_lead_score\":null,\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Contacts\"\n      }\n   ]\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_Related_Records/index.html"}
{"id": "83657dcab57a-0", "text": "How to Unfavorite a Record\nOverview\nAn example\u00c2\u00a0in bash script demonstrating how to unfavorite a record using the v11\u00c2\u00a0/<module>/:record/unfavorite REST PUT\u00c2\u00a0endpoint.\nUnfavoriting a Record\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\ncurl -X POST -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{ \n \"grant_type\":\"password\",\n \"client_id\":\"sugar\",\n \"client_secret\":\"\",\n \"username\":\"admin\",\n \"password\":\"password\",\n \"platform\":\"custom_api\"\n}' https://{site_url}/rest/v11/oauth2/token\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nUnfavoriting a Record\nNext, we can unfavorite\u00c2\u00a0a specific record\u00c2\u00a0using the /<module>/:record/unfavorite\u00c2\u00a0endpoint.\ncurl -s -X PUT -H OAuth-Token:{access_token} -H Cache-Control:no-cache https://{site_url}/rest/v11/Accounts/ae8b1783-404a-fcb8-1e1e-56f1cc52cd1a/unfavorite\nMore information on the unfavorite API\u00c2\u00a0can be found in the /<module>/:record/unfavorite PUT\u00c2\u00a0documentation.\nResponse\nThe data received from the server is shown below:\n{\n    \"id\": \"ae8b1783-404a-fcb8-1e1e-56f1cc52cd1a\",\n    \"name\": \"Union Bank\",\n    \"date_entered\": \"2016-03-22T17:49:50-05:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Unfavorite_a_Record/index.html"}
{"id": "83657dcab57a-1", "text": "\"date_modified\": \"2016-03-30T17:44:20-05:00\",\n    \"modified_user_id\": \"1\",\n    \"modified_by_name\": \"Administrator\",\n    \"modified_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": [],\n            \"delete\": \"no\",\n            \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n        }\n    },\n    \"created_by\": \"1\",\n    \"created_by_name\": \"Administrator\",\n    \"created_by_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": [],\n            \"delete\": \"no\",\n            \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n        }\n    },\n    \"description\": \"\",\n    \"deleted\": false,\n    \"facebook\": \"\",\n    \"twitter\": \"\",\n    \"googleplus\": \"\",\n    \"account_type\": \"Customer\",\n    \"industry\": \"Banking\",\n    \"annual_revenue\": \"\",\n    \"phone_fax\": \"\",\n    \"billing_address_street\": \"67321 West Siam St.\",\n    \"billing_address_street_2\": \"\",\n    \"billing_address_street_3\": \"\",\n    \"billing_address_street_4\": \"\",\n    \"billing_address_city\": \"Ohio\",\n    \"billing_address_state\": \"CA\",\n    \"billing_address_postalcode\": \"25159\",\n    \"billing_address_country\": \"USA\",\n    \"rating\": \"\",\n    \"phone_office\": \"(065) 489-6104\",\n    \"phone_alternate\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Unfavorite_a_Record/index.html"}
{"id": "83657dcab57a-2", "text": "\"phone_alternate\": \"\",\n    \"website\": \"www.qahr.edu\",\n    \"ownership\": \"\",\n    \"employees\": \"\",\n    \"ticker_symbol\": \"\",\n    \"shipping_address_street\": \"67321 West Siam St.\",\n    \"shipping_address_street_2\": \"\",\n    \"shipping_address_street_3\": \"\",\n    \"shipping_address_street_4\": \"\",\n    \"shipping_address_city\": \"Ohio\",\n    \"shipping_address_state\": \"CA\",\n    \"shipping_address_postalcode\": \"25159\",\n    \"shipping_address_country\": \"USA\",\n    \"parent_id\": \"\",\n    \"sic_code\": \"\",\n    \"duns_num\": \"\",\n    \"parent_name\": \"\",\n    \"member_of\": {\n        \"name\": \"\",\n        \"id\": \"\",\n        \"_acl\": {\n            \"fields\": [],\n            \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n        }\n    },\n    \"campaign_id\": \"\",\n    \"campaign_name\": \"\",\n    \"campaign_accounts\": {\n        \"name\": \"\",\n        \"id\": \"\",\n        \"_acl\": {\n            \"fields\": [],\n            \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n        }\n    },\n    \"following\": true,\n    \"my_favorite\": false,\n    \"tag\": [],\n    \"assigned_user_id\": \"seed_sarah_id\",\n    \"assigned_user_name\": \"Sarah Smith\",\n    \"assigned_user_link\": {\n        \"full_name\": \"Sarah Smith\",\n        \"id\": \"seed_sarah_id\",\n        \"_acl\": {\n            \"fields\": [],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Unfavorite_a_Record/index.html"}
{"id": "83657dcab57a-3", "text": "\"_acl\": {\n            \"fields\": [],\n            \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n        }\n    },\n    \"team_count\": \"\",\n    \"team_count_link\": {\n        \"team_count\": \"\",\n        \"id\": \"West\",\n        \"_acl\": {\n            \"fields\": [],\n            \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n        }\n    },\n    \"team_name\": [{\n        \"id\": \"East\",\n        \"name\": \"East\",\n        \"name_2\": \"\",\n        \"primary\": false\n    }, {\n        \"id\": 1,\n        \"name\": \"Global\",\n        \"name_2\": \"\",\n        \"primary\": false\n    }, {\n        \"id\": \"West\",\n        \"name\": \"West\",\n        \"name_2\": \"\",\n        \"primary\": true\n    }],\n    \"email\": [{\n        \"email_address\": \"hr.support.kid@example.info\",\n        \"invalid_email\": false,\n        \"opt_out\": false,\n        \"primary_address\": true,\n        \"reply_to_address\": false\n    }, {\n        \"email_address\": \"info.support.the@example.com\",\n        \"invalid_email\": false,\n        \"opt_out\": false,\n        \"primary_address\": false,\n        \"reply_to_address\": false\n    }],\n    \"email1\": \"hr.support.kid@example.info\",\n    \"email2\": \"info.support.the@example.com\",\n    \"invalid_email\": false,\n    \"email_opt_out\": false,\n    \"email_addresses_non_primary\": \"\",\n    \"_acl\": {\n        \"fields\": {}\n    },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Unfavorite_a_Record/index.html"}
{"id": "83657dcab57a-4", "text": "\"_acl\": {\n        \"fields\": {}\n    },\n    \"_module\": \"Accounts\"\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Unfavorite_a_Record/index.html"}
{"id": "dde554390604-0", "text": "How to Use the Global Search\nOverview\nAn example\u00c2\u00a0in bash script demonstrating how to globally search for records\u00c2\u00a0using the REST v11\u00c2\u00a0/search GET endpoint.\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\ncurl -X POST -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{ \n \"grant_type\":\"password\",\n \"client_id\":\"sugar\",\n \"client_secret\":\"\",\n \"username\":\"admin\",\n \"password\":\"password\",\n \"platform\":\"custom_api\"\n}' https://{site_url}/rest/v11/oauth2/token\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nSearching Records\nNext, we will need to identify the records we want to see using the /search endpoint. In this case, we are going to search for all records that have the email address of 'jsmith@sugar.com'.\u00c2\u00a0 In this example, there are 3 records, an Account, a Contact and a Lead.\ncurl -s -X GET -H OAuth-Token:{access_token} -H Cache-Control:no-cache https://{site_url}/rest/v11/search?\n\tq=jsmith@sugar.com&\n\tmax_num=3&\n\toffset=0&\n\tfields=&\n\torder_by=&\n\tfavorites=false&\n\tmy_items=false\nMore information on the search API\u00c2\u00a0can be found in the /search documentation.\nResponse\nThe data received from the server is shown below:\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"f31b2f00-468c-3d35-1e88-56fedbd3921d\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Use_the_Global_Search/index.html"}
{"id": "dde554390604-1", "text": "\"name\":\"Kaycee Gibney\",\n         \"date_entered\":\"2016-04-01T20:34:00+00:00\",\n         \"date_modified\":\"2016-04-06T15:16:24+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"user_favorites\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_jim_id\",\n         \"assigned_user_name\":\"Jim Brennan\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"sales.kid.dev@example.info\",\n               \"invalid_email\":false,\n               \"opt_out\":true,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"email1\":\"jsmith@sugar.com\",\n         \"email2\":\"sales.kid.dev@example.info\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"salutation\":\"\",\n         \"first_name\":\"Kaycee\",\n         \"last_name\":\"Gibney\",\n         \"full_name\":\"Kaycee Gibney\",\n         \"title\":\"Mgr Operations\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Use_the_Global_Search/index.html"}
{"id": "dde554390604-2", "text": "\"full_name\":\"Kaycee Gibney\",\n         \"title\":\"Mgr Operations\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(599) 165-2396\",\n         \"phone_mobile\":\"(215) 591-9574\",\n         \"phone_work\":\"(771) 945-3648\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"primary_address_street\":\"321 University Ave.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Santa Monica\",\n         \"primary_address_state\":\"NY\",\n         \"primary_address_postalcode\":\"96154\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Existing Customer\",\n         \"account_name\":\"Tracker Com LP\",\n         \"account_id\":\"72ad6f00-e345-1cab-b370-56fedbd23deb\",\n         \"dnb_principal_id\":\"\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"birthdate\":\"\",\n         \"portal_name\":\"KayceeGibney33\",\n         \"portal_active\":true,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Use_the_Global_Search/index.html"}
{"id": "dde554390604-3", "text": "\"portal_active\":true,\n         \"portal_password\":true,\n         \"portal_password1\":null,\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"accept_status_calls\":\"\",\n         \"accept_status_meetings\":\"\",\n         \"sync_contact\":false,\n         \"mkto_sync\":false,\n         \"mkto_id\":null,\n         \"mkto_lead_score\":null,\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Contacts\",\n         \"_search\":{\n            \"score\":0.70710677,\n            \"highlighted\":{\n               \"email1\":{\n                  \"text\":\"\\u003Cstrong\\u003Ejsmith@sugar.com\\u003C\\/strong\\u003E\",\n                  \"module\":\"Contacts\",\n                  \"label\":\"LBL_EMAIL_ADDRESS\"\n               }\n            }\n         }\n      },\n      {\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"e8c641ca-1b8c-74c1-d08d-56fedbdd3187\",\n         \"name\":\"MTM Investment Bank F S B\",\n         \"date_entered\":\"2016-04-01T20:34:00+00:00\",\n         \"date_modified\":\"2016-04-06T15:16:52+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Use_the_Global_Search/index.html"}
{"id": "dde554390604-4", "text": "\"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"user_favorites\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_will_id\",\n         \"assigned_user_name\":\"Will Westin\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":true\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":false\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"the60@example.us\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"email1\":\"jsmith@sugar.com\",\n         \"email2\":\"the60@example.us\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"account_type\":\"Customer\",\n         \"industry\":\"a\",\n         \"annual_revenue\":\"\",\n         \"phone_fax\":\"\",\n         \"billing_address_street\":\"67321 West Siam St.\",\n         \"billing_address_street_2\":\"\",\n         \"billing_address_street_3\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Use_the_Global_Search/index.html"}
{"id": "dde554390604-5", "text": "\"billing_address_street_2\":\"\",\n         \"billing_address_street_3\":\"\",\n         \"billing_address_street_4\":\"\",\n         \"billing_address_city\":\"Alabama\",\n         \"billing_address_state\":\"NY\",\n         \"billing_address_postalcode\":\"52272\",\n         \"billing_address_country\":\"USA\",\n         \"rating\":\"\",\n         \"phone_office\":\"(012) 704-8075\",\n         \"phone_alternate\":\"\",\n         \"website\":\"www.salesqa.it\",\n         \"ownership\":\"\",\n         \"employees\":\"\",\n         \"ticker_symbol\":\"\",\n         \"shipping_address_street\":\"67321 West Siam St.\",\n         \"shipping_address_street_2\":\"\",\n         \"shipping_address_street_3\":\"\",\n         \"shipping_address_street_4\":\"\",\n         \"shipping_address_city\":\"Alabama\",\n         \"shipping_address_state\":\"NY\",\n         \"shipping_address_postalcode\":\"52272\",\n         \"shipping_address_country\":\"USA\",\n         \"parent_id\":\"\",\n         \"sic_code\":\"\",\n         \"duns_num\":\"\",\n         \"parent_name\":\"\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Accounts\",\n         \"_search\":{\n            \"score\":0.70710677,\n            \"highlighted\":{\n               \"email1\":{\n                  \"text\":\"\\u003Cstrong\\u003Ejsmith@sugar.com\\u003C\\/strong\\u003E\",\n                  \"module\":\"Accounts\",\n                  \"label\":\"LBL_EMAIL_ADDRESS\"\n               }\n            }\n         }\n      },\n      {\n         \"my_favorite\":false,\n         \"following\":false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Use_the_Global_Search/index.html"}
{"id": "dde554390604-6", "text": "{\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"f3951f4d-2d17-7939-c5ec-56fedbb9e92f\",\n         \"name\":\"Talia Knupp\",\n         \"date_entered\":\"2016-04-01T20:34:00+00:00\",\n         \"date_modified\":\"2016-04-06T15:33:24+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"user_favorites\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_will_id\",\n         \"assigned_user_name\":\"Will Westin\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":true\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":false\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"cjsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"email1\":\"jsmith@sugar.com\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Use_the_Global_Search/index.html"}
{"id": "dde554390604-7", "text": "}\n         ],\n         \"email1\":\"jsmith@sugar.com\",\n         \"email2\":\"cjsmith@sugar.com\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"salutation\":\"\",\n         \"first_name\":\"Talia\",\n         \"last_name\":\"Knupp\",\n         \"full_name\":\"Talia Knupp\",\n         \"title\":\"Senior Product Manager\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(963) 741-3689\",\n         \"phone_mobile\":\"(600) 831-9872\",\n         \"phone_work\":\"(680) 991-2837\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"primary_address_street\":\"111 Silicon Valley Road\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Sunnyvale\",\n         \"primary_address_state\":\"NY\",\n         \"primary_address_postalcode\":\"99452\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"converted\":false,\n         \"refered_by\":\"\",\n         \"lead_source\":\"Word of mouth\",\n         \"lead_source_description\":\"\",\n         \"status\":\"In Process\",\n         \"status_description\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Use_the_Global_Search/index.html"}
{"id": "dde554390604-8", "text": "\"status\":\"In Process\",\n         \"status_description\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"dnb_principal_id\":\"\",\n         \"account_name\":\"First National S\\/B\",\n         \"account_description\":\"\",\n         \"contact_id\":\"\",\n         \"contact_name\":\"\",\n         \"account_id\":\"\",\n         \"opportunity_id\":\"\",\n         \"opportunity_name\":\"\",\n         \"opportunity_amount\":\"\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"accept_status_calls\":\"\",\n         \"accept_status_meetings\":\"\",\n         \"webtolead_email1\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"cjsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"webtolead_email2\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"cjsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Use_the_Global_Search/index.html"}
{"id": "dde554390604-9", "text": "\"reply_to_address\":false\n            }\n         ],\n         \"webtolead_email_opt_out\":\"\",\n         \"webtolead_invalid_email\":\"\",\n         \"birthdate\":\"\",\n         \"portal_name\":\"\",\n         \"portal_app\":\"\",\n         \"website\":\"\",\n         \"preferred_language\":\"\",\n         \"mkto_sync\":false,\n         \"mkto_id\":null,\n         \"mkto_lead_score\":null,\n         \"fruits_c\":\"Apples\",\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Leads\",\n         \"_search\":{\n            \"score\":0.70710677,\n            \"highlighted\":{\n               \"email1\":{\n                  \"text\":\"\\u003Cstrong\\u003Ejsmith@sugar.com\\u003C\\/strong\\u003E\",\n                  \"module\":\"Leads\",\n                  \"label\":\"LBL_EMAIL_ADDRESS\"\n               }\n            }\n         }\n      }\n   ]\n}\nThere are 3 records shown above, the _module field tells you if the record is from Accounts, Contacts or Leads.\u00c2\u00a0 The _search field is an array that tells you where in the record it found the search string.\u00c2\u00a0 It gives you back a highlighted string that you can use for display.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Use_the_Global_Search/index.html"}
{"id": "a238b2e42b53-0", "text": "How to Manipulate Records (CRUD)\nOverview\nThe following page will provide examples in bash script demonstrating how to use the CRUD (Create, Read, Update, Delete) endpoints in the REST v11 API.\nCRUD Operations\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\ncurl -X POST -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{ \n \"grant_type\":\"password\",\n \"client_id\":\"sugar\",\n \"client_secret\":\"\",\n \"username\":\"admin\",\n \"password\":\"password\",\n \"platform\":\"custom_api\"\n}' https://{site_url}/rest/v11/oauth2/token\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nCreating a Record\nNext, we need to submit the record to the Sugar instance\u00c2\u00a0using the /<module>\u00c2\u00a0endpoint. In this example,\u00c2\u00a0we are going to create an Account record with a Name of 'Test Record' and an email of 'test@sugar.com'.\ncurl -X POST -H OAuth-Token:<access_token> -H Cache-Control:no-cache -H \"Content-Type: application/json -d '{ \n   \"name\":\"Test Record\",\n   \"email1\":\"test@sugar.com\"\n}' http://<site_url>/rest/v11/Accounts\nMore information on this API endpoint can be found in the /<module> - POST\u00c2\u00a0documentation.\nResponse\nThe data received from the server is shown below:\n{\n   \"id\":\"ab2222df-73da-0e92-6887-5705428f4d68\",\n   \"name\":\"Test Record\",\n   \"date_entered\":\"2016-04-06T13:07:41-04:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "a238b2e42b53-1", "text": "\"date_modified\":\"2016-04-06T13:07:41-04:00\",\n   \"modified_user_id\":\"1\",\n   \"modified_by_name\":\"Administrator\",\n   \"modified_user_link\":{\n      \"full_name\":\"Administrator\",\n      \"id\":\"1\",\n      \"_acl\":{\n         \"fields\":[\n         ],\n         \"delete\":\"no\",\n         \"_hash\":\"8e11bf9be8f04daddee9d08d44ea891e\"\n      }\n   },\n   \"created_by\":\"1\",\n   \"created_by_name\":\"Administrator\",\n   \"created_by_link\":{\n      \"full_name\":\"Administrator\",\n      \"id\":\"1\",\n      \"_acl\":{\n         \"fields\":[\n         ],\n         \"delete\":\"no\",\n         \"_hash\":\"8e11bf9be8f04daddee9d08d44ea891e\"\n      }\n   },\n   \"description\":\"\",\n   \"deleted\":false,\n   \"facebook\":\"\",\n   \"twitter\":\"\",\n   \"googleplus\":\"\",\n   \"account_type\":\"\",\n   \"industry\":\"\",\n   \"annual_revenue\":\"\",\n   \"phone_fax\":\"\",\n   \"billing_address_street\":\"\",\n   \"billing_address_street_2\":\"\",\n   \"billing_address_street_3\":\"\",\n   \"billing_address_street_4\":\"\",\n   \"billing_address_city\":\"\",\n   \"billing_address_state\":\"\",\n   \"billing_address_postalcode\":\"\",\n   \"billing_address_country\":\"\",\n   \"rating\":\"\",\n   \"phone_office\":\"\",\n   \"phone_alternate\":\"\",\n   \"website\":\"\",\n   \"ownership\":\"\",\n   \"employees\":\"\",\n   \"ticker_symbol\":\"\",\n   \"shipping_address_street\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "a238b2e42b53-2", "text": "\"ticker_symbol\":\"\",\n   \"shipping_address_street\":\"\",\n   \"shipping_address_street_2\":\"\",\n   \"shipping_address_street_3\":\"\",\n   \"shipping_address_street_4\":\"\",\n   \"shipping_address_city\":\"\",\n   \"shipping_address_state\":\"\",\n   \"shipping_address_postalcode\":\"\",\n   \"shipping_address_country\":\"\",\n   \"parent_id\":\"\",\n   \"sic_code\":\"\",\n   \"duns_num\":\"\",\n   \"parent_name\":\"\",\n   \"member_of\":{\n      \"name\":\"\",\n      \"id\":\"\",\n      \"_acl\":{\n         \"fields\":[\n         ],\n         \"_hash\":\"654d337e0e912edaa00dbb0fb3dc3c17\"\n      }\n   },\n   \"campaign_id\":\"\",\n   \"campaign_name\":\"\",\n   \"campaign_accounts\":{\n      \"name\":\"\",\n      \"id\":\"\",\n      \"_acl\":{\n         \"fields\":[\n         ],\n         \"_hash\":\"654d337e0e912edaa00dbb0fb3dc3c17\"\n      }\n   },\n   \"following\":true,\n   \"my_favorite\":false,\n   \"tag\":[\n   ],\n   \"assigned_user_id\":\"\",\n   \"assigned_user_name\":\"\",\n   \"assigned_user_link\":{\n      \"full_name\":\"\",\n      \"id\":\"\",\n      \"_acl\":{\n         \"fields\":[\n         ],\n         \"_hash\":\"654d337e0e912edaa00dbb0fb3dc3c17\"\n      }\n   },\n   \"team_count\":\"\",\n   \"team_count_link\":{\n      \"team_count\":\"\",\n      \"id\":\"1\",\n      \"_acl\":{\n         \"fields\":[\n         ],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "a238b2e42b53-3", "text": "\"_acl\":{\n         \"fields\":[\n         ],\n         \"_hash\":\"654d337e0e912edaa00dbb0fb3dc3c17\"\n      }\n   },\n   \"team_name\":[\n      {\n         \"id\":1,\n         \"name\":\"Global\",\n         \"name_2\":\"\",\n         \"primary\":true\n      }\n   ],\n   \"email\":[\n      {\n         \"email_address\":\"test@sugar.com\",\n         \"invalid_email\":false,\n         \"opt_out\":false,\n         \"primary_address\":true,\n         \"reply_to_address\":false\n      }\n   ],\n   \"email1\":\"test@sugar.com\",\n   \"email2\":\"\",\n   \"invalid_email\":false,\n   \"email_opt_out\":false,\n   \"email_addresses_non_primary\":\"\",\n   \"_acl\":{\n      \"fields\":{\n      }\n   },\n   \"_module\":\"Accounts\"\n}\nGetting a Record\nNext we can\u00c2\u00a0get the created record from\u00c2\u00a0the Sugar instance\u00c2\u00a0using the /<module>/:record\u00c2\u00a0endpoint. In this example,\u00c2\u00a0we are going to get\u00c2\u00a0an Account record by it's ID, but only request the Name, Email, and Industry fields.\ncurl -H OAuth-Token:<access_token> -H Cache-Control:no-cache http://<site_url>/rest/v11/Accounts/<record_id>?fields=name,email1,industry\nMore information on this API endpoint can be found in the /<module>/:record - GET\u00c2\u00a0documentation.\nResponse\nThe data received from the server is shown below:\n{\n   \"id\":\"ab2222df-73da-0e92-6887-5705428f4d68\",\n   \"name\":\"Test Record\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "a238b2e42b53-4", "text": "\"name\":\"Test Record\",\n   \"date_modified\":\"2016-04-06T15:03:21-04:00\",\n   \"industry\":\"\",\n   \"email1\":\"test@sugar.com\",\n   \"_acl\":{\n      \"fields\":{\n      }\n   },\n   \"_module\":\"Accounts\"\n}\nUpdating a Record\nNext we can\u00c2\u00a0update \u00c2\u00a0the record in\u00c2\u00a0the Sugar instance\u00c2\u00a0using the /<module>/:record\u00c2\u00a0endpoint, and the PUT Http method. In this example\u00c2\u00a0we are going to update the\u00c2\u00a0Account record and change it's name to \"Updated Test Record\".\ncurl -X PUT -H OAuth-Token:<access_token> -H Cache-Control:no-cache -d '{ \n   \"name\":\"Updated Record\"\n}' http://<site_url>/rest/v11/Accounts/<record_id>\nMore information on this API endpoint can be found in the /<module>/:record - PUT\u00c2\u00a0documentation.\nResponse\nThe data received from the server is shown below:\n{\n   \"id\":\"ab2222df-73da-0e92-6887-5705428f4d68\",\n   \"name\":\"Updated Test Record\",\n   \"date_entered\":\"2016-04-06T15:03:21-04:00\",\n   \"date_modified\":\"2016-04-06T15:03:22-04:00\",\n   \"modified_user_id\":\"1\",\n   \"modified_by_name\":\"Administrator\",\n   \"modified_user_link\":{\n      \"full_name\":\"Administrator\",\n      \"id\":\"1\",\n      \"_acl\":{\n         \"fields\":[\n         ],\n         \"delete\":\"no\",\n         \"_hash\":\"8e11bf9be8f04daddee9d08d44ea891e\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "a238b2e42b53-5", "text": "}\n   },\n   \"created_by\":\"1\",\n   \"created_by_name\":\"Administrator\",\n   \"created_by_link\":{\n      \"full_name\":\"Administrator\",\n      \"id\":\"1\",\n      \"_acl\":{\n         \"fields\":[\n         ],\n         \"delete\":\"no\",\n         \"_hash\":\"8e11bf9be8f04daddee9d08d44ea891e\"\n      }\n   },\n   \"description\":\"\",\n   \"deleted\":false,\n   \"facebook\":\"\",\n   \"twitter\":\"\",\n   \"googleplus\":\"\",\n   \"account_type\":\"\",\n   \"industry\":\"\",\n   \"annual_revenue\":\"\",\n   \"phone_fax\":\"\",\n   \"billing_address_street\":\"\",\n   \"billing_address_street_2\":\"\",\n   \"billing_address_street_3\":\"\",\n   \"billing_address_street_4\":\"\",\n   \"billing_address_city\":\"\",\n   \"billing_address_state\":\"\",\n   \"billing_address_postalcode\":\"\",\n   \"billing_address_country\":\"\",\n   \"rating\":\"\",\n   \"phone_office\":\"\",\n   \"phone_alternate\":\"\",\n   \"website\":\"\",\n   \"ownership\":\"\",\n   \"employees\":\"\",\n   \"ticker_symbol\":\"\",\n   \"shipping_address_street\":\"\",\n   \"shipping_address_street_2\":\"\",\n   \"shipping_address_street_3\":\"\",\n   \"shipping_address_street_4\":\"\",\n   \"shipping_address_city\":\"\",\n   \"shipping_address_state\":\"\",\n   \"shipping_address_postalcode\":\"\",\n   \"shipping_address_country\":\"\",\n   \"parent_id\":\"\",\n   \"sic_code\":\"\",\n   \"duns_num\":\"\",\n   \"parent_name\":\"\",\n   \"member_of\":{\n      \"name\":\"\",\n      \"id\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "a238b2e42b53-6", "text": "\"member_of\":{\n      \"name\":\"\",\n      \"id\":\"\",\n      \"_acl\":{\n         \"fields\":[\n         ],\n         \"_hash\":\"654d337e0e912edaa00dbb0fb3dc3c17\"\n      }\n   },\n   \"campaign_id\":\"\",\n   \"campaign_name\":\"\",\n   \"campaign_accounts\":{\n      \"name\":\"\",\n      \"id\":\"\",\n      \"_acl\":{\n         \"fields\":[\n         ],\n         \"_hash\":\"654d337e0e912edaa00dbb0fb3dc3c17\"\n      }\n   },\n   \"following\":true,\n   \"my_favorite\":false,\n   \"tag\":[\n   ],\n   \"assigned_user_id\":\"\",\n   \"assigned_user_name\":\"\",\n   \"assigned_user_link\":{\n      \"full_name\":\"\",\n      \"id\":\"\",\n      \"_acl\":{\n         \"fields\":[\n         ],\n         \"_hash\":\"654d337e0e912edaa00dbb0fb3dc3c17\"\n      }\n   },\n   \"team_count\":\"\",\n   \"team_count_link\":{\n      \"team_count\":\"\",\n      \"id\":\"1\",\n      \"_acl\":{\n         \"fields\":[\n         ],\n         \"_hash\":\"654d337e0e912edaa00dbb0fb3dc3c17\"\n      }\n   },\n   \"team_name\":[\n      {\n         \"id\":1,\n         \"name\":\"Global\",\n         \"name_2\":\"\",\n         \"primary\":true\n      }\n   ],\n   \"email\":[\n      {\n         \"email_address\":\"test@sugar.com\",\n         \"invalid_email\":false,\n         \"opt_out\":false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "a238b2e42b53-7", "text": "\"invalid_email\":false,\n         \"opt_out\":false,\n         \"primary_address\":true,\n         \"reply_to_address\":false\n      }\n   ],\n   \"email1\":\"test@sugar.com\",\n   \"email2\":\"\",\n   \"invalid_email\":false,\n   \"email_opt_out\":false,\n   \"email_addresses_non_primary\":\"\",\n   \"_acl\":{\n      \"fields\":{\n      }\n   },\n   \"_module\":\"Accounts\"\n}\nDeleting a Record\nNext, we can delete\u00c2\u00a0the record from\u00c2\u00a0the Sugar instance\u00c2\u00a0using the /<module>/:record\u00c2\u00a0endpoint, by using the DELETE Http Method.\ncurl -X DELETE -H OAuth-Token:<access_token> -H Cache-Control:no-cache http://<site_url>/rest/v11/Accounts/<record_id>\nMore information on this API endpoint can be found in the /<module>/:record - DELETE\u00c2\u00a0documentation.\u00c2\u00a0\nResponse\nThe data received from the server is shown below:\n{\n   \"id\":\"ab2222df-73da-0e92-6887-5705428f4d68\"\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Records_CRUD/index.html"}
{"id": "5ea7b54e1021-0", "text": "How to Favorite a Record\nOverview\nAn example\u00c2\u00a0in bash script demonstrating how to favorite a record using the v11\u00c2\u00a0<module>/:record/favorite REST PUT API endpoint.\nFavoriting a Record\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\ncurl -X POST -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{ \n \"grant_type\":\"password\",\n \"client_id\":\"sugar\",\n \"client_secret\":\"\",\n \"username\":\"admin\",\n \"password\":\"password\",\n \"platform\":\"custom_api\"\n}' https://{site_url}/rest/v11/oauth2/token\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nFavoriting a Record\nNext, we can favorite\u00c2\u00a0a specific record\u00c2\u00a0using the /<module>/:record/favorite\u00c2\u00a0endpoint.\ncurl -s -X PUT -H OAuth-Token:{access_token} -H Cache-Control:no-cache https://{site_url}/rest/v11/Accounts/ae8b1783-404a-fcb8-1e1e-56f1cc52cd1a/favorite\nMore information on the unfavorite API\u00c2\u00a0can be found in the /<module>/:record/favorite PUT\u00c2\u00a0documentation.\nResponse\nThe data received from the server is shown below:\n{\n    \"id\": \"ae8b1783-404a-fcb8-1e1e-56f1cc52cd1a\",\n    \"name\": \"Union Bank\",\n    \"date_entered\": \"2016-03-22T17:49:50-05:00\",\n    \"date_modified\": \"2016-03-30T17:44:20-05:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Favorite_a_Record/index.html"}
{"id": "5ea7b54e1021-1", "text": "\"modified_user_id\": \"1\",\n    \"modified_by_name\": \"Administrator\",\n    \"modified_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": [],\n            \"delete\": \"no\",\n            \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n        }\n    },\n    \"created_by\": \"1\",\n    \"created_by_name\": \"Administrator\",\n    \"created_by_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": [],\n            \"delete\": \"no\",\n            \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n        }\n    },\n    \"description\": \"\",\n    \"deleted\": false,\n    \"facebook\": \"\",\n    \"twitter\": \"\",\n    \"googleplus\": \"\",\n    \"account_type\": \"Customer\",\n    \"industry\": \"Banking\",\n    \"annual_revenue\": \"\",\n    \"phone_fax\": \"\",\n    \"billing_address_street\": \"67321 West Siam St.\",\n    \"billing_address_street_2\": \"\",\n    \"billing_address_street_3\": \"\",\n    \"billing_address_street_4\": \"\",\n    \"billing_address_city\": \"Ohio\",\n    \"billing_address_state\": \"CA\",\n    \"billing_address_postalcode\": \"25159\",\n    \"billing_address_country\": \"USA\",\n    \"rating\": \"\",\n    \"phone_office\": \"(065) 489-6104\",\n    \"phone_alternate\": \"\",\n    \"website\": \"www.qahr.edu\",\n    \"ownership\": \"\",\n    \"employees\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Favorite_a_Record/index.html"}
{"id": "5ea7b54e1021-2", "text": "\"ownership\": \"\",\n    \"employees\": \"\",\n    \"ticker_symbol\": \"\",\n    \"shipping_address_street\": \"67321 West Siam St.\",\n    \"shipping_address_street_2\": \"\",\n    \"shipping_address_street_3\": \"\",\n    \"shipping_address_street_4\": \"\",\n    \"shipping_address_city\": \"Ohio\",\n    \"shipping_address_state\": \"CA\",\n    \"shipping_address_postalcode\": \"25159\",\n    \"shipping_address_country\": \"USA\",\n    \"parent_id\": \"\",\n    \"sic_code\": \"\",\n    \"duns_num\": \"\",\n    \"parent_name\": \"\",\n    \"member_of\": {\n        \"name\": \"\",\n        \"id\": \"\",\n        \"_acl\": {\n            \"fields\": [],\n            \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n        }\n    },\n    \"campaign_id\": \"\",\n    \"campaign_name\": \"\",\n    \"campaign_accounts\": {\n        \"name\": \"\",\n        \"id\": \"\",\n        \"_acl\": {\n            \"fields\": [],\n            \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n        }\n    },\n    \"following\": true,\n    \"my_favorite\": true,\n    \"tag\": [],\n    \"assigned_user_id\": \"seed_sarah_id\",\n    \"assigned_user_name\": \"Sarah Smith\",\n    \"assigned_user_link\": {\n        \"full_name\": \"Sarah Smith\",\n        \"id\": \"seed_sarah_id\",\n        \"_acl\": {\n            \"fields\": [],\n            \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n        }\n    },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Favorite_a_Record/index.html"}
{"id": "5ea7b54e1021-3", "text": "}\n    },\n    \"team_count\": \"\",\n    \"team_count_link\": {\n        \"team_count\": \"\",\n        \"id\": \"West\",\n        \"_acl\": {\n            \"fields\": [],\n            \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n        }\n    },\n    \"team_name\": [{\n        \"id\": \"East\",\n        \"name\": \"East\",\n        \"name_2\": \"\",\n        \"primary\": false\n    }, {\n        \"id\": 1,\n        \"name\": \"Global\",\n        \"name_2\": \"\",\n        \"primary\": false\n    }, {\n        \"id\": \"West\",\n        \"name\": \"West\",\n        \"name_2\": \"\",\n        \"primary\": true\n    }],\n    \"email\": [{\n        \"email_address\": \"hr.support.kid@example.info\",\n        \"invalid_email\": false,\n        \"opt_out\": false,\n        \"primary_address\": true,\n        \"reply_to_address\": false\n    }, {\n        \"email_address\": \"info.support.the@example.com\",\n        \"invalid_email\": false,\n        \"opt_out\": false,\n        \"primary_address\": false,\n        \"reply_to_address\": false\n    }],\n    \"email1\": \"hr.support.kid@example.info\",\n    \"email2\": \"info.support.the@example.com\",\n    \"invalid_email\": false,\n    \"email_opt_out\": false,\n    \"email_addresses_non_primary\": \"\",\n    \"_acl\": {\n        \"fields\": {}\n    },\n    \"_module\": \"Accounts\"\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Favorite_a_Record/index.html"}
{"id": "7a6c843e73ec-0", "text": "How to Follow a Record\nOverview\nAn example\u00c2\u00a0in bash script demonstrating how to\u00c2\u00a0follow a record using the v11\u00c2\u00a0/<module>/:record/subscribe REST POST\u00c2\u00a0endpoint.\nFollowing a Record\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\ncurl -X POST -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{ \n \"grant_type\":\"password\",\n \"client_id\":\"sugar\",\n \"client_secret\":\"\",\n \"username\":\"admin\",\n \"password\":\"password\",\n \"platform\":\"custom_api\"\n}' https://{site_url}/rest/v11/oauth2/token\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nFollowing a Record\nNext, we can follow a specific record\u00c2\u00a0using the /<module>/:record/subscribe\u00c2\u00a0endpoint.\ncurl -s -X POST -H OAuth-Token:{access_token} -H Cache-Control:no-cache https://{site_url}/rest/v11/Accounts/e3a59dcd-ff5e-8a78-cd7f-570811366792/subscribe\nMore information on the subscribe API\u00c2\u00a0can be found in the /<module>/:record/subscribe POST\u00c2\u00a0documentation.\nResponse\nThe data received from the server is shown below:\n\"58f96315-9e75-6562-42e9-5705917d2cdc\"\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Follow_a_Record/index.html"}
{"id": "d4ec6baf2533-0", "text": "How to Filter a List of Records\nOverview\nAn example\u00c2\u00a0in bash script demonstrating how to filter records\u00c2\u00a0using the v11\u00c2\u00a0/<module>/filter REST POST endpoints.\nFiltering Records\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\ncurl -X POST -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{ \n \"grant_type\":\"password\",\n \"client_id\":\"sugar\",\n \"client_secret\":\"\",\n \"username\":\"admin\",\n \"password\":\"password\",\n \"platform\":\"custom_api\"\n}' https://{site_url}/rest/v11/oauth2/token\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nFiltering Records\nNext we can\u00c2\u00a0filter\u00c2\u00a0the records we want to return\u00c2\u00a0using the /<module>/filter\u00c2\u00a0endpoint with a POST request.\ncurl -s -X POST -H OAuth-Token:{access_token} -H \"Content-Type: application/json\" -H Cache-Control:no-cache -d '{  \n   \"filter\":[  \n      {  \n         \"$or\":[  \n            {  \n               \"name\":{  \n                  \"$starts\":\"A\"\n               }\n            },\n            {  \n               \"name\":{  \n                  \"$starts\":\"b\"\n               }\n            }\n         ]\n      }\n   ],\n   \"max_num\":2,\n   \"offset\":0,\n   \"fields\":\"id\",\n   \"order_by\":\"date_entered\",\n   \"favorites\":false,\n   \"my_items\":false\n}' https://{site_url}/rest/v11/Accounts/filter\nMore information on the filter API\u00c2\u00a0can be found in the /<module>/filter documentation.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Filter_a_List_of_Records/index.html"}
{"id": "d4ec6baf2533-1", "text": "Note : The\u00c2\u00a0/<module>/filter endpoint can be called using a GET request as well, though long URL requests can have issues so the POST request is recommended.\u00c2\u00a0\nResponse\nThe data received from the server is shown below:\n{  \n   \"next_offset\":2,\n   \"records\":[  \n      {  \n         \"id\":\"f16760a4-3a52-f77d-1522-5703ca28925f\",\n         \"date_modified\":\"2016-04-05T10:23:28-04:00\",\n         \"_acl\":{  \n            \"fields\":{  \n            }\n         },\n         \"_module\":\"Accounts\"\n      },\n      {  \n         \"id\":\"ec409fbb-2b22-4f32-7fa1-5703caf78dc3\",\n         \"date_modified\":\"2016-04-05T10:23:28-04:00\",\n         \"_acl\":{  \n            \"fields\":{  \n            }\n         },\n         \"_module\":\"Accounts\"\n      }\n   ]\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Filter_a_List_of_Records/index.html"}
{"id": "a41aabcae6ae-0", "text": "How to Ping\nOverview\nAn example\u00c2\u00a0in bash script demonstrating how to ping\u00c2\u00a0using the REST v11\u00c2\u00a0/ping GET\u00c2\u00a0endpoint.\nPinging\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\ncurl -X POST -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{ \n \"grant_type\":\"password\",\n \"client_id\":\"sugar\",\n \"client_secret\":\"\",\n \"username\":\"admin\",\n \"password\":\"password\",\n \"platform\":\"custom_api\"\n}' https://{site_url}/rest/v11/oauth2/token\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nPinging\nOnce we have authenticated, we can now ping the system as shown below.\ncurl -s -X GET -H OAuth-Token:{access_token} -H Cache-Control:no-cache https://{site_url}/rest/v11/ping\nMore information on pinging\u00c2\u00a0can be found in the /ping\u00c2\u00a0documentation.\nResponse\n\"pong\"\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Ping/index.html"}
{"id": "9cfe3a407230-0", "text": "How to Fetch Recently Viewed Records\nOverview\nAn example\u00c2\u00a0in bash script demonstrating how to retrieve recently viewed records\u00c2\u00a0using the v11\u00c2\u00a0/recent REST GET endpoint.\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\ncurl -X POST -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{ \n \"grant_type\":\"password\",\n \"client_id\":\"sugar\",\n \"client_secret\":\"\",\n \"username\":\"admin\",\n \"password\":\"password\",\n \"platform\":\"custom_api\"\n}' https://{site_url}/rest/v11/oauth2/token\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nRecently Viewed Records\nNext, we will need to identify the records we want to see using the /recent endpoint. In this case, we are going to request Accounts, Contacts and Leads.\ncurl -s -X GET -H OAuth-Token:{access_token} -H Cache-Control:no-cache https://{site_url}/rest/v11/recent?module_list=Accounts%2CContacts%2CLeads\nMore information on the search API\u00c2\u00a0can be found in the /recent documentation.\nResponse\nThe data received from the server is shown below:\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"f3951f4d-2d17-7939-c5ec-56fedbb9e92f\",\n         \"name\":\"Talia Knupp\",\n         \"date_entered\":\"2016-04-01T15:34:00-05:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "9cfe3a407230-1", "text": "\"date_modified\":\"2016-04-06T10:33:24-05:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"user_favorites\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_will_id\",\n         \"assigned_user_name\":\"Will Westin\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":true\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":false\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"cjsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"email1\":\"jsmith@sugar.com\",\n         \"email2\":\"cjsmith@sugar.com\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"salutation\":\"\",\n         \"first_name\":\"Talia\",\n         \"last_name\":\"Knupp\",\n         \"full_name\":\"Talia Knupp\",\n         \"title\":\"Senior Product Manager\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "9cfe3a407230-2", "text": "\"full_name\":\"Talia Knupp\",\n         \"title\":\"Senior Product Manager\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(963) 741-3689\",\n         \"phone_mobile\":\"(600) 831-9872\",\n         \"phone_work\":\"(680) 991-2837\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"primary_address_street\":\"111 Silicon Valley Road\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Sunnyvale\",\n         \"primary_address_state\":\"NY\",\n         \"primary_address_postalcode\":\"99452\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"converted\":false,\n         \"refered_by\":\"\",\n         \"lead_source\":\"Word of mouth\",\n         \"lead_source_description\":\"\",\n         \"status\":\"In Process\",\n         \"status_description\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"dnb_principal_id\":\"\",\n         \"account_name\":\"First National S\\/B\",\n         \"account_description\":\"\",\n         \"contact_id\":\"\",\n         \"contact_name\":\"\",\n         \"account_id\":\"\",\n         \"opportunity_id\":\"\",\n         \"opportunity_name\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "9cfe3a407230-3", "text": "\"opportunity_id\":\"\",\n         \"opportunity_name\":\"\",\n         \"opportunity_amount\":\"\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"accept_status_calls\":\"\",\n         \"accept_status_meetings\":\"\",\n         \"webtolead_email1\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"cjsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"webtolead_email2\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"cjsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"webtolead_email_opt_out\":\"\",\n         \"webtolead_invalid_email\":\"\",\n         \"birthdate\":\"\",\n         \"portal_name\":\"\",\n         \"portal_app\":\"\",\n         \"website\":\"\",\n         \"preferred_language\":\"\",\n         \"mkto_sync\":false,\n         \"mkto_id\":null,\n         \"mkto_lead_score\":null,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "9cfe3a407230-4", "text": "\"mkto_id\":null,\n         \"mkto_lead_score\":null,\n         \"fruits_c\":\"Apples\",\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Leads\",\n         \"_last_viewed_date\":\"2016-04-06T10:33:24-05:00\"\n      },\n      {\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"e8c641ca-1b8c-74c1-d08d-56fedbdd3187\",\n         \"name\":\"MTM Investment Bank F S B\",\n         \"date_entered\":\"2016-04-01T15:34:00-05:00\",\n         \"date_modified\":\"2016-04-06T10:16:52-05:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"user_favorites\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_will_id\",\n         \"assigned_user_name\":\"Will Westin\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":true\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":false\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "9cfe3a407230-5", "text": "\"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"the60@example.us\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"email1\":\"jsmith@sugar.com\",\n         \"email2\":\"the60@example.us\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"account_type\":\"Customer\",\n         \"industry\":\"a\",\n         \"annual_revenue\":\"\",\n         \"phone_fax\":\"\",\n         \"billing_address_street\":\"67321 West Siam St.\",\n         \"billing_address_street_2\":\"\",\n         \"billing_address_street_3\":\"\",\n         \"billing_address_street_4\":\"\",\n         \"billing_address_city\":\"Alabama\",\n         \"billing_address_state\":\"NY\",\n         \"billing_address_postalcode\":\"52272\",\n         \"billing_address_country\":\"USA\",\n         \"rating\":\"\",\n         \"phone_office\":\"(012) 704-8075\",\n         \"phone_alternate\":\"\",\n         \"website\":\"www.salesqa.it\",\n         \"ownership\":\"\",\n         \"employees\":\"\",\n         \"ticker_symbol\":\"\",\n         \"shipping_address_street\":\"67321 West Siam St.\",\n         \"shipping_address_street_2\":\"\",\n         \"shipping_address_street_3\":\"\",\n         \"shipping_address_street_4\":\"\",\n         \"shipping_address_city\":\"Alabama\",\n         \"shipping_address_state\":\"NY\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "9cfe3a407230-6", "text": "\"shipping_address_city\":\"Alabama\",\n         \"shipping_address_state\":\"NY\",\n         \"shipping_address_postalcode\":\"52272\",\n         \"shipping_address_country\":\"USA\",\n         \"parent_id\":\"\",\n         \"sic_code\":\"\",\n         \"duns_num\":\"\",\n         \"parent_name\":\"\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Accounts\",\n         \"_last_viewed_date\":\"2016-04-06T10:16:52-05:00\"\n      },\n      {\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"f31b2f00-468c-3d35-1e88-56fedbd3921d\",\n         \"name\":\"Kaycee Gibney\",\n         \"date_entered\":\"2016-04-01T15:34:00-05:00\",\n         \"date_modified\":\"2016-04-06T10:16:24-05:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"user_favorites\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_jim_id\",\n         \"assigned_user_name\":\"Jim Brennan\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "9cfe3a407230-7", "text": "\"email\":[\n            {\n               \"email_address\":\"jsmith@sugar.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"sales.kid.dev@example.info\",\n               \"invalid_email\":false,\n               \"opt_out\":true,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"email1\":\"jsmith@sugar.com\",\n         \"email2\":\"sales.kid.dev@example.info\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"salutation\":\"\",\n         \"first_name\":\"Kaycee\",\n         \"last_name\":\"Gibney\",\n         \"full_name\":\"Kaycee Gibney\",\n         \"title\":\"Mgr Operations\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(599) 165-2396\",\n         \"phone_mobile\":\"(215) 591-9574\",\n         \"phone_work\":\"(771) 945-3648\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"primary_address_street\":\"321 University Ave.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Santa Monica\",\n         \"primary_address_state\":\"NY\",\n         \"primary_address_postalcode\":\"96154\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "9cfe3a407230-8", "text": "\"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Existing Customer\",\n         \"account_name\":\"Tracker Com LP\",\n         \"account_id\":\"72ad6f00-e345-1cab-b370-56fedbd23deb\",\n         \"dnb_principal_id\":\"\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"birthdate\":\"\",\n         \"portal_name\":\"KayceeGibney33\",\n         \"portal_active\":true,\n         \"portal_password\":true,\n         \"portal_password1\":null,\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"accept_status_calls\":\"\",\n         \"accept_status_meetings\":\"\",\n         \"sync_contact\":false,\n         \"mkto_sync\":false,\n         \"mkto_id\":null,\n         \"mkto_lead_score\":null,\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Contacts\",\n         \"_last_viewed_date\":\"2016-04-06T10:16:24-05:00\"\n      }\n   ]\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "9cfe3a407230-9", "text": "}\n   ]\n}\nThere are 3 records shown above, the _module field tells you if the record is from Accounts, Contacts or Leads.\u00c2\u00a0 The _last_viewed_date tells you when the record was last seen.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_Recently_Viewed_Records/index.html"}
{"id": "0e69d11a9177-0", "text": "How to Unfollow a Record\nOverview\nAn example\u00c2\u00a0in bash script demonstrating how to unfollow a record using the v11\u00c2\u00a0/<module>/:record/unsubscribe REST DELETE\u00c2\u00a0endpoint.\nUnfollowing a Record\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\ncurl -X POST -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{ \n \"grant_type\":\"password\",\n \"client_id\":\"sugar\",\n \"client_secret\":\"\",\n \"username\":\"admin\",\n \"password\":\"password\",\n \"platform\":\"custom_api\"\n}' https://{site_url}/rest/v11/oauth2/token\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nUnfollowing a Record\nNext, we can unfollow a specific record\u00c2\u00a0using the /<module>/:record/unsubscribe\u00c2\u00a0endpoint.\ncurl -s -X DELETE -H OAuth-Token:{access_token} -H Cache-Control:no-cache https://{site_url}/rest/v11/Accounts/e7b0d745-0a3e-c896-5358-5708113786d7/unsubscribe\nMore information on the unsubscribe API\u00c2\u00a0can be found in the /:record/unsubscribe DELETE  documentation.\nResponse\nThe data received from the server is shown below:\ntrue\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Unfollow_a_Record/index.html"}
{"id": "00029b8f0f71-0", "text": "How to Authenticate and Log Out\nOverview\nAn example\u00c2\u00a0in bash\u00c2\u00a0script on how to authenticate and logout of the v11 REST API using the /oauth2/token\u00c2\u00a0and /oauth2/logout POST endpoints.\nAuthenticating\nThe example below demonstrates how to authenticate to the REST v11 API. It is important to note that the oauth2 token arguments takes in several parameters that you should be aware of. The platform argument tends to cause confusion in that it is used to authenticate a user to a specific platform. Since Sugar only allows 1 user in the system at a time per platform, authenticating an integration script with a platform type of \"base\"\u00c2\u00a0will logout any current users in the system using those credentials. To work around this, your custom scripts should have a new platform type specified such as \"custom_api\" or any other static text you prefer. The client_id and client_secret\u00c2\u00a0parameters can be used for additional security based on client types. You can create your own client type\u00c2\u00a0in Admin > OAuth Keys. More information can be found in the /oauth2/token documentation. An example script is shown below:\ncurl -X POST -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{ \n \"grant_type\":\"password\",\n \"client_id\":\"sugar\",\n \"client_secret\":\"\",\n \"username\":\"admin\",\n \"password\":\"password\",\n \"platform\":\"custom_api\"\n}' https://{site_url}/rest/v11/oauth2/token\nResponse\nThe data received from the server is shown below:\n{\n   \"access_token\":\"c6d495c9-bb25-81d2-5f81-533ef6479f9b\",\n   \"expires_in\":3600,\n   \"token_type\":\"bearer\",\n   \"scope\":null,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Authenticate_and_Log_Out/index.html"}
{"id": "00029b8f0f71-1", "text": "\"token_type\":\"bearer\",\n   \"scope\":null,\n   \"refresh_token\":\"cbc40e67-12bc-4b56-a1d9-533ef62f2601\",\n   \"refresh_expires_in\":1209600,\n   \"download_token\":\"cc5d1a9f-6627-3349-96e5-533ef6b1a493\"\n}\nLogout\nTo log out of\u00c2\u00a0a session,\u00c2\u00a0a request\u00c2\u00a0can be made to the \u00c2\u00a0/oauth2/logout POST endpoint. More information can be found in the /oauth2/logout documentation.\u00c2\u00a0An example extending off of the above authentication example\u00c2\u00a0is shown\u00c2\u00a0below:\ncurl -s -X POST -H OAuth-Token:<access_token> -H Cache-Control:no-cache https://{site_url}/rest/v11/oauth2/logout\nResponse\nThe data received from the server is shown below:\n{\n    \"success\":true\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Authenticate_and_Log_Out/index.html"}
{"id": "98c61696e33a-0", "text": "How to Manipulate Quotes\nOverview\nA Bash example\u00c2\u00a0demonstrating how to manipulate Quotes and related record data such as ProductBundles, Products, and ProductBundleNotes.\u00c2\u00a0\nManipulating Quotes\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\ncurl -X POST -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{ \n \"grant_type\":\"password\",\n \"client_id\":\"sugar\",\n \"client_secret\":\"\",\n \"username\":\"admin\",\n \"password\":\"password\",\n \"platform\":\"custom_api\"\n}' https://{site_url}/rest/v11/oauth2/token\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nCreating a Quote\nOnce authenticated, we can submit a Quote record using the <module> endpoint. Since a\u00c2\u00a0Quote record is a sum of its parts (i.e. ProductBundles and Products) you can submit the related ProductBundles and Products in the same request payload using the relationship Links and the \"create\" property.\ncurl -X POST -H OAuth-Token:<access_token> -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{\n  \"name\": \"Test Quote\",\n  \"quote_stage\": \"Draft\",\n  \"date_quote_expected_closed\": \"2017-06-12T11:51:57-0400\",\n  \"product_bundles\": {\n    \"create\": [\n      {\n        \"name\": \"Product Bundle 1\",\n        \"bundle_stage\": \"Draft\",\n        \"currency_id\": \":-99\",\n        \"base_rate\": \"1.0\",\n        \"shipping\": \"0.00\",\n        \"products\": {\n          \"create\": [\n            {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Quotes/index.html"}
{"id": "98c61696e33a-1", "text": "\"products\": {\n          \"create\": [\n            {\n              \"tax_class\": \"Taxable\",\n              \"quantity\": 1000,\n              \"name\": \"Test Product 1\",\n              \"description\": \"My Test Product\",\n              \"mft_part_num\": \"mft100012021\",\n              \"cost_price\": \"100.00\",\n              \"list_price\": \"200.00\",\n              \"discount_price\": \"175.00\",\n              \"discount_amount\": \"0.00\",\n              \"discount_select\": 0,\n              \"product_template_id\": \"\",\n              \"type_id\": \"\",\n              \"status\": \"Quotes\"\n            }\n          ]\n        },\n        \"product_bundle_notes\": {\n          \"create\": [\n            {\n              \"description\": \"Free shipping\",\n              \"position\": 1\n            }\n          ]\n        }\n      },\n      {\n        \"name\": \"Product Bundle 2\",\n        \"bundle_stage\": \"Draft\",\n        \"currency_id\": \":-99\",\n        \"base_rate\": \"1.0\",\n        \"shipping\": \"25.00\",\n        \"products\": {\n          \"create\": [\n            {\n              \"quantity\": 1000,\n              \"name\": \"Test Product 2\",\n              \"description\": \"My Other Product\",\n              \"mft_part_num\": \"mft100012234\",\n              \"cost_price\": \"150.00\",\n              \"list_price\": \"300.00\",\n              \"discount_price\": \"275.00\",\n              \"discount_amount\": \"0.00\",\n              \"discount_select\": 0,\n              \"product_template_id\": \"\",\n              \"type_id\": \"\",\n              \"status\": \"Quotes\"\n            },\n            {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Quotes/index.html"}
{"id": "98c61696e33a-2", "text": "\"status\": \"Quotes\"\n            },\n            {\n              \"quantity\": 500,\n              \"name\": \"Test Product 3\",\n              \"description\": \"My Other Other Product\",\n              \"mft_part_num\": \"mft100012123\",\n              \"cost_price\": \"10.00\",\n              \"list_price\": \"500.00\",\n              \"discount_price\": \"400.00\",\n              \"discount_amount\": \"0.00\",\n              \"discount_select\": 0,\n              \"product_template_id\": \"\",\n              \"type_id\": \"\",\n              \"status\": \"Quotes\"\n            }\n          ]\n        }\n      }\n    ]\n  }\n}' http://<site_url>/rest/v11/Quotes\nResponse\nThe data received from the server is shown below:\n{\n  \"id\": \"ee1e1ae8-372a-11e7-8bf4-3c15c2c94fb0\",\n  \"name\": \"Test Quote\",\n  \"date_entered\": \"2017-05-12T11:51:57-04:00\",\n  \"date_modified\": \"2017-05-12T11:51:57-04:00\",\n  \"modified_user_id\": \"1\",\n  \"modified_by_name\": \"Administrator\",\n  \"modified_user_link\": {\n    \"full_name\": \"Administrator\",\n    \"id\": \"1\",\n    \"_acl\": {\n      \"fields\": {\n        \"pwd_last_changed\": {\n          \"write\": \"no\",\n          \"create\": \"no\"\n        },\n        \"last_login\": {\n          \"write\": \"no\",\n          \"create\": \"no\"\n        }\n      },\n      \"delete\": \"no\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Quotes/index.html"}
{"id": "98c61696e33a-3", "text": "}\n      },\n      \"delete\": \"no\",\n      \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n    }\n  },\n  \"created_by\": \"1\",\n  \"created_by_name\": \"Administrator\",\n  \"created_by_link\": {\n    \"full_name\": \"Administrator\",\n    \"id\": \"1\",\n    \"_acl\": {\n      \"fields\": {\n        \"pwd_last_changed\": {\n          \"write\": \"no\",\n          \"create\": \"no\"\n        },\n        \"last_login\": {\n          \"write\": \"no\",\n          \"create\": \"no\"\n        }\n      },\n      \"delete\": \"no\",\n      \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n    }\n  },\n  \"description\": \"\",\n  \"deleted\": false,\n  \"shipper_id\": \"\",\n  \"shipper_name\": \"\",\n  \"shippers\": {\n    \"name\": \"\",\n    \"id\": \"\",\n    \"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n    }\n  },\n  \"taxrate_id\": \"\",\n  \"taxrate_name\": \"\",\n  \"taxrates\": {\n    \"name\": \"\",\n    \"id\": \"\",\n    \"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n    }\n  },\n  \"taxrate_value\": \"0.000000\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Quotes/index.html"}
{"id": "98c61696e33a-4", "text": "}\n  },\n  \"taxrate_value\": \"0.000000\",\n  \"show_line_nums\": true,\n  \"quote_type\": \"Quotes\",\n  \"date_quote_expected_closed\": \"2017-06-12\",\n  \"original_po_date\": \"\",\n  \"payment_terms\": \"\",\n  \"date_quote_closed\": \"\",\n  \"date_order_shipped\": \"\",\n  \"order_stage\": \"\",\n  \"quote_stage\": \"Draft\",\n  \"purchase_order_num\": \"\",\n  \"quote_num\": 2,\n  \"subtotal\": \"650000.000000\",\n  \"subtotal_usdollar\": \"650000.000000\",\n  \"shipping\": \"0.000000\",\n  \"shipping_usdollar\": \"0.000000\",\n  \"discount\": \"\",\n  \"deal_tot\": \"0.00\",\n  \"deal_tot_discount_percentage\": \"0.00\",\n  \"deal_tot_usdollar\": \"0.00\",\n  \"new_sub\": \"650000.000000\",\n  \"new_sub_usdollar\": \"650000.000000\",\n  \"taxable_subtotal\": \"650000.000000\",\n  \"tax\": \"0.000000\",\n  \"tax_usdollar\": \"0.000000\",\n  \"total\": \"650000.000000\",\n  \"total_usdollar\": \"650000.000000\",\n  \"billing_address_street\": \"\",\n  \"billing_address_city\": \"\",\n  \"billing_address_state\": \"\",\n  \"billing_address_postalcode\": \"\",\n  \"billing_address_country\": \"\",\n  \"shipping_address_street\": \"\",\n  \"shipping_address_city\": \"\",\n  \"shipping_address_state\": \"\",\n  \"shipping_address_postalcode\": \"\",\n  \"shipping_address_country\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Quotes/index.html"}
{"id": "98c61696e33a-5", "text": "\"shipping_address_postalcode\": \"\",\n  \"shipping_address_country\": \"\",\n  \"system_id\": 1,\n  \"shipping_account_name\": \"\",\n  \"shipping_accounts\": {\n    \"name\": \"\",\n    \"id\": \"\",\n    \"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n    }\n  },\n  \"shipping_account_id\": \"\",\n  \"shipping_contact_name\": \"\",\n  \"shipping_contacts\": {\n    \"full_name\": \"\",\n    \"id\": \"\",\n    \"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n    },\n    \"last_name\": \"\"\n  },\n  \"shipping_contact_id\": \"\",\n  \"account_name\": \"\",\n  \"billing_accounts\": {\n    \"name\": \"\",\n    \"id\": \"\",\n    \"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n    }\n  },\n  \"account_id\": \"\",\n  \"billing_account_name\": \"\",\n  \"billing_account_id\": \"\",\n  \"billing_contact_name\": \"\",\n  \"billing_contacts\": {\n    \"full_name\": \"\",\n    \"id\": \"\",\n    \"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n    },\n    \"last_name\": \"\"\n  },\n  \"billing_contact_id\": \"\",\n  \"opportunity_name\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Quotes/index.html"}
{"id": "98c61696e33a-6", "text": "},\n  \"billing_contact_id\": \"\",\n  \"opportunity_name\": \"\",\n  \"opportunities\": {\n    \"name\": \"\",\n    \"id\": \"\",\n    \"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n    }\n  },\n  \"opportunity_id\": \"\",\n  \"following\": \"\",\n  \"my_favorite\": false,\n  \"tag\": [\n  ],\n  \"locked_fields\": [\n  ],\n  \"assigned_user_id\": \"\",\n  \"assigned_user_name\": \"\",\n  \"assigned_user_link\": {\n    \"full_name\": \"\",\n    \"id\": \"\",\n    \"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n    }\n  },\n  \"team_count\": \"\",\n  \"team_count_link\": {\n    \"team_count\": \"\",\n    \"id\": \"1\",\n    \"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n    }\n  },\n  \"team_name\": [\n    {\n      \"id\": \"a0512788-3680-11e7-b42f-3c15c2c94fb0\",\n      \"name\": \"Administrator\",\n      \"name_2\": \"\",\n      \"primary\": false,\n      \"selected\": false\n    },\n    {\n      \"id\": \"1\",\n      \"name\": \"Global\",\n      \"name_2\": \"\",\n      \"primary\": true,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Quotes/index.html"}
{"id": "98c61696e33a-7", "text": "\"name_2\": \"\",\n      \"primary\": true,\n      \"selected\": false\n    }\n  ],\n  \"currency_id\": \"-99\",\n  \"base_rate\": \"1.000000\",\n  \"currency_name\": \"\",\n  \"currencies\": {\n    \"name\": \"\",\n    \"id\": \"-99\",\n    \"_acl\": {\n      \"fields\": [\n      ],\n      \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n    },\n    \"symbol\": \"\"\n  },\n  \"currency_symbol\": \"\",\n  \"_acl\": {\n    \"fields\": {\n    }\n  },\n  \"_module\": \"Quotes\"\n}\nYou might notice that the Response does not contain the related data. To view the related data use the <module>/<record_id>/link/<link_name> - GET Endpoint.\nModifying the Quote's Product Bundles\nOnce the quote is created, you might need to add or remove Product Bundles from the Quote. This can be done using the /<module>/<record> - PUT\u00c2\u00a0endpoint.\n//Create a new ProductBundle\ncurl -X PUT -H OAuth-Token:<access_token> -H Cache-Control:no-cache -d '{\n  \"product_bundles\": {\n    \"delete\": [\n      \"<related_bundle_id>\"\n    ],\n    \"add\": [\n      \"<new_bundle_id>\"\n    ]\n  }\n}' http://<site_url>/rest/v11/Quotes/<record_id>\n\u00c2\u00a0The above script removes a previously related Product Bundle from the Quote and adds a different already created Product Bundle to the Quote\nResponse Payload", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Quotes/index.html"}
{"id": "98c61696e33a-8", "text": "Response Payload\nThe response payload will match the standard /<module>/<record> - PUT Endpoint Response which is the entire values of the updated record. The previous Response for Creating the quote is the same as shown above.\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Quotes/index.html"}
{"id": "2c7d4fe33b15-0", "text": "How to Export a List of Records\nOverview\nAn example\u00c2\u00a0in bash script demonstrating how to export a list of records using the v11\u00c2\u00a0/<module>/export/:record_list_id\u00c2\u00a0REST GET endpoint.\nExporting Records\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\ncurl -X POST -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{ \n \"grant_type\":\"password\",\n \"client_id\":\"sugar\",\n \"client_secret\":\"\",\n \"username\":\"admin\",\n \"password\":\"password\",\n \"platform\":\"custom_api\"\n}' https://{site_url}/rest/v11/oauth2/token\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nFiltering Records\nNext, we will need to identify the records we want to export using the /<module>/filter\u00c2\u00a0endpoint.\ncurl -s -X POST -H OAuth-Token:{access_token} -H \"Content-Type: application/json\" -H Cache-Control:no-cache -d '{  \n   \"filter\":[  \n      {  \n         \"$or\":[  \n            {  \n               \"name\":{  \n                  \"$starts\":\"A\"\n               }\n            },\n            {  \n               \"name\":{  \n                  \"$starts\":\"b\"\n               }\n            }\n         ]\n      }\n   ],\n   \"max_num\":2,\n   \"offset\":0,\n   \"fields\":\"id\",\n   \"order_by\":\"date_entered\",\n   \"favorites\":false,\n   \"my_items\":false\n}' https://{site_url}/rest/v11/Accounts/filter\nMore information on the filter API\u00c2\u00a0can be found in the /<module>/filter documentation.\nResponse", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Export_a_List_of_Records/index.html"}
{"id": "2c7d4fe33b15-1", "text": "Response\nThe data received from the server is shown below:\n{  \n   \"next_offset\":2,\n   \"records\":[  \n      {  \n         \"id\":\"f16760a4-3a52-f77d-1522-5703ca28925f\",\n         \"date_modified\":\"2016-04-05T10:23:28-04:00\",\n         \"_acl\":{  \n            \"fields\":{  \n            }\n         },\n         \"_module\":\"Accounts\"\n      },\n      {  \n         \"id\":\"ec409fbb-2b22-4f32-7fa1-5703caf78dc3\",\n         \"date_modified\":\"2016-04-05T10:23:28-04:00\",\n         \"_acl\":{  \n            \"fields\":{  \n            }\n         },\n         \"_module\":\"Accounts\"\n      }\n   ]\n}\nCreating a Record List\nOnce we have the list of ids, we then need to create a record list in Sugar that consists of those ids.\ncurl -s -X POST -H OAuth-Token:{access_token} -H \"Content-Type: application/json\" -H Cache-Control:no-cache -d '{  \n   \"records\":[  \n      \"f16760a4-3a52-f77d-1522-5703ca28925f\",\n      \"ec409fbb-2b22-4f32-7fa1-5703caf78dc3\"\n   ]\n}' https://{site_url}/rest/v11/Accounts/record_list\nResponse\nThe data received from the server is shown below:\n{  \n   \"id\":\"ef963176-4845-bc55-b03e-570430b4173c\",\n   \"assigned_user_id\":\"1\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Export_a_List_of_Records/index.html"}
{"id": "2c7d4fe33b15-2", "text": "\"assigned_user_id\":\"1\",\n   \"module_name\":\"Accounts\",\n   \"records\":[  \n      \"f16760a4-3a52-f77d-1522-5703ca28925f\",\n      \"ec409fbb-2b22-4f32-7fa1-5703caf78dc3\"\n   ],\n   \"date_modified\":\"2016-04-05 21:39:19\"\n}\nExporting Records\nOnce we have the record list created, we can then export the CSV file.\ncurl -i -s -X GET -H OAuth-Token:{access_token} -H Cache-Control:no-cache https://{site_url}/rest/v11/Accounts/export/ef963176-4845-bc55-b03e-570430b4173c\nMore information on exporting records can be found in the /<module>/export/:record_list_id\u00c2\u00a0documentation.\nResponse\nThe data received from the server is shown below:\nHTTP/1.1 200 OK \nDate: Tue, 05 Apr 2016 21:50:32 \nGMT Server: Apache/2.2.29 (Unix) \nDAV/2 PHP/5.3.29 mod_ssl/2.2.29 \nOpenSSL/0.9.8zg X-Powered-By: \nPHP/5.3.29 Expires: \nCache-Control: max-age=10, \nprivate Pragma: \nContent-Disposition: attachment; filename=Accounts.csv \nContent-transfer-encoding: binary \nLast-Modified: Tue, 05 Apr 2016 21:50:32 \nGMT ETag: 9b34f5d74e0298aaf7fd1f27d02e14f2 \nContent-Length: 1703", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Export_a_List_of_Records/index.html"}
{"id": "2c7d4fe33b15-3", "text": "Content-Length: 1703 \nConnection: close \nContent-Type: application/octet-stream; charset=ISO-8859-1 \n\"Name\",\"ID\",\"Website\",\"Office Phone\",\"Alternate Phone\",\"Fax\",\"Billing Street\",\"Billing City\",\"Billing State\",\"Billing Postal Code\",\"Billing Country\",\"Shipping Street\",\"Shipping City\",\"Shipping State\",\"Shipping Postal Code\",\"Shipping Country\",\"Description\",\"Type\",\"Industry\",\"Annual Revenue\",\"Employees\",\"SIC Code\",\"Ticker Symbol\",\"Parent Account ID\",\"Ownership\",\"Campaign ID\",\"Rating\",\"Assigned User Name\",\"Assigned User ID\",\"Team ID\",\"Teams\",\"Team Set ID\",\"Date Created\",\"Date Modified\",\"Modified By Name\",\"Modified By ID\",\"Created By\",\"Created By ID\",\"Deleted\",\"test\",\"Facebook Account\",\"Twitter Account\",\"Google Plus ID\",\"DUNS\",\"Email\",\"Invalid Email\",\"Email Opt Out\",\"Non-primary emails\" \n\"Arts & Crafts Inc\",\"ec409fbb-2b22-4f32-7fa1-5703caf78dc3\",\"www.hrinfo.tw\",\"(252) 456-8602\",\"\",\"\",\"777 West Filmore Ln\",\"Los Angeles\",\"CA\",\"77076\",\"USA\",\"777 West Filmore Ln\",\"Los Angeles\",\"CA\",\"77076\",\"USA\",\"\",\"Customer\",\"Hospitality\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"Max Jensen\",\"seed_max_id\",\"West\",\"West, East, Global\",\"dec43cb2-5273-8be2-968a-5703cadee75f\",\"2016-04-05 10:23\",\"2016-04-05 10:23\",\"Administrator\",\"1\",\"Administrator\",\"1\",\"0\",\"\",\"\",\"\",\"\",\"\",\"sugar.sugar.section@example.org\",\"0\",\"0\",\"dev.phone@example.biz,0,0\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Export_a_List_of_Records/index.html"}
{"id": "2c7d4fe33b15-4", "text": "\"B.H. Edwards Inc\",\"f16760a4-3a52-f77d-1522-5703ca28925f\",\"www.sectiondev.edu\",\"(361) 765-0216\",\"\",\"\",\"111 Silicon Valley Road\",\"Persistance\",\"CA\",\"29709\",\"USA\",\"111 Silicon Valley Road\",\"Persistance\",\"CA\",\"29709\",\"USA\",\"\",\"Customer\",\"Apparel\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"Sally Bronsen\",\"seed_sally_id\",\"West\",\"West\",\"West\",\"2016-04-05 10:23\",\"2016-04-05 10:23\",\"Administrator\",\"1\",\"Administrator\",\"1\",\"0\",\"\",\"\",\"\",\"\",\"\",\"info.sugar@example.de\",\"0\",\"1\",\"phone.sales.section@example.tv,0,0\"\nYou can also output the results directly to a CSV file by omitting the header data and output the results directly to a new CSV file.\ncurl -s -X GET -H OAuth-Token:{access_token} -H -H Cache-Control:no-cache https://{site_url}/rest/v11/Accounts/export/ef963176-4845-bc55-b03e-570430b4173c > Output.csv\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Export_a_List_of_Records/index.html"}
{"id": "8bb2ab3c2709-0", "text": "How to Fetch the Current Users Time\nOverview\nAn example in bash script demonstrating how to fetch the current users time with the v11\u00c2\u00a0/ping/whattimeisit REST GET endpoint.\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\ncurl -X POST -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{ \n \"grant_type\":\"password\",\n \"client_id\":\"sugar\",\n \"client_secret\":\"\",\n \"username\":\"admin\",\n \"password\":\"password\",\n \"platform\":\"custom_api\"\n}' https://{site_url}/rest/v11/oauth2/token\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nGetting the Current Time and Date for the User\nNext, we can get the current time and date\u00c2\u00a0using the /ping/whattimeisit endpoint.\ncurl -s -X GET -H OAuth-Token:{access_token} -H Cache-Control:no-cache https://{site_url}/rest/v11/ping/whattimeisit\nResponse\n\"2017-11-03T06:45:59-07:00\"\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Fetch_the_Current_Users_Time/index.html"}
{"id": "85e4f215a353-0", "text": "How to Get the Most Active Users\nOverview\nAn example\u00c2\u00a0in bash script demonstrating how to fetch the most active users for meetings, calls, inbound emails, and outbound emails using the v11\u00c2\u00a0/mostactiveusers REST GET\u00c2\u00a0endpoint.\nGet Most Active Users\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\ncurl -X POST -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{ \n \"grant_type\":\"password\",\n \"client_id\":\"sugar\",\n \"client_secret\":\"\",\n \"username\":\"admin\",\n \"password\":\"password\",\n \"platform\":\"custom_api\"\n}' https://{site_url}/rest/v11/oauth2/token\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nActive Users\nNext, we can retrieve\u00c2\u00a0the most active users\u00c2\u00a0using the /mostactiveusers\u00c2\u00a0endpoint.\ncurl -s -X GET -H OAuth-Token:{access_token} -H Cache-Control:no-cache https://{site_url}/rest/v11/mostactiveusers?days=30\nMore information on the mostactiveusers API\u00c2\u00a0can be found in the /mostactiveusers documentation.\u00c2\u00a0\nResponse\nThe data received from the server is shown below:\n{\n    \"meetings\": {\n        \"user_id\": \"seed_max_id\",\n        \"count\": \"21\",\n        \"first_name\": \"Max\",\n        \"last_name\": \"Jensen\"\n    },\n    \"calls\": {\n        \"user_id\": \"seed_chris_id\",\n        \"count\": \"4\",\n        \"first_name\": \"Chris\",\n        \"last_name\": \"Olliver\"\n    },\n    \"inbound_emails\": {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Get_the_Most_Active_Users/index.html"}
{"id": "85e4f215a353-1", "text": "},\n    \"inbound_emails\": {\n        \"user_id\": \"seed_chris_id\",\n        \"count\": \"23\",\n        \"first_name\": \"Chris\",\n        \"last_name\": \"Olliver\"\n    },\n    \"outbound_emails\": {\n        \"user_id\": \"seed_sarah_id\",\n        \"count\": \"20\",\n        \"first_name\": \"Sarah\",\n        \"last_name\": \"Smith\"\n    }\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Get_the_Most_Active_Users/index.html"}
{"id": "af3a7c6e91ef-0", "text": "How to Manipulate Tags (CRUD)\nOverview\nThe following page will provide examples of bash script demonstrating how to use the CRUD (Create, Read, Update, Delete) endpoints for tags in the REST v11 API.\nAuthentication\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\ncurl -X POST -H Cache-Control:no-cache -d '{ \n \"grant_type\":\"password\",\n \"client_id\":\"sugar\",\n \"client_secret\":\"\",\n \"username\":\"admin\",\n \"password\":\"password\",\n \"platform\":\"custom_api\"\n}' http://<site_url>/rest/v11/oauth2/token\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout POST endpoint documentation.\nCreating Tags\nOnce you get oauth_token you would need to use it in the following API Calls to create tags.\u00c2\u00a0\ncurl -X POST -H OAuth-Token:<access_token> -H Cache-Control:no-cache -d '{ \n   \"name\":\"Test Name\",\n}' http://<site_url>/rest/v11/Tags\nMore information on this API endpoint can be found in the /<module> POST documentation.\u00c2\u00a0\nResponse\n{\n    \"id\": \"12c6ee48-1000-11e8-8838-6a0001bcacb0\",\n    \"name\": \"Tag Name\",\n    \"date_entered\": \"2018-02-12T15:21:52+01:00\",\n    \"date_modified\": \"2018-02-12T15:21:52+01:00\",\n    \"modified_user_id\": \"1\",\n    \"modified_by_name\": \"Administrator\",\n    \"modified_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "af3a7c6e91ef-1", "text": "\"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"created_by\": \"1\",\n    \"created_by_name\": \"Administrator\",\n    \"created_by_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"description\": \"\",\n    \"deleted\": false,\n    \"name_lower\": \"tag name\",\n    \"following\": \"\",\n    \"my_favorite\": false,\n    \"locked_fields\": [],\n    \"source_id\": \"\",\n    \"source_type\": \"\",\n    \"source_meta\": \"\",\n    \"assigned_user_id\": \"1\",\n    \"assigned_user_name\": \"Administrator\",\n    \"assigned_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "af3a7c6e91ef-2", "text": "\"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"_acl\": { \"fields\": {} },\n    \"_module\": \"Tags\"\n}\nCreating Records with Tags\nYou can also create tags on initial record creation. All you need to do populate the tag field as an array when creating a record.\u00c2\u00a0Here is\u00c2\u00a0an example that demonstrates using the\u00c2\u00a0/<module> POST\u00c2\u00a0endpoint.\ncurl -X POST -H OAuth-Token:<access_token> -H Cache-Control:no-cache -d '{ \n    name: \"Test Record\",\n    tag:[\"First Tag\", \"Second Tag\"] \n}' http://<site_url>/rest/v11/Accounts\nMore information on this API endpoint can be found in the /<module> POST documentation.\nResponse\nThe data sent to the server is shown below:\n{\n    \"id\": \"ea507760-0ffd-11e8-bcf5-6a0001bcacb0\",\n    \"name\": \"Test Record\",\n    \"date_entered\": \"2018-02-12T15:06:25+01:00\",\n    \"date_modified\": \"2018-02-12T15:06:25+01:00\",\n    \"modified_user_id\": \"1\",\n    \"modified_by_name\": \"Administrator\",\n    \"modified_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "af3a7c6e91ef-3", "text": "\"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"created_by\": \"1\",\n    \"created_by_name\": \"Administrator\",\n    \"created_by_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"description\": \"\",\n    \"deleted\": false,\n    \"facebook\": \"\",\n    \"twitter\": \"\",\n    \"googleplus\": \"\",\n    \"account_type\": \"\",\n    \"industry\": \"\",\n    \"annual_revenue\": \"\",\n    \"phone_fax\": \"\",\n    \"billing_address_street\": \"\",\n    \"billing_address_street_2\": \"\",\n    \"billing_address_street_3\": \"\",\n    \"billing_address_street_4\": \"\",\n    \"billing_address_city\": \"\",\n    \"billing_address_state\": \"\",\n    \"billing_address_postalcode\": \"\",\n    \"billing_address_country\": \"\",\n    \"rating\": \"\",\n    \"phone_office\": \"\",\n    \"phone_alternate\": \"\",\n    \"website\": \"\",\n    \"ownership\": \"\",\n    \"employees\": \"\",\n    \"ticker_symbol\": \"\",\n    \"shipping_address_street\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "af3a7c6e91ef-4", "text": "\"ticker_symbol\": \"\",\n    \"shipping_address_street\": \"\",\n    \"shipping_address_street_2\": \"\",\n    \"shipping_address_street_3\": \"\",\n    \"shipping_address_street_4\": \"\",\n    \"shipping_address_city\": \"\",\n    \"shipping_address_state\": \"\",\n    \"shipping_address_postalcode\": \"\",\n    \"shipping_address_country\": \"\",\n    \"parent_id\": \"\",\n    \"sic_code\": \"\",\n    \"duns_num\": \"\",\n    \"parent_name\": \"\",\n    \"member_of\": {\n        \"name\": \"\",\n        \"id\": \"\",\n        \"_acl\": { \"fields\": [], \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\" }\n    },\n    \"campaign_id\": \"\",\n    \"campaign_name\": \"\",\n    \"campaign_accounts\": {\n        \"name\": \"\",\n        \"id\": \"\",\n        \"_acl\": { \"fields\": [], \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\" }\n    },\n    \"following\": true,\n    \"my_favorite\": false,\n    \"tag\": [\n        {\n            \"id\": \"ea69c120-0ffd-11e8-b5f6-6a0001bcacb0\",\n            \"name\": \"First Tag\",\n            \"tags__name_lower\": \"first tag\"\n        },\n        {\n            \"id\": \"eafb28e0-0ffd-11e8-8d80-6a0001bcacb0\",\n            \"name\": \"Second Tag\",\n            \"tags__name_lower\": \"second tag\"\n        }\n    ],\n    \"locked_fields\": [],\n    \"assigned_user_id\": \"\",\n    \"assigned_user_name\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "af3a7c6e91ef-5", "text": "\"assigned_user_id\": \"\",\n    \"assigned_user_name\": \"\",\n    \"assigned_user_link\": {\n        \"full_name\": \"\",\n        \"id\": \"\",\n        \"_acl\": { \"fields\": [], \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\" }\n    },\n    \"team_count\": \"\",\n    \"team_count_link\": {\n        \"team_count\": \"\",\n        \"id\": \"1\",\n        \"_acl\": { \"fields\": [], \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\" }\n    },\n    \"team_name\": [\n        {\n            \"id\": \"1\",\n            \"name\": \"Global\",\n            \"name_2\": \"\",\n            \"primary\": true,\n            \"selected\": false\n        }\n    ],\n    \"email\": [],\n    \"email1\": \"\",\n    \"email2\": \"\",\n    \"invalid_email\": \"\",\n    \"email_opt_out\": \"\",\n    \"email_addresses_non_primary\": \"\",\n    \"calculated_c\": \"\",\n    \"_acl\": { \"fields\": {} },\n    \"_module\": \"Accounts\"\n}\nReading/Retrieving Tags\nNext, we can retrieve the records using /Tags/:record\u00c2\u00a0GET endpoint. Here is the example of\u00c2\u00a0retrieving the tag\u00c2\u00a0record that we created.\u00c2\u00a0\ncurl -H OAuth-Token: -H Cache-Control:no-cache http://<site_url>/rest/v11/Tags/12c6ee48-1000-11e8-8838-6a0001bcacb0\nMore information on this API endpoint can be found in the /<module>/:record GET documentation.\u00c2\u00a0\nResponse\n{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "af3a7c6e91ef-6", "text": "Response\n{\n    \"id\": \"12c6ee48-1000-11e8-8838-6a0001bcacb0\",\n    \"name\": \"Tag Name\",\n    \"date_entered\": \"2018-02-12T15:21:52+01:00\",\n    \"date_modified\": \"2018-02-12T15:21:52+01:00\",\n    \"modified_user_id\": \"1\",\n    \"modified_by_name\": \"Administrator\",\n    \"modified_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"created_by\": \"1\",\n    \"created_by_name\": \"Administrator\",\n    \"created_by_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"description\": \"\",\n    \"deleted\": false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "af3a7c6e91ef-7", "text": "}\n    },\n    \"description\": \"\",\n    \"deleted\": false,\n    \"name_lower\": \"tag name\",\n    \"following\": \"\",\n    \"my_favorite\": false,\n    \"locked_fields\": [],\n    \"source_id\": \"\",\n    \"source_type\": \"\",\n    \"source_meta\": \"\",\n    \"assigned_user_id\": \"1\",\n    \"assigned_user_name\": \"Administrator\",\n    \"assigned_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"_acl\": { \"fields\": {} },\n    \"_module\": \"Tags\"\n}\nUpdating Tags\nYou\u00c2\u00a0can\u00c2\u00a0update a tag using the\u00c2\u00a0/Tags/:record PUT\u00c2\u00a0endpoint. In this example, we are going to update the\u00c2\u00a0Tag record that we created in the Creating Tags section and change its name to \"Renamed Tag Name\".\ncurl -X PUT -H OAuth-Token:<access_token> -H Cache-Control:no-cache -d '{ \n    \"name\":\"Renamed Tag Name\"\n}' http://<site_url>/rest/v11/Tags/12c6ee48-1000-11e8-8838-6a0001bcacb0\nMore information on this API endpoint can be found in the\u00c2\u00a0/<module>/:record\u00c2\u00a0PUT documentation.\nResponse\n{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "af3a7c6e91ef-8", "text": "Response\n{\n    \"id\": \"12c6ee48-1000-11e8-8838-6a0001bcacb0\",\n    \"name\": \"Renamed Tag Name\",\n    \"date_entered\": \"2018-02-12T15:21:52+01:00\",\n    \"date_modified\": \"2018-02-12T16:07:18+01:00\",\n    \"modified_user_id\": \"1\",\n    \"modified_by_name\": \"Administrator\",\n    \"modified_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"created_by\": \"1\",\n    \"created_by_name\": \"Administrator\",\n    \"created_by_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"description\": \"\",\n    \"deleted\": false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "af3a7c6e91ef-9", "text": "}\n    },\n    \"description\": \"\",\n    \"deleted\": false,\n    \"name_lower\": \"renamed tag name\",\n    \"following\": \"\",\n    \"my_favorite\": false,\n    \"locked_fields\": [],\n    \"source_id\": \"\",\n    \"source_type\": \"\",\n    \"source_meta\": \"\",\n    \"assigned_user_id\": \"1\",\n    \"assigned_user_name\": \"Administrator\",\n    \"assigned_user_link\": {\n        \"full_name\": \"Administrator\",\n        \"id\": \"1\",\n        \"_acl\": {\n            \"fields\": {\n                \"pwd_last_changed\": { \"write\": \"no\", \"create\": \"no\" },\n                \"last_login\": { \"write\": \"no\", \"create\": \"no\" }\n            },\n            \"delete\": \"no\",\n            \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n        }\n    },\n    \"_acl\": { \"fields\": {} },\n    \"_module\": \"Tags\"\n}\nDeleting Tags\nFinally, we will delete the record we created using /Tags/:record DELETE API request.\ncurl -X DELETE -H OAuth-Token:<access_token> -H Cache-Control:no-cache http://<site_url>/rest/v11/Tags/12c6ee48-1000-11e8-8838-6a0001bcacb0\nMore information on this API endpoint can be found in the\u00c2\u00a0/<module>/:record\u00c2\u00a0DELETE documentation.\u00c2\u00a0\nResponse\n{\"id\":\"12c6ee48-1000-11e8-8838-6a0001bcacb0\"}\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_Tags_CRUD/index.html"}
{"id": "0c3cd1c0eece-0", "text": "How to Manipulate File Attachments\nOverview\nAn example\u00c2\u00a0in bash script demonstrating how to attach a file to a record using the v11 <module>/:record/file/:field\u00c2\u00a0REST POST\u00c2\u00a0API endpoint, then retrieve it with the GET endpoint.\nManipulating File Attachments\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\ncurl -X POST -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{ \n \"grant_type\":\"password\",\n \"client_id\":\"sugar\",\n \"client_secret\":\"\",\n \"username\":\"admin\",\n \"password\":\"password\",\n \"platform\":\"custom_api\"\n}' https://{site_url}/rest/v11/oauth2/token\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nSubmitting a File Attachment\nNext, we can create a Note record using the /<module endpoint, and then\u00c2\u00a0submit\u00c2\u00a0a File to the Note\u00c2\u00a0record\u00c2\u00a0using the /<module>/:record/file/:field\u00c2\u00a0endpoint.\nCreate Note\ncurl -s -X POST -H OAuth-Token:{access_token}-H \"Content-Type: application/json\" -H Cache-Control:no-cache -d '{  \n   \"name\":\"Test Note\"\n}' https://{site_url}/rest/v11/Notes\nAdd An Attachment to the Note\ncurl -X POST -H OAuth-Token:{access_token} -H Cache-Control:no-cache -F \"filename=@/path/to/file.txt\" https://{site_url}/rest/v11/Notes/7b49aebd-8734-9773-8ef1-53553fa369c7/file/filename\nResponse\n{\n  \"filename\":{\n     \"content-type\":\"text\\/plain\",\n     \"content-length\":13,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_File_Attachments/index.html"}
{"id": "0c3cd1c0eece-1", "text": "\"content-type\":\"text\\/plain\",\n     \"content-length\":13,\n     \"name\":\"file.txt\",\n     \"uri\":\"http:\\/\\/<site url>\\/rest\\/v11\\/Notes\\/7b49aebd-8734-9773-8ef1-53553fa369c7\\/file\\/filename\"\n  },\n  \"record\":{\n     \"my_favorite\":false,\n     \"following\":true,\n     \"id\":\"7b49aebd-8734-9773-8ef1-53553fa369c7\",\n     \"name\":\"My Note\",\n     \"date_modified\":\"2014-04-21T11:53:53-04:00\",\n     \"modified_user_id\":\"1\",\n     \"modified_by_name\":\"admin\",\n     \"created_by\":\"1\",\n     \"created_by_name\":\"Administrator\",\n     \"doc_owner\":\"\",\n     \"user_favorites\":[\n     ],\n     \"description\":\"\",\n     \"deleted\":false,\n     \"assigned_user_id\":\"\",\n     \"assigned_user_name\":\"\",\n     \"team_count\":\"\",\n     \"team_name\":[\n        {\n           \"id\":1,\n           \"name\":\"Global\",\n           \"name_2\":\"\",\n           \"primary\":true\n        }\n     ],\n     \"file_mime_type\":\"text\\/plain\",\n     \"file_url\":\"\",\n     \"filename\":\"file.txt\",\n     \"parent_type\":\"\",\n     \"parent_id\":\"\",\n     \"contact_id\":\"\",\n     \"portal_flag\":false,\n     \"embed_flag\":false,\n     \"parent_name\":\"\",\n     \"contact_name\":\"\",\n     \"contact_phone\":\"\",\n     \"contact_email\":\"\",\n     \"account_id\":\"\",\n     \"opportunity_id\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_File_Attachments/index.html"}
{"id": "0c3cd1c0eece-2", "text": "\"account_id\":\"\",\n     \"opportunity_id\":\"\",\n     \"acase_id\":\"\",\n     \"lead_id\":\"\",\n     \"product_id\":\"\",\n     \"quote_id\":\"\",\n     \"_acl\":{\n        \"fields\":{\n        }\n     },\n     \"_module\":\"Notes\"\n  }\n}\nGetting a File Attachment\nNext, we can retrieve\u00c2\u00a0the file attachment stored in Sugar by utilizing the\u00c2\u00a0/<module>/:record/file/:field\u00c2\u00a0GET endpoint.\ncurl -i -s -X GET -H OAuth-Token:{access_token} -H Cache-Control:no-cache https://{site_url}/rest/v11/Notes/7b49aebd-8734-9773-8ef1-53553fa369c7/file/filename\nResponse\nHTTP/1.1 200 OK\nDate: Wed, 12 Mar 2014 15:15:03 GMT\nServer: Apache/2.2.22 (Unix) PHP/5.3.14 mod_ssl/2.2.22 OpenSSL/0.9.8o\nX-Powered-By: PHP/5.3.14 ZendServer/5.0\nSet-Cookie: ZDEDebuggerPresent=php,phtml,php3; path=/\nExpires:\nCache-Control: max-age=0, private\nPragma:\nContent-Disposition: attachment; filename=\"file.txt\"\nX-Content-Type-Options: nosniff\nETag: d41d8cd98f00b204e9800998ecf8427e\nContent-Length: 16\nConnection: close\nContent-Type: application/octet-stream\nThis is the file contents.\nYou can also output the results directly to a file by omitting the header data and output the results directly to a new file.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_File_Attachments/index.html"}
{"id": "0c3cd1c0eece-3", "text": "curl -s -X GET -H OAuth-Token:{access_token} -H Cache-Control:no-cache https://{site_url}/rest/v11/Notes/7b49aebd-8734-9773-8ef1-53553fa369c7/file/filename > file.txt\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Manipulate_File_Attachments/index.html"}
{"id": "0f8fd27fc3a6-0", "text": "How to Check for Duplicate Records\nOverview\nAn example\u00c2\u00a0in bash script demonstrating\u00c2\u00a0how to check for duplicate records using the v11 /<module>/duplicateCheck\u00c2\u00a0REST POST\u00c2\u00a0endpoint.\nDuplicate Records\nAuthenticating\nFirst, you will need to authenticate to the Sugar API. An example is shown below:\ncurl -X POST -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{ \n \"grant_type\":\"password\",\n \"client_id\":\"sugar\",\n \"client_secret\":\"\",\n \"username\":\"admin\",\n \"password\":\"password\",\n \"platform\":\"custom_api\"\n}' https://{site_url}/rest/v11/oauth2/token\nMore information on authenticating can be found in the How to Authenticate and Log Out example and /oauth2/logout\u00c2\u00a0endpoint documentation.\nRetrieving Duplicates\nNext, we will need to identify the records that are duplicates using the /<module>/duplicateCheck\u00c2\u00a0endpoint.\ncurl -s -X POST -H OAuth-Token:{access_token} -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{  \n    \"name\":\"Test Record\"\n}' https://{site_url}/rest/v11/Accounts/duplicateCheck\nMore information on the duplicate check\u00c2\u00a0API\u00c2\u00a0can be found in the /<module>/duplicateCheck\u00c2\u00a0documentation.\nResponse\nThe data received from the server is shown below:\n{\n    \"next_offset\": -1,\n    \"records\": [{\n        \"id\": \"7f6ea7be-60d6-11e6-8885-a0999b033b33\",\n        \"name\": \"Test Record\",\n        \"date_entered\": \"2016-08-12T14:48:25-07:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Check_for_Duplicate_Records/index.html"}
{"id": "0f8fd27fc3a6-1", "text": "\"date_modified\": \"2016-08-12T14:48:25-07:00\",\n        \"modified_user_id\": \"1\",\n        \"modified_by_name\": \"Administrator\",\n        \"modified_user_link\": {\n            \"full_name\": \"Administrator\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": [],\n                \"delete\": \"no\",\n                \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n            }\n        },\n        \"created_by\": \"1\",\n        \"created_by_name\": \"Administrator\",\n        \"created_by_link\": {\n            \"full_name\": \"Administrator\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": [],\n                \"delete\": \"no\",\n                \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n            }\n        },\n        \"description\": \"Test Data 1\",\n        \"deleted\": false,\n        \"facebook\": \"\",\n        \"twitter\": \"\",\n        \"googleplus\": \"\",\n        \"account_type\": \"\",\n        \"industry\": \"\",\n        \"annual_revenue\": \"\",\n        \"phone_fax\": \"\",\n        \"billing_address_street\": \"\",\n        \"billing_address_street_2\": \"\",\n        \"billing_address_street_3\": \"\",\n        \"billing_address_street_4\": \"\",\n        \"billing_address_city\": \"\",\n        \"billing_address_state\": \"\",\n        \"billing_address_postalcode\": \"\",\n        \"billing_address_country\": \"\",\n        \"rating\": \"\",\n        \"phone_office\": \"\",\n        \"phone_alternate\": \"\",\n        \"website\": \"\",\n        \"ownership\": \"\",\n        \"employees\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Check_for_Duplicate_Records/index.html"}
{"id": "0f8fd27fc3a6-2", "text": "\"website\": \"\",\n        \"ownership\": \"\",\n        \"employees\": \"\",\n        \"ticker_symbol\": \"\",\n        \"shipping_address_street\": \"\",\n        \"shipping_address_street_2\": \"\",\n        \"shipping_address_street_3\": \"\",\n        \"shipping_address_street_4\": \"\",\n        \"shipping_address_city\": \"\",\n        \"shipping_address_state\": \"\",\n        \"shipping_address_postalcode\": \"\",\n        \"shipping_address_country\": \"\",\n        \"parent_id\": \"\",\n        \"sic_code\": \"\",\n        \"duns_num\": \"\",\n        \"parent_name\": \"\",\n        \"member_of\": {\n            \"name\": \"\",\n            \"id\": \"\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"campaign_id\": \"\",\n        \"campaign_name\": \"\",\n        \"campaign_accounts\": {\n            \"name\": \"\",\n            \"id\": \"\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"following\": true,\n        \"my_favorite\": false,\n        \"tag\": [],\n        \"assigned_user_id\": \"1\",\n        \"assigned_user_name\": \"Administrator\",\n        \"assigned_user_link\": {\n            \"full_name\": \"Administrator\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": [],\n                \"delete\": \"no\",\n                \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n            }\n        },\n        \"team_count\": \"\",\n        \"team_count_link\": {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Check_for_Duplicate_Records/index.html"}
{"id": "0f8fd27fc3a6-3", "text": "},\n        \"team_count\": \"\",\n        \"team_count_link\": {\n            \"team_count\": \"\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"team_name\": [{\n            \"id\": \"1\",\n            \"name\": \"Global\",\n            \"name_2\": \"\",\n            \"primary\": true\n        }],\n        \"email\": [],\n        \"email1\": \"\",\n        \"email2\": \"\",\n        \"invalid_email\": \"\",\n        \"email_opt_out\": \"\",\n        \"email_addresses_non_primary\": \"\",\n        \"_acl\": {\n            \"fields\": {}\n        },\n        \"_module\": \"Accounts\",\n        \"duplicate_check_rank\": 8\n    }, {\n        \"id\": \"868b4f16-60d6-11e6-bdfc-a0999b033b33\",\n        \"name\": \"Test Record\",\n        \"date_entered\": \"2016-08-12T14:48:37-07:00\",\n        \"date_modified\": \"2016-08-12T14:48:37-07:00\",\n        \"modified_user_id\": \"1\",\n        \"modified_by_name\": \"Administrator\",\n        \"modified_user_link\": {\n            \"full_name\": \"Administrator\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": [],\n                \"delete\": \"no\",\n                \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n            }\n        },\n        \"created_by\": \"1\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Check_for_Duplicate_Records/index.html"}
{"id": "0f8fd27fc3a6-4", "text": "}\n        },\n        \"created_by\": \"1\",\n        \"created_by_name\": \"Administrator\",\n        \"created_by_link\": {\n            \"full_name\": \"Administrator\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": [],\n                \"delete\": \"no\",\n                \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n            }\n        },\n        \"description\": \"Test Data 2\",\n        \"deleted\": false,\n        \"facebook\": \"\",\n        \"twitter\": \"\",\n        \"googleplus\": \"\",\n        \"account_type\": \"\",\n        \"industry\": \"\",\n        \"annual_revenue\": \"\",\n        \"phone_fax\": \"\",\n        \"billing_address_street\": \"\",\n        \"billing_address_street_2\": \"\",\n        \"billing_address_street_3\": \"\",\n        \"billing_address_street_4\": \"\",\n        \"billing_address_city\": \"\",\n        \"billing_address_state\": \"\",\n        \"billing_address_postalcode\": \"\",\n        \"billing_address_country\": \"\",\n        \"rating\": \"\",\n        \"phone_office\": \"\",\n        \"phone_alternate\": \"\",\n        \"website\": \"\",\n        \"ownership\": \"\",\n        \"employees\": \"\",\n        \"ticker_symbol\": \"\",\n        \"shipping_address_street\": \"\",\n        \"shipping_address_street_2\": \"\",\n        \"shipping_address_street_3\": \"\",\n        \"shipping_address_street_4\": \"\",\n        \"shipping_address_city\": \"\",\n        \"shipping_address_state\": \"\",\n        \"shipping_address_postalcode\": \"\",\n        \"shipping_address_country\": \"\",\n        \"parent_id\": \"\",\n        \"sic_code\": \"\",\n        \"duns_num\": \"\",\n        \"parent_name\": \"\",\n        \"member_of\": {\n            \"name\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Check_for_Duplicate_Records/index.html"}
{"id": "0f8fd27fc3a6-5", "text": "\"parent_name\": \"\",\n        \"member_of\": {\n            \"name\": \"\",\n            \"id\": \"\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"campaign_id\": \"\",\n        \"campaign_name\": \"\",\n        \"campaign_accounts\": {\n            \"name\": \"\",\n            \"id\": \"\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"following\": true,\n        \"my_favorite\": false,\n        \"tag\": [],\n        \"assigned_user_id\": \"1\",\n        \"assigned_user_name\": \"Administrator\",\n        \"assigned_user_link\": {\n            \"full_name\": \"Administrator\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": [],\n                \"delete\": \"no\",\n                \"_hash\": \"8e11bf9be8f04daddee9d08d44ea891e\"\n            }\n        },\n        \"team_count\": \"\",\n        \"team_count_link\": {\n            \"team_count\": \"\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"team_name\": [{\n            \"id\": \"1\",\n            \"name\": \"Global\",\n            \"name_2\": \"\",\n            \"primary\": true\n        }],\n        \"email\": [],\n        \"email1\": \"\",\n        \"email2\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Check_for_Duplicate_Records/index.html"}
{"id": "0f8fd27fc3a6-6", "text": "\"email\": [],\n        \"email1\": \"\",\n        \"email2\": \"\",\n        \"invalid_email\": \"\",\n        \"email_opt_out\": \"\",\n        \"email_addresses_non_primary\": \"\",\n        \"_acl\": {\n            \"fields\": {}\n        },\n        \"_module\": \"Accounts\",\n        \"duplicate_check_rank\": 8\n    }]\n}\n  \tLast modified: 2023-02-03 21:09:36", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Web_Services/REST_API/Bash/How_to_Check_for_Duplicate_Records/index.html"}
{"id": "0e48aaaf5735-0", "text": "Dynamically Hiding Subpanels Based on Record Values\nOverview\nThis article will demonstrate how to dynamically hide subpanels that are dependent on record values by overriding the subpanels layout for a module. This example is for an account record where we will hide the Contacts subpanel when the account type is not 'Customer'.\nExample\nTo accomplish this, we will create a JavaScript controller that extends SubpanelsLayout. This controller will then monitor the model and control the display of the subpanels.\n./custom/modules/Accounts/clients/base/layouts/subpanels/subpanels.js\nRemoved script tag to: https://gist.github.com/3722771.js?file=view.detail.php\n({\n    extendsFrom: 'SubpanelsLayout',\n    _hiddenSubpanels: [],\n    initialize: function(options) {\n        this._super('initialize', [options]);\n        this.registerModelEvents();\n    },\n    /**\n     * Add the model change events for fields that determine when a subpanel should be hidden\n     */\n    registerModelEvents: function(){\n        this.model.on('change:account_type',function(model) {\n            var link = 'contacts';\n            if (model.get('account_type') == \"Customer\"){\n                this.unhideSubpanel(link);\n            }else{\n                this.hideSubpanel(link);\n            }\n        },this);\n    },\n    /**\n     * Override showSubpanel to re-hide subpanels when outside changes occur, like reordering subpanel\n     * @inheritdoc\n     */\n    showSubpanel: function(linkName) {\n        this._super('showSubpanel',[linkName]);\n        _.each(this._hiddenSubpanels, function(link) {\n            this.hideSubpanel(link);\n        },this);\n    },\n    /**\n     * Helper for getting the Subpanel View for a specific link\n     */", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Dynamically_Hiding_Subpanels_Based_on_Record_Values/index.html"}
{"id": "0e48aaaf5735-1", "text": "/**\n     * Helper for getting the Subpanel View for a specific link\n     */\n    getSubpanelByLink: function(link){\n        return this._components.find(function(component){\n           return component.context.get('link') === link;\n        });\n    },\n    /**\n     * Add to the _hiddenSubpanels array, and hide the subpanel\n     */\n    hideSubpanel: function(link){\n        this._hiddenSubpanels.push(link);\n        var component = this.getSubpanelByLink(link);\n        if (!_.isUndefined(component)){\n            component.hide();\n        }\n        this._hiddenSubpanels = _.unique(this._hiddenSubpanels);\n    },\n    /**\n     * Unhide the Subpanel and remove from _hiddenSubpanels array\n     */\n    unhideSubpanel: function(link){\n        var index = this._hiddenSubpanels.findIndex(function(l){\n            return l == link;\n        });\n        if (_.isUndefined(index)){\n            delete this._hiddenSubpanels[index];\n        }\n        var component = this.getSubpanelByLink(link);\n        if (!_.isUndefined(component)){\n            component.show();\n        }\n    }\n})\nOnce the file is in place, run a Quick Repair and Rebuild. The changes will then be reflected in the Accounts record view.\nRelated\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Dynamically_Hiding_Subpanels_Based_on_Record_Values/index.html"}
{"id": "6a5ddfad54ec-0", "text": "Converting Address' Country Field to a Dropdown\nOverview\nAddress fields in Sugar\u00c2\u00ae are normally text fields, which allow users to enter in the appropriate information (e.g. street, city, and country) for the record. However, with\u00c2\u00a0multiple users working in Sugar, it is possible for data (e.g. country) to be entered in a variety of different ways (e.g. USA, U.S.A, and United States) when creating or editing the record. This can cause some issues when creating a report grouped by the Billing Country field, for example, as records with the same country will be grouped separately based on the different ways the country was entered. \u00c2\u00a0\nThis article will cover how to change the address' Billing Country field to a dropdown list which will allow users to select a single\u00c2\u00a0value (e.g. USA) and maintain consistency in data throughout the system. \u00c2\u00a0 \u00c2\u00a0\nNote: This article pertains to Sugar versions 6.x and 7.x.\nUse Case\nIn this example, we will convert the Billing Country field in the Accounts module to a dropdown-type field to allow values to be selected from a dropdown list.\nPrerequisites\nA part of making this change involves mapping\u00c2\u00a0the \"countries_dom\" dropdown list to your existing\u00c2\u00a0Billing Country field's values. This dropdown list can be accessed and modified via Admin > Dropdown Editor. For more information on editing dropdown lists, please refer to the\u00c2\u00a0Developer Tools\u00c2\u00a0documentation. It is very important that the existing values in the Billing Country field exactly\u00c2\u00a0match the Item Name values in the \"countries_dom\" dropdown list in order for the values to convert properly. If the existing value (e.g. United States) does not match one of the country options (e.g. USA) in the dropdown list, then the new dropdown version of the Billing Country field will most likely default to a blank value for that record record.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Changing_Address_Country_Field_to_a_Dropdown/index.html"}
{"id": "6a5ddfad54ec-1", "text": "To avoid such issues, please review and update all of your existing Billing Country text field values prior to making this change. For more information on updating many records at once via import, please refer to the Updating Records Via Import\u00c2\u00a0article.\u00c2\u00a0\nSteps to Complete\nConverting Field to Dropdown\nUse the following steps to change the Billing Country field to a dropdown list:\nFirst, we will\u00c2\u00a0associate the Billing Country field in the Accounts module with the \"countries_dom\" dropdown. Locate the following directory in your Sugar file system: ./custom/Extension/modules/Accounts/Ext/Vardefs/\nLocate a file called\u00c2\u00a0sugarfield_billing_address_country.php\u00c2\u00a0which controls the billing_address_country field and add the following lines to the file. This will set the field type to 'enum' and define the dropdown (countries_dom) to use for the field.\u00c2\u00a0Note: If this file or location does not exist, then you will need to first create this path and file.Your file should look like this:\n<?php\n$dictionary['Account']['fields']['billing_address_country']['type']='enum';\n$dictionary['Account']['fields']['billing_address_country']['options']='countries_dom';", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Changing_Address_Country_Field_to_a_Dropdown/index.html"}
{"id": "6a5ddfad54ec-2", "text": "$dictionary['Account']['fields']['billing_address_country']['options']='countries_dom';\nNow, since the address block is handled uniquely in Sugar, we will also need to modify the template file in order to display the field as a dropdown anywhere the layout is being used in backward compatibility mode. To do this in an upgrade safe way, you will need to copy the file located in\u00c2\u00a0./include/SugarFields/Fields/Address/en_us.EditView.tpl and place it in the following directory: ./custom/include/SugarFields/Fields/Address/.\u00c2\u00a0If you are using multiple languages in Sugar, you will need to make this change for each language-type in your system. For our example, we will be focusing on the \"en_us\" language.Note: You will most likely need to create this directory as it likely\u00c2\u00a0does not already exist.\nOnce the en_us.EditView.tpl file is in the custom directory,\u00c2\u00a0locate the line for the input html element for the country field. The line of code should look similar to this:<input type=\"text\" name=\"{{$country}}\" id=\"{{$country}}\" size=\"{{$displayParams.size|default:30}}\" {{if !empty($vardef.len)}}maxlength='{{$vardef.len}}'{{/if}} value='{$fields.{{$country}}.value}' tabindex=\"{{$tabindex}}\">\nDirectly between the list shown above and the <td> appearing before it, add the following lines to display the field as a dropdown:{if (!isset($config.enable_autocomplete) || $config.enable_autocomplete==false) && isset($fields.{{$country}}.options)}\n<select name=\"{{$country}}\" id=\"{{$country}}\" title=''>\n{if isset($fields.{{$country}}.value) && $fields.{{$country}}.value != ''}\n{html_options options=$fields.{{$country}}.options selected=$fields.{{$country}}.value}\n{else}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Changing_Address_Country_Field_to_a_Dropdown/index.html"}
{"id": "6a5ddfad54ec-3", "text": "{else}\n{html_options options=$fields.{{$country}}.options selected=$fields.{{$country}}.default}\n{/if}\n</select>\n{else}\n<input type=\"text\" name=\"{{$country}}\" id=\"{{$country}}\" size=\"{{$displayParams.size|default:30}}\" {{if !empty($vardef.len)}}maxlength='{{$vardef.len}}'{{/if}} value='{$fields.{{$country}}.value}' tabindex=\"{{$tabindex}}\">\n{/if}\nSave the changes to the file.\nOnce the necessary change has been made, please navigate to Admin > Repair and perform a Quick Repair and Rebuild in order for the change to take effect. Your Billing Country field will now display as a dropdown field in the Accounts module.\nPlease note that only the Account module's Billing Country field will be converted to a dropdown field once this change is applied. If you wish to have the Shipping Country field converted to a dropdown as well, please follow the steps\u00c2\u00a0above, but be sure to make the change specific to the \"shipping_address_country\" field. In addition, you can make this change for other modules (e.g. Contacts and Leads) as well by specifying the appropriate module name (e.g. Contacts) and field name (e.g. Primary Address Country) when going through the steps.\nUpdating the Field Type for List View Filter\nOnce the appropriate changes have been made per the section above, use the following steps to get the list view filter to recognize the change:\nNavigate to Admin > Studio > Accounts > Layouts > Search.\nDrag the Billing Country field from the Default column to the Hidden column and click \"Save & Deploy\".\nNow drag the Billing Country field back to the Default column and click \"Save & Deploy\" again.\nThis will retrieve the Billing Country field in its new state and add it to the account's list view filter.\nApplication", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Changing_Address_Country_Field_to_a_Dropdown/index.html"}
{"id": "6a5ddfad54ec-4", "text": "Application\nOnce the Billing Country field is converted successfully to a dropdown, all records that had an existing value in the field should have the matching country automatically selected. Going forward, users will simply need to select the appropriate country when entering address information in Sugar.\u00c2\u00a0\nPlease note that administrators can add additional country values as necessary to the\u00c2\u00a0\"countries_dom\" dropdown via Admin > Dropdown Editor. For more information on editing dropdown lists, please refer to the Developer Tools documentation. \u00c2\u00a0\nThe Billing Country field will now appear as follows:\nFor Accounts record view:\u00c2\u00a0\nFor Accounts list view filter: \n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Changing_Address_Country_Field_to_a_Dropdown/index.html"}
{"id": "4fa66f0885a0-0", "text": "Creating an Auto-Incrementing Field\nOverview\nThis article will cover the two approaches to creating an auto-incrementing field in Sugar.\nCase 1: Auto-Incrementing a Field Using a Logic Hook\nThe benefits of having an auto-incrementing field populated from a logic hook are that it can be incremented based on additional logic. It also allows for multiple auto-incrementing fields, while a database-level auto-incrementing field is only allowed once per table. Auto-incremented fields handled in a logic hook can also be formatted as needed, such as adding leading zeros or alpha characters. You can also control the auto-increment value based on another field, for instance, if you wanted to increase a version_number based on other records related to the same parent. For this example, we will create a simple auto-incrementing field that goes up by 1 whenever the record is saved for the first time.\nFirst, create an integer field incrementing_number_c in Studio.\nNext, create a custom class and method that the logic hook will call:\n./custom/modules/Accounts/Accounts_Save.php\n<?php\nclass Accounts_Save\n{\n    function auto_increment($bean, $event, $arguments)\n    {\n        if (!$arguments['isUpdate']) {\n            $sq = new \\SugarQuery();\n            $sq->from(BeanFactory::newBean('Accounts'), ['team_security' => false]);\n            $sq->select->fieldRaw('MAX(' . $sq->getFromAlias() . '_cstm.incrementing_number_c)', 'current_max_id');\n            $current_max_id = $sq->getOne();\n            $max_id = (empty($current_max_id)) ? 1 : $current_max_id + 1;\n            $bean->incrementing_number_c = $max_id;\n        }\n    }\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Creating_an_Auto-Incrementing_Field/index.html"}
{"id": "4fa66f0885a0-1", "text": "}\n    }\n}\nNext, register the custom logic hook via the LogicHooks Extension framework by creating a file at ./custom/Extension/modules/Accounts/Ext/LogicHooks. An example is shown below:\n./custom/Extension/modules/Accounts/Ext/LogicHooks/autoIncrementOnSave.php\n<?php\n$hook_array['before_save'][] = array(\n    2, \n    'Custom Logic to Auto-Increment integer_field_c', \n    'custom/modules/Accounts/Accounts_Save.php',\n    'Accounts_Save', \n    'auto_increment'\n);\nAfter creating these files, run a Quick Repair and Rebuild.\nCase 2: Creating an Auto-Incrementing Field on the Database\nCreating an auto-incrementing field at the database level has the benefit of being unique and easy to manage. One downside to having an auto-incrementing field at the database level is that it means only being allowed one such field per module, as databases only allow one auto-incrementing field per table. A custom auto-incrementing field also relies on updating a module's core table, which is less upgrade safe. For this reason, a logic hook based auto-incrementing field is recommended over a database-driven auto-incrementing field.\nTo create an integer field in Sugar which auto-increments at the database level, we will create a custom field via the VarDefs extension as shown below:\n./custom/Extension/modules/Accounts/Ext/Vardefs/autoIncrement.php\n<?php\n$dictionary['Account']['fields']['account_number_auto'] = array (\n    'name' => 'account_number_auto',\n    'vname' => 'LBL_NUMBER_AUTO',\n    'type' => 'int',\n    'readonly' => true,\n    'len' => 11,\n    'required' => true,\n    'auto_increment' => true,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Creating_an_Auto-Incrementing_Field/index.html"}
{"id": "4fa66f0885a0-2", "text": "'required' => true,\n    'auto_increment' => true,\n    'unified_search' => true,\n    'full_text_search' => array(\n        'enabled' => true, \n        'searchable' => true, \n        'boost' => 1.25\n    ),\n    'comment' => 'Visual unique identifier',\n    'duplicate_merge' => 'disabled',\n    'disable_num_format' => true,\n    'studio' => array('quickcreate' => false),\n    'duplicate_on_record_copy' => 'no',\n);\n$dictionary['Account']['indices']['account_number_auto'] = array(\n    'name' =>'accountsnumk_cstm', \n    'type' =>'unique', \n    'fields'=>array('account_number_auto'),\n);\nNavigate to Admin > Studio > Repair > Quick Repair and Rebuild. After the repair, you will see a vardef comparison as shown below:\n/*COLUMNS*/\n/*MISSING IN DATABASE - account_number_auto - ROW*/\nALTER TABLE accounts add COLUMN account_number_auto int(11) NOT NULL auto_increment;\n/* INDEXES */\n/*MISSING INDEX IN DATABASE - accountsnumk_cstm - unique ROW */\nALTER TABLE accounts ADD CONSTRAINT UNIQUE accountsnumk_cstm (account_number_auto);;\nAlter this to be the following and execute the changes:\nALTER TABLE accounts add COLUMN account_number_auto int(11) UNIQUE NOT NULL auto_increment;", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Creating_an_Auto-Incrementing_Field/index.html"}
{"id": "4fa66f0885a0-3", "text": "ALTER TABLE accounts add COLUMN account_number_auto int(11) UNIQUE NOT NULL auto_increment;\nNote: Since auto-incremented fields are populated at the database level, all existing records in the database will have this field populated as soon as the field is created on the database table. The value assigned will not be based on any logic (such as the record creation date) that can be controlled or predicted. Therefore when sorting by this field, records created after the field was added will be in order that they were created, but records created before will not.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Creating_an_Auto-Incrementing_Field/index.html"}
{"id": "b11bfc212cbc-0", "text": "Passing Data to Templates\nOverview\nThis page explains how to create a custom view component that passes data to the Handlebars template.\nSteps to Complete\nThe view component will render the actual content on the page. The view below will display data passed to it from the controller.\n./custom/clients/base/views/my-dataview/my-dataview.js\n({\n    className: 'tcenter',\n    loadData: function (options) {\n        //populate your data\n        myData=new Object();\n        myData.myProperty = \"My Value\";\n        this.myData = myData;\n        \n        /*\n            //alternatively, you can pass in a JSON array to populate your data\n            myData = $.parseJSON( '{\"myData\":{\"myProperty\":\"My Value\"}}' );\n            _.extend(this, myData);\n        */\n        this.render();\n        //reset flags on reload\n        if (options && _.isFunction(options.complete)) {\n            options.complete();\n        }\n        \n        // Another Alternative you can get the date from an end point\n        let self = this;\n        app.api.call(\"read\", app.api.buildURL(\"Accounts/4bbd3b4e-755d-11e9-9a7b-f45c89a8598f\"), null, {\n            success: function (accountResponse) {\n                self.myData['account'] = accountResponse;\n                self.render();\n            },\n        })\n    },\n})\nNext, add the Handlebars template to render the data. An example is shown below:\n./custom/clients/base/views/my-dataview/my-dataview.hbs\n{{#with myData}}\n {{account.name}} - {{account.assigned_user_name}} <br>\n {{myProperty}}\n{{/with}}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Passing_Data_to_Templates/index.html"}
{"id": "b11bfc212cbc-1", "text": "{{myProperty}}\n{{/with}}\nOnce the files are in place, add the\u00c2\u00a0view to a layout and then navigate to Admin > Repair > Quick Repair and Rebuild.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Passing_Data_to_Templates/index.html"}
{"id": "3dbf03ddfe94-0", "text": "Creating Custom Field Types\nOverview\nIn this\u00c2\u00a0example, we create a custom field type called\u00c2\u00a0\"Highlightfield\", which\u00c2\u00a0will mimic the base text field type with the added feature that the displayed text for the field will be highlighted in a color chosen when the field is created in Studio.\nThis example requires the following steps, which are covered in the sections and subsections below:\nCreating the JavaScript Controller\nDefining the Handlebar Templates\nAdding the Field Type to Studio\nEnabling Search and Filtering\nNote: Custom field types are not currently functional for use in Reports and will break Report Wizard.\nNaming a Custom Field Type in Sugar\nWhen choosing a name for a custom field type, keep in mind the following rules:\nThe first letter of a custom field type's name must be capitalized.\nAll subsequent\u00c2\u00a0letters in the field type's name must be lowercase.\nA field type's name cannot contain non-letter characters such as 0-9, hyphens, or dashes.\nTherefore, in\u00c2\u00a0this\u00c2\u00a0example, the field type \"Highlightfield\" cannot be called HighLightField or highlightfield.\nCreating the JavaScript Controller\nFirst,\u00c2\u00a0create a\u00c2\u00a0controller file. Since we are starting from scratch, we need\u00c2\u00a0to extend the base field template. To accomplish this, create\u00c2\u00a0./custom/clients/base/fields/Highlightfield/Highlightfield.js. This file will contain the JavaScript needed to render the field and format the values. By default, all fields extend the base template and do not require you to add the extendsFrom property. An\u00c2\u00a0example\u00c2\u00a0template is shown below:\n./custom/clients/base/fields/Highlightfield/Highlightfield.js\n({\n    /**\n     * Called when initializing the field\n     * @param options\n     */\n    initialize: function(options) {\n        this._super('initialize', [options]);\n    },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Creating_Custom_Fields/index.html"}
{"id": "3dbf03ddfe94-1", "text": "this._super('initialize', [options]);\n    },\n    /**\n     * Called when rendering the field\n     * @private\n     */\n    _render: function() {\n        this._super('_render');\n    },\n    /**\n     * Called when formatting the value for display\n     * @param value\n     */\n    format: function(value) {\n        return this._super('format', [value]);\n    },\n    /**\n     * Called when unformatting the value for storage\n     * @param value\n     */\n    unformat: function(value) {\n        return this._super('unformat', [value]);\n    }\n})\nNote:\u00c2\u00a0This controller file example contains methods for initialize, _render, format, and unformat. These are shown for your ease of use but are not necessarily needed for this customization. For example, you could choose to create an empty controller consisting of nothing other than\u00c2\u00a0({}) and the field would render as expected in this example.\nDefining the Handlebar Templates\nNext,\u00c2\u00a0define the\u00c2\u00a0handlebar templates. The templates will nearly match the base template\u00c2\u00a0found in ./clients/base/fields/base/ with the minor difference of an additional attribute\u00c2\u00a0of style=\"background:{{def.backcolor}}; color:{{def.textcolor}}\"\u00c2\u00a0for the detail and list templates.\nDetail View\nThe first template\u00c2\u00a0to\u00c2\u00a0define is the Sidecar detail view. This template handles the display of data on the record\u00c2\u00a0view.\n./custom/clients/base/fields/Highlightfield/detail.hbs\n{{!\n    The data for field colors are passed into the handlebars template through the def array. For this example, the def.backcolor and def.textcolor properties. These indexes are defined in:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Creating_Custom_Fields/index.html"}
{"id": "3dbf03ddfe94-2", "text": "./custom/modules/DynamicFields/templates/Fields/TemplateHighlightfield.php\n}}\n{{#if value}}\n    <div class=\"ellipsis_inline\" data-placement=\"bottom\" style=\"background:{{def.backcolor}}; color:{{def.textcolor}}\">\n        {{value}}\n    </div>\n{{/if}}\nEdit View\nNow define the Sidecar edit view. This template handles the display of the\u00c2\u00a0field in the edit view.\n./custom/clients/base/fields/Highlightfield/edit.hbs.\n{{!\n    We have not made any edits to this file that differ from stock, however,\n    we could add styling here just as we did for the detail and list templates.\n}}\n<input type=\"text\"\n    name=\"{{name}}\"\n    value=\"{{value}}\"\n    {{#if def.len}}maxlength=\"{{def.len}}\"{{/if}}\n    {{#if def.placeholder}}placeholder=\"{{str def.placeholder this.model.module}}\"{{/if}}\n    class=\"inherit-width\">\n<p class=\"help-block\">\nList View\nFinally, define the list view. This template handles the display of the custom field in list views.\n./custom/clients/base/fields/Highlightfield/list.hbs\u00c2\u00a0\n{{!\n    The data for field colors are passed into the handlebars template through the def array. Our case\n    being the def.backcolor and def.textcolor properties.  These indexes are defined in:\n    ./custom/modules/DynamicFields/templates/Fields/TemplateHighlightfield.php\n}}\n<div class=\"ellipsis_inline\" data-placement=\"bottom\" data-original-title=\"{{#unless value}}\n    {{#if def.placeholder}}{{str def.placeholder this.model.module}}{{/if}}{{/unless}}{{value}}\"\n     style=\"background:{{def.backcolor}}; color:{{def.textcolor}}\">\n    {{#if def.link}}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Creating_Custom_Fields/index.html"}
{"id": "3dbf03ddfe94-3", "text": "{{#if def.link}}\n       <a href=\"{{#if def.events}}javascript:void(0);{{else}}{{href}}{{/if}}\">{{value}}</a>{{else}}{{value}}\n    {{/if}}\n</div>\nAdding the Field Type to Studio\nTo enable the new\u00c2\u00a0field type for use in Studio, define the Studio field template. This will also allow us to map any additional properties we need for the\u00c2\u00a0templates. For this example,\u00c2\u00a0map the ext1 and ext2 fields from the fields_meta_data table to the backcolor and textcolor definitions. Also, set\u00c2\u00a0the dbfield definition to\u00c2\u00a0varchar\u00c2\u00a0so that the correct database field type is created.\nNote: We are setting \"reportable\" to false to avoid issues with Report Wizard.\n./custom/modules/DynamicFields/templates/Fields/TemplateHighlightfield.php\n<?php\nif (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nrequire_once 'modules/DynamicFields/templates/Fields/TemplateField.php';\nclass TemplateHighlightfield extends TemplateField\n{\n    var $type = 'varchar';\n    var $supports_unified_search = true;\n    /**\n     * TemplateAutoincrement Constructor: Map the ext attribute fields to the relevant color properties\n     *\n     * References:      get_field_def function below\n     *\n     * @returns field_type\n     */\n    function __construct()\n    {\n        $this->vardef_map['ext1'] = 'backcolor';\n        $this->vardef_map['ext2'] = 'textcolor';\n        $this->vardef_map['backcolor'] = 'ext1';\n        $this->vardef_map['textcolor'] = 'ext2';\n    }\n    //BEGIN BACKWARD COMPATIBILITY", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Creating_Custom_Fields/index.html"}
{"id": "3dbf03ddfe94-4", "text": "}\n    //BEGIN BACKWARD COMPATIBILITY\n    // AS 7.x does not have EditViews and DetailViews anymore these are here\n    // for any modules in backwards compatibility mode.\n    function get_xtpl_edit()\n    {\n        $name = $this->name;\n        $returnXTPL = array();\n        if (!empty($this->help)) {\n            $returnXTPL[strtoupper($this->name . '_help')] = translate($this->help, $this->bean->module_dir);\n        }\n        if (isset($this->bean->$name)) {\n            $returnXTPL[$this->name] = $this->bean->$name;\n        } else {\n            if (empty($this->bean->id)) {\n                $returnXTPL[$this->name] = $this->default_value;\n            }\n        }\n        return $returnXTPL;\n    }\n    function get_xtpl_search()\n    {\n        if (!empty($_REQUEST[$this->name])) {\n            return $_REQUEST[$this->name];\n        }\n    }\n    function get_xtpl_detail()\n    {\n        $name = $this->name;\n        if (isset($this->bean->$name)) {\n            return $this->bean->$name;\n        }\n        return '';\n    }\n    //END BACKWARD COMPATIBILITY\n    /**\n     * Function:        get_field_def\n     * Description:        Get the field definition attributes that are required for the Highlightfield Field\n     *                      the primary reason this function is here is to set the dbType to 'varchar',\n     *                      otherwise 'Highlightfield' would be used by default.\n     * References:      __construct function above\n     *\n     * @return            Field Definition\n     */", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Creating_Custom_Fields/index.html"}
{"id": "3dbf03ddfe94-5", "text": "*\n     * @return            Field Definition\n     */\n    function get_field_def()\n    {\n        $def = parent::get_field_def();\n        //set our fields database type\n        $def['dbType'] = 'varchar';\n        //set our fields to false to avoid issues with Report Wizard.\n        $def['reportable'] = false;\n        //set our field as custom type\n        $def['custom_type'] = 'varchar';\n        //map our extension fields for colorizing the field\n        $def['backcolor'] = !empty($this->backcolor) ? $this->backcolor : $this->ext1;\n        $def['textcolor'] = !empty($this->textcolor) ? $this->textcolor : $this->ext2;\n        return $def;\n    }\n}\nNote: For the\u00c2\u00a0custom field type, the\u00c2\u00a0ext1, ext2, ext3, and ext4\u00c2\u00a0database fields in the fields_meta_data table\u00c2\u00a0offer\u00c2\u00a0additional property storage.\nCreating the Form Controller\nNext, set up the field's form controller. This controller will handle the field's form template in Admin > Studio > Fields and allow us to assign color values to the Smarty template.\n./custom/modules/DynamicFields/templates/Fields/Forms/Highlightfield.php\n<?php\nif (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nrequire_once 'custom/modules/DynamicFields/templates/Fields/TemplateHighlightfield.php';\n/**\n * Implement get_body function to correctly populate the template for the ModuleBuilder/Studio\n * Add field page.\n *\n * @param Sugar_Smarty $ss\n * @param array $vardef\n *\n */\nfunction get_body(&$ss, $vardef)\n{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Creating_Custom_Fields/index.html"}
{"id": "3dbf03ddfe94-6", "text": "*\n */\nfunction get_body(&$ss, $vardef)\n{\n    global $app_list_strings, $mod_strings;\n    $vars = $ss->get_template_vars();\n    $fields = $vars['module']->mbvardefs->vardefs['fields'];\n    $fieldOptions = array();\n    foreach ($fields as $id => $def) {\n        $fieldOptions[$id] = $def['name'];\n    }\n    $ss->assign('fieldOpts', $fieldOptions);\n    //If there are no colors defined, use black text on\n    // a white background\n    if (isset($vardef['backcolor'])) {\n        $backcolor = $vardef['backcolor'];\n    } else {\n        $backcolor = '#ffffff';\n    }\n    if (isset($vardef['textcolor'])) {\n        $textcolor = $vardef['textcolor'];\n    } else {\n        $textcolor = '#000000';\n    }\n    $ss->assign('BACKCOLOR', $backcolor);\n    $ss->assign('TEXTCOLOR', $textcolor);\n    $colorArray = $app_list_strings['highlightColors'];\n    asort($colorArray);\n    $ss->assign('highlightColors', $colorArray);\n    $ss->assign('textColors', $colorArray);\n    $ss->assign('BACKCOLORNAME', $app_list_strings['highlightColors'][$backcolor]);\n    $ss->assign('TEXTCOLORNAME', $app_list_strings['highlightColors'][$textcolor]);\n    return $ss->fetch('custom/modules/DynamicFields/templates/Fields/Forms/Highlightfield.tpl');\n}\n?>\nCreating the Smarty Template", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Creating_Custom_Fields/index.html"}
{"id": "3dbf03ddfe94-7", "text": "}\n?>\nCreating the Smarty Template\nOnce the\u00c2\u00a0form controller is in place, create the Smarty template. The .tpl below will define the center content of the field's Studio edit view.\u00c2\u00a0The template includes\u00c2\u00a0a coreTop.tpl and coreBottom.tpl file. These files\u00c2\u00a0add the base\u00c2\u00a0field properties such as\u00c2\u00a0\"Name\" and \"Display Label\" that are common across all field types. This allows us to focus on\u00c2\u00a0the fields that are specific to our new field type.\n./custom/modules/DynamicFields/templates/Fields/Forms/Highlightfield.tpl\n{include file=\"modules/DynamicFields/templates/Fields/Forms/coreTop.tpl\"}\n<tr>\n    <td class='mbLBL'>{sugar_translate module=\"DynamicFields\" label=\"COLUMN_TITLE_DEFAULT_VALUE\"}:</td>\n    <td>\n        {if $hideLevel < 5}\n            <input type='text' name='default' id='default' value='{$vardef.default}'\n                   maxlength='{$vardef.len|default:50}'>\n        {else}\n            <input type='hidden' id='default' name='default' value='{$vardef.default}'>{$vardef.default}\n        {/if}\n    </td>\n</tr>\n<tr>\n    <td class='mbLBL'>{sugar_translate module=\"DynamicFields\" label=\"COLUMN_TITLE_MAX_SIZE\"}:</td>\n    <td>\n        {if $hideLevel < 5}\n            <input type='text' name='len' id='field_len' value='{$vardef.len|default:25}'\n                  onchange=\"forceRange(this,1,255);changeMaxLength(document.getElementById('default'),this.value);\">\n            <input type='hidden' id=\"orig_len\" name='orig_len' value='{$vardef.len}'>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Creating_Custom_Fields/index.html"}
{"id": "3dbf03ddfe94-8", "text": "{if $action==\"saveSugarField\"}\n                <input type='hidden' name='customTypeValidate' id='customTypeValidate' value='{$vardef.len|default:25}'\n                       onchange=\"if (parseInt(document.getElementById('field_len').value) < parseInt(document.getElementById('orig_len').value)) return confirm(SUGAR.language.get('ModuleBuilder', 'LBL_CONFIRM_LOWER_LENGTH')); return true;\">\n            {/if}\n        {literal}\n            <script>\n                function forceRange(field, min, max) {\n                    field.value = parseInt(field.value);\n                    if (field.value == 'NaN')field.value = max;\n                    if (field.value > max) field.value = max;\n                    if (field.value < min) field.value = min;\n                }\n                function changeMaxLength(field, length) {\n                    field.maxLength = parseInt(length);\n                    field.value = field.value.substr(0, field.maxLength);\n                }\n            </script>\n        {/literal}\n        {else}\n            <input type='hidden' name='len' value='{$vardef.len}'>{$vardef.len}\n        {/if}\n    </td>\n</tr>\n<tr>\n    <td class='mbLBL'>{sugar_translate module=\"DynamicFields\" label=\"LBL_HIGHLIGHTFIELD_BACKCOLOR\"}:</td>\n    <td>\n        {if $hideLevel < 5}\n            {html_options name=\"ext1\" id=\"ext1\" selected=$BACKCOLOR options=$highlightColors}\n        {else}\n            <input type='hidden' id='ext1' name='ext1' value='{$BACKCOLOR}'>\n            {$BACKCOLORNAME}\n        {/if}\n    </td>\n</tr>\n<tr>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Creating_Custom_Fields/index.html"}
{"id": "3dbf03ddfe94-9", "text": "{/if}\n    </td>\n</tr>\n<tr>\n    <td class='mbLBL'>{sugar_translate module=\"DynamicFields\" label=\"LBL_HIGHLIGHTFIELD_TEXTCOLOR\"}:</td>\n    <td>\n        {if $hideLevel < 5}\n            {html_options name=\"ext2\" id=\"ext2\" selected=$TEXTCOLOR options=$highlightColors}\n        {else}\n            <input type='hidden' id='ext2' name='ext2' value='{$TEXTCOLOR}'>\n            {$TEXTCOLORNAME}\n        {/if}\n    </td>\n</tr>\n{include file=\"modules/DynamicFields/templates/Fields/Forms/coreBottom.tpl\"}\nRegistering the Field Type\nOnce you\u00c2\u00a0have defined the\u00c2\u00a0Studio template, register the\u00c2\u00a0field as a valid field type. For this example, the\u00c2\u00a0field\u00c2\u00a0will inherit the base field type\u00c2\u00a0as it is a\u00c2\u00a0text field. In doing this, we are\u00c2\u00a0able\u00c2\u00a0to override the core\u00c2\u00a0functions. The most used override is the save function shown below.\n./custom/include/SugarFields/Fields/Highlightfield/SugarFieldHighlightfield.php\n<?php\nrequire_once 'include/SugarFields/Fields/Base/SugarFieldBase.php';\nrequire_once 'data/SugarBean.php';\nclass SugarFieldHighlightfield extends SugarFieldBase\n{\n    //this function is called to format the field before saving.  For example we could put code in here\n    // to check spelling or to change the case of all the letters\n    public function save(&$bean, $params, $field, $properties, $prefix = '')\n    {\n        $GLOBALS['log']->debug(\"SugarFieldHighlightfield::save() function called.\");", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Creating_Custom_Fields/index.html"}
{"id": "3dbf03ddfe94-10", "text": "$GLOBALS['log']->debug(\"SugarFieldHighlightfield::save() function called.\");\n        parent::save($bean, $params, $field, $properties, $prefix);\n    }\n}\n?>\nCreating Language Definitions\nFor the new\u00c2\u00a0field,\u00c2\u00a0you must\u00c2\u00a0define several language extensions to ensure everything is displayed correctly. This section includes\u00c2\u00a0three steps:\nAdding the Custom Field to the Type List\nCreating Labels for Studio\nDefining Dropdown Controls\nAdding the Custom Field to the Type List\nDefine the\u00c2\u00a0new field type in the\u00c2\u00a0field types list. This will allow an Administrator to select the Highlightfield\u00c2\u00a0field type in Studio when creating a new field.\n./custom/Extension/modules/ModuleBuilder/Ext/Language/en_us.Highlightfield.php\n<?php\n$mod_strings['fieldTypes']['Highlightfield'] = 'Highlighted Text';\nCreating Labels for Studio\nOnce the field\u00c2\u00a0type is defined, add the labels for the\u00c2\u00a0Studio template.\n./custom/Extension/modules/DynamicFields/Ext/Language/en_us.Highlightfield.php\n<?php\n$mod_strings['LBL_HIGHLIGHTFIELD'] = 'Highlighted Text';\n$mod_strings['LBL_HIGHLIGHTFIELD_FORMAT_HELP'] = '';\n$mod_strings['LBL_HIGHLIGHTFIELD_BACKCOLOR'] = 'Background Color';\n$mod_strings['LBL_HIGHLIGHTFIELD_TEXTCOLOR'] = 'Text Color';\nDefining Dropdown Controls\nFor this example, we must define dropdown lists, which will be available in Studio for an administrator to add or remove color options for the field type.\n./custom/Extension/application/Ext/Language/en_us.Highlightfield.php\n<?php\n$app_strings['LBL_HIGHLIGHTFIELD_OPERATOR_CONTAINS'] = 'contains';\n$app_strings['LBL_HIGHLIGHTFIELD_OPERATOR_NOT_CONTAINS'] = 'does not contain';", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Creating_Custom_Fields/index.html"}
{"id": "3dbf03ddfe94-11", "text": "$app_strings['LBL_HIGHLIGHTFIELD_OPERATOR_NOT_CONTAINS'] = 'does not contain';\n$app_strings['LBL_HIGHLIGHTFIELD_OPERATOR_STARTS_WITH'] = 'starts with';\n$app_list_strings['highlightColors'] = array(\n    '#0000FF' => 'Blue',\n    '#00ffff' => 'Aqua',\n    '#FF00FF' => 'Fuchsia',\n    '#808080' => 'Gray',\n    '#ffff00' => 'Olive',\n    '#000000' => 'Black',\n    '#800000' => 'Maroon',\n    '#ff0000' => 'Red',\n    '#ffA500' => 'Orange',\n    '#ffff00' => 'Yellow',\n    '#800080' => 'Purple',\n    '#ffffff' => 'White',\n    '#00ff00' => 'Lime',\n    '#008000' => 'Green',\n    '#008080' => 'Teal',\n    '#c0c0c0' => 'Silver',\n    '#000080' => 'Navy'\n);\nEnabling Search and Filtering\nTo enable Highlightfield\u00c2\u00a0for searching and filtering, define the filter operators and the Sugar widget.\nDefining the Filter Operators\nThe\u00c2\u00a0filter operators, defined in\u00c2\u00a0./custom/clients/base/filters/operators/operators.php, \u00c2\u00a0allow the custom field be used\u00c2\u00a0for searching in\u00c2\u00a0Sidecar listviews.\u00c2\u00a0\n./custom/clients/base/filters/operators/operators.php\n<?php\nrequire 'clients/base/filters/operators/operators.php';\n$viewdefs['base']['filter']['operators']['Highlightfield'] = array(\n    '$contains' => 'LBL_HIGHLIGHTFIELD_OPERATOR_CONTAINS',\n    '$not_contains' => 'LBL_HIGHLIGHTFIELD_OPERATOR_NOT_CONTAINS',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Creating_Custom_Fields/index.html"}
{"id": "3dbf03ddfe94-12", "text": "'$not_contains' => 'LBL_HIGHLIGHTFIELD_OPERATOR_NOT_CONTAINS',\n    '$starts' => 'LBL_HIGHLIGHTFIELD_OPERATOR_STARTS_WITH',\n);\nNote: The labels for the\u00c2\u00a0filters in this example are defined in \u00c2\u00a0./custom/Extension/application/Ext/Language/en_us.Highlightfield.php. For the full list of filters in the system, you can look at ./clients/base/filters/operators/operators.php.\nDefining the Sugar Widget\nFinally, define the Sugar widget. The widget will help our field for display on Reports and subpanels in backward compatibility. It also controls how search filters are applied\u00c2\u00a0to our field.\n./custom/include/generic/SugarWidgets/SugarWidgetFieldHighlightfield.php\n<?php\nif (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nrequire_once 'include/generic/SugarWidgets/SugarWidgetFieldvarchar.php';\nclass SugarWidgetFieldHighlightfield extends SugarWidgetFieldVarchar\n{\n    function SugarWidgetFieldText(&$layout_manager)\n    {\n        parent::SugarWidgetFieldVarchar($layout_manager);\n    }\n    function queryFilterEquals($layout_def)\n    {\n        return $this->reporter->db->convert($this->_get_column_select($layout_def), \"text2char\") .\n        \" = \" . $this->reporter->db->quoted($layout_def['input_name0']);\n    }\n    function queryFilterNot_Equals_Str($layout_def)\n    {\n        $column = $this->_get_column_select($layout_def);\n        return \"($column IS NULL OR \" . $this->reporter->db->convert($column, \"text2char\") . \" != \" .\n        $this->reporter->db->quoted($layout_def['input_name0']) . \")\";\n    }", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Creating_Custom_Fields/index.html"}
{"id": "3dbf03ddfe94-13", "text": "}\n    function queryFilterNot_Empty($layout_def)\n    {\n        $column = $this->_get_column_select($layout_def);\n        return \"($column IS NOT NULL AND \" . $this->reporter->db->convert($column, \"length\") . \" > 0)\";\n    }\n    function queryFilterEmpty($layout_def)\n    {\n        $column = $this->_get_column_select($layout_def);\n        return \"($column IS NULL OR \" . $this->reporter->db->convert($column, \"length\") . \" = 0)\";\n    }\n    function displayList($layout_def)\n    {\n        return nl2br(parent::displayListPlain($layout_def));\n    }\n}\n?>\nOnce the files are in place, navigate to Admin > Repair > Quick Repair and Rebuild. It is also best practice\u00c2\u00a0to clear your browser cache before using the new\u00c2\u00a0field type in Studio.\n  \tLast modified: 2023-03-09 22:43:32", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Creating_Custom_Fields/index.html"}
{"id": "43a8e91d5236-0", "text": "Changing the Default Module When Logging a New Call or Meeting\nOverview\nWhen creating\u00c2\u00a0a\u00c2\u00a0call\u00c2\u00a0or meeting directly from the\u00c2\u00a0Calls or\u00c2\u00a0Meetings module\u00c2\u00a0in Sugar, the default module for the Related To field is Accounts. If\u00c2\u00a0your sales team frequently schedules calls and meetings related to\u00c2\u00a0records from a module other than Accounts, it may make sense to adjust\u00c2\u00a0the behavior so that the Related To field defaults to a more commonly used module.\u00c2\u00a0This article covers\u00c2\u00a0how to change the default related module for calls and meetings in Sugar.\nNote: This article pertains to Sugar versions 6.x and 7.x.\nPrerequisites\nThis change requires code-level customizations, which requires\u00c2\u00a0direct access to the server or familiarity with creating and installing module loadable packages. If you need assistance making these changes and already have a relationship with a Sugar partner, you can work with them to make this customization.\u00c2\u00a0If not, please refer to the Partner Page to find a reselling partner to help with your development needs.\nNote: Sugar Sell Essentials customers do not have the ability to upload custom file packages to Sugar using Module Loader.\nSteps to Complete\nFor this example, we will change the\u00c2\u00a0default \"Relates To\" module to Contacts for records created in the Calls module and the Meetings module.\u00c2\u00a0Please note that,\u00c2\u00a0after completing these steps, the Related To field will still default\u00c2\u00a0to Accounts when creating a call or meeting from a contact that has an account relationship or to the\u00c2\u00a0current module from any other related module's\u00c2\u00a0record view.\nCalls\nCreate the following directory path if it does not already exist from the root of your Sugar instance directory:./custom/Extension/modules/Calls/Ext/Vardefs/\nCreate a file in the directory called sugarfield_parent_type.php with the following contents:<?php", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Changing_the_Default_Module_When_Logging_a_New_Call_or_Meeting/index.html"}
{"id": "43a8e91d5236-1", "text": "Create a file in the directory called sugarfield_parent_type.php with the following contents:<?php \n$dictionary['Call']['fields']['parent_type']['default'] = 'Contacts';\nSave the file and ensure that the file has the correct permissions\u00c2\u00a0by referring to the Required File System Permissions on Linux\u00c2\u00a0and Required File System Permissions on Windows With IIS\u00c2\u00a0articles.\nLog into Sugar as an administrator and navigate to Admin > Repair and perform a Quick Repair and Rebuild.\nOnce the quick repair completes, navigate to the Calls module and \"Contact\" should now be selected by default for the Related To field when logging a new call.\nMeetings\nCreate the following directory path if it does not already exist from the root of your Sugar instance directory: ./custom/Extension/modules/Meetings/Ext/Vardefs/.\nCreate a file in the directory called sugarfield_parent_type.php with the following contents:<?php\n$dictionary['Meeting']['fields']['parent_type']['default'] = 'Contacts';\nSave the file and ensure that the file has the correct permissions\u00c2\u00a0by referring to the Required File System Permissions on Linux\u00c2\u00a0and Required File System Permissions on Windows With IIS\u00c2\u00a0articles.\nLog into Sugar as an administrator and navigate to Admin > Repair and perform a Quick Repair and Rebuild.\nOnce the quick repair completes, navigate to the Meetings module and \"Contact\" should now be selected by default for the Related To field when scheduling a new meeting.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Cookbook/Changing_the_Default_Module_When_Logging_a_New_Call_or_Meeting/index.html"}
{"id": "a8da3f1c8e5f-0", "text": "Integration\nOverview\nHow to integrate with Sugar APIs\nTopicsBest PracticesBest practices when integrating and migrating Sugar.Web ServicesDocumentation on Sugar Web Service APIs.ExternalResourceClientDocumentation on ExternalResourceClient, which replaces cURL.MigrationInformation on migrating data and Sugar instances.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/index.html"}
{"id": "5e75e2350eb6-0", "text": "Best Practices\nOverview\nBest practices when integrating and migrating Sugar.\nLatency When Posting Data To Sugar\nWhen integrating with Sugar, it is best to avoid long-running web requests. While performance-draining\u00c2\u00a0requests are not always obvious, once an issue has been identified, it is best to move the processing to the backend.\nBy default, we expect a request\u00c2\u00a0to an endpoint such as POST\u00c2\u00a0/Accounts\u00c2\u00a0to be straightforward, however, adding Workflows, Logic Hooks, and Sugar Logic may stress the otherwise simple process and cause issues with webheads\u00c2\u00a0and other resources being used in the process. If you are experiencing these symptoms, the following sections may help you.\nDisabling Related Calculation Fields\nWhen a calculated field in Sugar uses the related function in the Sugar Logic, this will cause the calculated field to be executed when the related module is updated. This can cause a cascading effect through the system to update related calculated fields. When this happens you may receive a 502 Gateway Error. You can disable the related calculation field updates temporarily or permanently\u00c2\u00a0by adding the following line to the config_override.php file:\n$sugar_config['disable_related_calc_fields'] = true;\nNote : This is a global setting that will affect all modules. If you have a calculated field in Accounts that sums up all Opportunities for the account, setting this value to true will no longer update the opportunity account sum in Accounts until the account record itself is modified. However, if this setting is left disabled, the sum would update any time a related opportunity or the account is modified.\nMore information on this setting can be found in the core configuration settings.\nDisabling Logic Hooks", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Best_Practices/index.html"}
{"id": "5e75e2350eb6-1", "text": "More information on this setting can be found in the core configuration settings.\nDisabling Logic Hooks\nWhen data is being migrated\u00c2\u00a0into Sugar, logic hooks may be adding unnecessary time to your API requests. It is highly recommended for you to disable any unnecessary\u00c2\u00a0logic hooks from your system during an initial import. Logic hook definitions may be located in the following files and/or directories:\n./custom/modules/logic_hooks.php\n./custom/modules/<module>/logic_hooks.php\n./custom/Extension/application/Ext/LogicHooks/\n./custom/Extension/modules/<module>/Ext/LogicHooks/\nDisabling Workflows\nWhen data is being migrated\u00c2\u00a0into Sugar,\u00c2\u00a0workflows\u00c2\u00a0may be adding unnecessary time to your API requests. It is highly recommended for you to disable any unnecessary\u00c2\u00a0workflows from your system during an initial import in Admin > Workflows.\nQueuing Data in the Job Queue\nOne solution for long running requests is to send the data to the Job Queue to be processed by the cron. To accomplish this, make a file customization to add to the\u00c2\u00a0target processing function. For this article's use case, create \u00c2\u00a0./custom/Extension/modules/Schedulers/Ext/ScheduledTasks/CustomCreateAccountJob.php and send any stored data to it for processing. Enter the following code in the php file:\n<?php\nfunction CustomCreateAccountJob($job)\n{\n\tif (!empty($job->data)) {\n\t\t$account = BeanFactory::newBean('Accounts');\n\t\t$fields = json_decode($job->data, true);\n\t\tforeach($fields as $field => $value) {\n\t\t    $account->$field = $value;\n\t\t}\n\t\t$account->save();\n\t\tif (!empty($account->id)) {\n\t\t     return true;\n\t\t}\n\t }\n\t return false;\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Best_Practices/index.html"}
{"id": "5e75e2350eb6-2", "text": "return true;\n\t\t}\n\t }\n\t return false;\n}\nNext, modify the request to pass the new account data to the SchedulerJobs module in the data field and specify the new function in the target field, as follows:\u00c2\u00a0\ncurl -v -H \"oauth-token: 4afd4aea-df99-7cec-4d94-560a97cda9f8\" -H \"Content-Type: application/json\" -X POST -d '{\"assigned_user_id\": \"1\", \"name\":\"Queue Create Account\", \"status\":\"queued\", \"data\":\"{\\\"name\\\": \\\"Example Account\\\"}\", \"target\":\"function::CustomCreateAccountJob\"}' http://<site_url>rest/v10/SchedulersJobs\nThis solution will queue data for processing and free up system resources to send more requests. For more information, please refer to the Scheduler Jobs\u00c2\u00a0documentation.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Best_Practices/index.html"}
{"id": "adc126a1195b-0", "text": "ExternalResourceClient\nOverview\nIn Sugar 12.1,\u00c2\u00a0ExternalResourceClient was introduced to replace cURL. This has also been backported to all supported versions of Sugar. Therefore any apps or integrations for Sugar that use a Module Loadable Package (MLP) that includes any of the PHP curl_*, socket_*, or stream_* functions will need to change to use the ExternalResourceClient lib.\nSelf-Signed Certificates\nExternalResourceClient is designed to be as secure as possible. We will not support disabling the check for authenticity of the peer's certificate as you could in cURL with using the CURLOPT_SSL_VERIFYPEER option. This is not a security best practice and is therefore not allowed in the new client.\nIf your target URL has an invalid or self-signed certificate, you can benefit from using Let's Encrypt. Let's Encrypt is\u00c2\u00a0a free, automated, and open Certificate Authority (CA) that makes it possible to set up an HTTPS server and have it automatically obtain a browser-trusted certificate without any human intervention. You can get started here.\nTLS Mutual Authentication\nExternalResourceClient\u00c2\u00a0supports TLS mutual authentication where it ensures that the parties at each end of a network connection are who they claim to be by verifying that they both have the correct private key. The information within their respective TLS certificates\u00c2\u00a0provides additional verification is designed to be as secure as possible. In cURL it could be achieved using the curl_setopt($ch, CURLOPT_SSLCERT, <CERT_FILE>);\u00c2\u00a0and\u00c2\u00a0curl_setopt($ch, CURLOPT_SSLKEY, <KEY_FILE>);\u00c2\u00a0options.\nExternalResourceClient can be configured with the following options or any of those available in the PHP SSL Context options.:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/ExternalResourceClient/index.html"}
{"id": "adc126a1195b-1", "text": "local_cert\u00c2\u00a0- Path to local certificate file on filesystem. It must be a PEM encoded file which contains your certificate and private key. It can optionally contain the certificate chain of issuers. The private key also may be contained in a separate file specified by local_pk.\nlocal_pk\u00c2\u00a0- Path to local private key file on filesystem in case of separate files for certificate (local_cert) and private key.\n<?php\n$client = (new ExternalResourceClient())\n    ->setSslContextOptions([\n        'local_cert' => '<CERT_FILE>', //CURLOPT_SSLCERT analogue\n        'local_pk' => '<KEY_FILE>', // CURLOPT_SSLKEY\n    ]);\n\u00c2\u00a0\nIP vs Domain/Hostnames via DNS\nExternalResourceClient does not support using an IP address in your URL. Editing /etc/hosts\u00c2\u00a0on your server is a very easy and fast way of accomplishing this, but if that is not an option and you have a proper DNS server configured, you can use one of the following articles to help you understand what DNS is and how you can configure them in different OSs and infrastructures.\nBuild your own DNS server on Linux\nDNS Configuration: Everything You Need to Know\nHow to Setup DNS Server on Windows Server 2012\nDNS Over HTTPS Configuration\nThe security.use_doh configuration setting enables remote Domain Name System (DNS) resolution via the HTTPS protocol. A goal of the method is to increase user privacy and security by preventing eavesdropping and manipulation of DNS data by man-in-the-middle attacks by using the HTTPS protocol to encrypt the data between the DoH (DNS over HTTPS) client and the DoH-based DNS resolver.\nWhen enabled, it will use dns.google (8.8.4.4) to resolve hostnames.\nFor more details on the\u00c2\u00a0security.use_doh\u00c2\u00a0configuration setting, see the Core Settings page.\nLocal Endpoints", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/ExternalResourceClient/index.html"}
{"id": "adc126a1195b-2", "text": "Local Endpoints\nIf you do not know what server-side request forgery (SSRF) is, please refer to this detailed explanation and examples of how an attacker can reach your local network using malicious HTTP requests.\nExternalResourceClient prevents this type of attack by taking the resolved IP from your URL and checking against a Sugar Config $sugar_config['security']['private_ips'] array list.\nThis list contains a wide range of internal IPs blocked by default [ '10.0.0.0|10.255.255.255', '172.16.0.0|172.31.255.255', '192.168.0.0|192.168.255.255', '169.254.0.0|169.254.255.255', '127.0.0.0|127.255.255.255'] .\nFor example, if your URL is http://an-internal-url/api/get and \"an-internal-url\" resolves to an IP 10.0.0.87, it will throw an exception because it is within the range of your config.\nAdd your critical IP ranges to this config so no attacker will get to sensitive IPs through ExternalResourceClient's HTTP Request.\nSugar Proxy\nTo get proxy settings,\u00c2\u00a0ExternalResourceClient relies on Administration::getSettings('proxy'). This utility queries Sugar's infrastructure (cache or DB) to retrieve those settings, therefore it needs to be bootstrapped into SugarCRM.\nIn the case of MLPs that use standard modules via the web, you don't need to manually bootstrap SugarCRM, so you may use ExternalResourceClient in your methods without requiring entryPoint.php\nIf\u00c2\u00a0you are writing a CLI script, you\u00c2\u00a0must\u00c2\u00a0include SugarCRM entryPoint.php:\n<?php\nif (!defined('sugarEntry')) {\n   define('sugarEntry', true);\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/ExternalResourceClient/index.html"}
{"id": "adc126a1195b-3", "text": "define('sugarEntry', true);\n}\ndefine('ENTRY_POINT_TYPE', 'api');\nrequire_once 'include/entryPoint.php';\n?>\nTest your customization\nYou can easily test your package by enabling PackageScanner checks in the supported versions for now ($sugar_config['moduleInstaller']['enableEnhancedModuleChecks'] = true), remember, it comes disabled by default in 12.1.\nIf your code doesn't go through PackageScanner, it will not be enforced, that's the premise we're working with.\nExamples of Replacing cURL\nThe below examples can be used as a guideline for replacing your current cURL code with ExternalResourceClient.\nYou must import this client and its exceptions (if needed) from:\n<?php\nuse Sugarcrm\\Sugarcrm\\Security\\HttpClient\\ExternalResourceClient;\nuse Sugarcrm\\Sugarcrm\\Security\\HttpClient\\RequestException;\nHTTP GET\nThe following code snippet provides you with a code replacement from cURL GET to ExternalResourceClient.\nBefore:\n// cURL GET\n$ch = curl_init();\n$url = 'https://httpbin.org/get';\ncurl_setopt_array($ch, array(\n    CURLOPT_URL => $url,\n    CURLOPT_RETURNTRANSFER => true,\n    CURLOPT_ENCODING => \"\",\n    CURLOPT_MAXREDIRS => 10,\n    CURLOPT_TIMEOUT => 60,\n    CURLOPT_FOLLOWLOCATION => true,\n    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_2TLS,\n));\n$response = curl_exec($ch);\n$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);\n$errorNo = curl_errno($ch);\n$error = curl_error($ch);\nif ($errorNo !== 0) {\n    $GLOBALS['log']->log(\"fatal\", \"curl error ($errorNo): $error\");\n    throw new \\SugarApiExceptionError(\"curl error ($errorNo): $error\");\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/ExternalResourceClient/index.html"}
{"id": "adc126a1195b-4", "text": "}\ncurl_close($ch);\nif ($httpCode === 0 || $httpCode >= 400) {\n    $GLOBALS['log']->log(\"fatal\", \"Error message: $error\");\n    throw new \\SugarApiException($error, null, null, $httpCode ? $httpCode : 500);\n}\necho $response;\nAfter:\n// ExternalResourceClient GET\ntry {\n    // Set timeout to 60 seconds and 10 max redirects\n    $response = (new ExternalResourceClient(60, 10))->get($url);\n} catch (RequestException $e) {\n    $GLOBALS['log']->log('fatal', 'Error: ' . $e->getMessage());\n    throw new \\SugarApiExceptionError($e->getMessage());\n}\n$httpCode = $response->getStatusCode();\nif ($httpCode >= 400) {\n    $GLOBALS['log']->log(\"fatal\", \"Request failed with status: \" . $httpCode);\n    throw new \\SugarApiException(\"Request failed with status: \" . $httpCode, null, null, $httpCode);\n}\necho $response->getBody()->getContents();\nHTTP POST\nThe following code snippet provides you with a code replacement from cURL POST to ExternalResourceClient.\nBefore:\n// cURL POST JSON\n$url = 'https://httpbin.org/post';\n$ch = curl_init($url);\ncurl_setopt($ch, CURLOPT_POST, 1);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);\ncurl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 1);\ncurl_setopt($ch, CURLOPT_HTTPHEADER, array (\"Content-Type: application/json\"));\ncurl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(['foo' => 'bar']));", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/ExternalResourceClient/index.html"}
{"id": "adc126a1195b-5", "text": "curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(['foo' => 'bar']));\n$response = curl_exec($ch);\ncurl_close($ch);\n$parsed = !empty($response) ? json_decode($response, true) : null;\nvar_dump($parsed);\nAfter:\n// ExternalResourceClient POST JSON\ntry {\n    $response = (new ExternalResourceClient())->post($url, json_encode(['foo' => 'bar']), ['Content-Type' => \"application/json\"]);\n} catch (RequestException $e) {\n    throw new \\SugarApiExceptionError($e->getMessage());\n}\n$parsed = !empty($response) ? json_decode($response->getBody()->getContents(), true) : null;\nvar_dump($parsed);\nAuthenticated Endpoints (CURLOPT_USERPWD)\nThe following code snippet provides you with a code replacement from cURL to ExternalResourceClient passing authentication params.\nBefore:\n$username = 'foo';\n$password = 'bar';\n$url = 'https://httpbin.org/basic-auth/{$username}/{$password}';\n$ch = curl_init($url);\ncurl_setopt($ch, CURLOPT_USERPWD, $username . $password);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);\ncurl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 1);\ncurl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(['foo' => 'bar']));\n$response = curl_exec($ch);\ncurl_close($ch);\n$parsed = !empty($response) ? json_decode($response, true) : null;\nvar_dump($parsed);\nAfter:\n$username = 'foo';\n$password = 'bar';\n$auth     = base64_encode( \"{$username}:{$password}\" );\n //Passing custom 'Authorization' header", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/ExternalResourceClient/index.html"}
{"id": "adc126a1195b-6", "text": "//Passing custom 'Authorization' header\n// try + catch is omitted for brevity\n$response = (new ExternalResourceClient())->get(\"https://httpbin.org/basic-auth/{$username}/{$password}\", [\n    'Authorization' => 'Basic ' . $auth,\n]);\necho $response->getBody()->getContents();\n// OR the same by using user:password@hostname.tld URL format\n // try + catch is omitted for brevity\n$response = (new ExternalResourceClient())->get(\"https://{$username}:{$password}@httpbin.org/basic-auth/{$username}/{$password}\");\necho $response->getBody()->getContents();\nStream\nThe following code snippet provides you with a code replacement from stream to ExternalResourceClient.\nBefore:\n<?php\n// Sending GET\nif ($stream = fopen('https://httpbin.org/get', 'r')) {\n    echo stream_get_contents($stream);\n}\n// Sending POST\n$options = [\n    'http' => [\n        'method' => 'POST',\n        'header' => [\"Content-Type: application/x-www-form-urlencoded\"],\n        'content' => http_build_query(['fieldName' => 'value', 'fieldName2' => 'another value']),\n        'ignore_errors' => true,\n    ],\n];\n$context = stream_context_create($options);\nif ($stream = fopen('https://httpbin.org/post', 'r', false, $context)) {\n    echo stream_get_contents($stream);\n}\nAfter:\n// Using ExtenalResourceClient\n// GET\necho (new ExternalResourceClient())\n->get('https://httpbin.org/get')\n->getBody()\n->getContents();\n// POST\necho (new ExternalResourceClient())\n->post(\n'https://httpbin.org/post',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/ExternalResourceClient/index.html"}
{"id": "adc126a1195b-7", "text": "->post(\n'https://httpbin.org/post', \n['fieldName' => 'value', 'fieldName2' => 'another value']\n)\n->getBody()\n->getContents();\nSocket\nThe following code snippet provides you with a code replacement from socket to ExternalResourceClient.\nBefore:\n<?php \n// Sending GET\n$fp = fsockopen(\"httpbin.org\", 80, $errno, $errstr, 30);\nif (!$fp) {\n    echo \"$errstr ($errno)\\n\";\n} else {\n    $out = \"GET /get HTTP/1.1\\r\\n\";\n    $out .= \"Host: httpbin.org\\r\\n\";\n    $out .= \"Connection: Close\\r\\n\\r\\n\";\n    fwrite($fp, $out);\n    while (!feof($fp)) {\n        echo fgets($fp, 128);\n    }\n    fclose($fp);\n}\n// Sending POST\n$fp = fsockopen(\"httpbin.org\", 80, $errno, $errstr, 30);\nif (!$fp) {\n    echo \"$errstr ($errno)\\n\";\n} else {\n    $postData = http_build_query(['fieldName' => 'value', 'fieldName2' => 'another value']);\n    $out = \"POST /post HTTP/1.1\\r\\n\";\n    $out .= \"Host: httpbin.org\\r\\n\";\n    $out .= \"Content-type: application/x-www-form-urlencoded\\r\\n\";\n    $out .= \"Content-length: \" . strlen($postData) . \"\\r\\n\";\n    $out .= \"Connection: Close\\r\\n\\r\\n\";\n    $out .= \"{$postData}\\r\\n\\r\\n\";\n    fwrite($fp, $out);\n    while (!feof($fp)) {\n        echo fgets($fp, 128);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/ExternalResourceClient/index.html"}
{"id": "adc126a1195b-8", "text": "while (!feof($fp)) {\n        echo fgets($fp, 128);\n    }\n    fclose($fp);\n}\nAfter:\n// Using ExtenalResourceClient\n// GET\necho (new ExternalResourceClient())\n->get('http://httpbin.org/get')\n->getBody()\n->getContents();\n// POST\necho (new ExternalResourceClient())\n->post(\n'http://httpbin.org/post', \n['fieldName' => 'value', 'fieldName2' => 'another value']\n)\n->getBody()\n->getContents();\nUpload a file\nThe following code snippet provides you with a code example using ExternalResourceClient to upload files from Sugar.\n// Uploading files from `upload` directory\n// File data will be accessible on the target server as $_FILES['file_field_name']\necho 'File upload', PHP_EOL, PHP_EOL;\n$file = new UploadFile('file_field_name');\n// relative to `upload` directory\n$filename = 'f68/2cad6f68-e016-11ec-9c9c-0242ac140007';\n$file->temp_file_location = $file->get_upload_path($filename);\n// try + catch is omitted for brevity\necho (new ExternalResourceClient())->upload(\n    $file,\n    'https://httpbin.org/post',\n    'POST',\n    ['foo' => 'bar'], // Optional, additional form data\n    ['custom-header-name' => 'custom-header-value'] // Optional, additional headers\n)->getBody()->getContents();\n  \tLast modified: 2023-04-25 18:53:05", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/ExternalResourceClient/index.html"}
{"id": "1dfaf94002a4-0", "text": "Migration\n  Migrating Sugar instances and external data.\nTopicsMigrating From On-Site to SugarCloudThe following article describes the process of migrating an on-site deployment to the SugarCloud environment.Migrating From SugarCloud to On-SiteOccasionally, system administrators will have the need to deploy versions of their instance hosted on Sugar's cloud service to an on-site system. Reasons for this type of deployment are:Migrating From a Broken Instance to a Clean InstallThe following article describes the process of migrating a potentially broken instance to a clean install.Importing RecordsCovers the Sugar structure when migrating data into the application.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Migration/index.html"}
{"id": "3a7d66ccdcad-0", "text": "Migrating From a Broken Instance to a Clean Install\nOverview\nThe following article describes the process of migrating a potentially broken instance to a clean install.\nThis is beneficial in the use case of corrupted core files. This will not correct issues caused by\u00c2\u00a0broken customizations.\nRequirements\nTo migrate your instance to a clean install you will need to\u00c2\u00a0do the following:\nHave full permissions to modify the system files.\nIdentify your Sugar version.\u00c2\u00a0Note: The version of your instance can be found by clicking the Help link in Sugar's footer or navigating to the About page from your user menu.\u00c2\u00a0\nOnce you have identified your Sugar version, you will need to download the full installer package of your Sugar version from your account's\u00c2\u00a0Downloads page.\nIf you are on 13.0.0 Pro, you must download the\u00c2\u00a0SugarPro-13.0.0.zip package or the migration will not work.\nMigrating to a New Instance\nMake a complete backup of your broken instance. This includes both the filesystem and database.\nExtract the contents of your downloaded Sugar package ( Sugar<Edition>-<Version>.zip ) to your web directory. This will be your clean Sugar directory that we will migrate your existing instance to.\nYou will then need to copy the following directories and files from your broken instance to the clean instance:\n./config.php\n./config_override.php (if it exists)\n./custom/\n./upload/\n./cache/images/ - This is optional and contains the embedded emails displayed in the UI.\nNote:\u00c2\u00a0If you are on a version prior to 6.4.0, you will also need to copy over the entire ./cache/ directory.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Migration/Migrating_From_a_Broken_Instance_to_a_clean_install/index.html"}
{"id": "3a7d66ccdcad-1", "text": "Next, you will need to identify if you have any custom modules. These folders will reside in your ./modules/ directory and have a naming format of <key>_<module name>. You will need to copy these files to their corresponding directory in the clean instance you extracted in step 2.\nOnce the files have been moved to the clean instance, you can remove your old instances files and move the clean instance in its place. If you choose to move the instance to a new location on the server, you will need to update the\u00c2\u00a0$sugar_config['site_url'] parameter in your ./config.php and/or ./config_override.php files.\nReset your filesystem permissions.\nLog into your instance as an administrator and navigate to Admin > Repair > Quick Repair and Rebuild.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Migration/Migrating_From_a_Broken_Instance_to_a_clean_install/index.html"}
{"id": "c7bb333ef2c9-0", "text": "Importing Records\n  Covers the Sugar structure when migrating data into the application.\nTopicsImporting Email AddressesRecommended approaches when Importing email addresses.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Migration/Importing_Records/index.html"}
{"id": "923a96ebd71a-0", "text": "Importing Email Addresses\nOverview\nRecommended approaches when Importing email addresses.\nImporting via API\nSugar comes out of the box with an API that can be called from custom applications utilizing the REST interface. The API can be used to mass create and update records in Sugar with external data. For more information on the REST API in Sugar, please refer to the Web Services documentation.\nImporting New Records\nWhen importing new records into Sugar through the API, modules with relationships to email addresses can utilize the email1 field or the email link field to specify email addresses for a record.\nEmail1 Field\nWhen using the email1 field, the default functionality is to import the email address specified as the primary address. Assuming the email address does not already exist in the database, the email address is then flagged as being valid and is not opted out. Using the /<module> POST endpoint, you can send the following JSON payload to create a contact record with a primary email address using the email1 field: POST URL: http://<site url>/rest/v10/Contacts\n{\n    \"first_name\":\"Rob\",\n    \"last_name\":\"Robertson\",\n    \"email1\":\"rob.robertson@sugar.crm\"\n}\nNote: For importing multiple email addresses, you will need to use the email link field described below.\nEmail Link Field\nWhen using the email link field, you can specify multiple email addresses to assign to the record. You may specify the following additional information regarding each email address being added:\ninvalid_email : Specify this email address as being invalid\nopt_out : Specify this email address as being opted out\nprimary_address : Specify this email address as the primary\nUsing the /<module>\u00c2\u00a0POST endpoint, you can send the following JSON payload to create a contact record with multiple email addresses using the email link field: POST URL: http://<site url>/rest/v10/Contacts\n{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Migration/Importing_Records/Importing_Email_Addresses/index.html"}
{"id": "923a96ebd71a-1", "text": "{\n   \"first_name\":\"Rob\",\n   \"last_name\":\"Robertson\",\n   \"email\":[\n      {\n         \"email_address\":\"rob.robertson@sugar.crm\",\n         \"primary_address\":\"1\",\n         \"invalid_email\":\"0\",\n         \"opt_out\":\"0\"\n      },\n      {\n         \"email_address\":\"rob@sugar.crm\",\n         \"primary_address\":\"0\",\n         \"invalid_email\":\"0\",\n         \"opt_out\":\"1\"\n      }\n   ]\n}\nFor more information on the /<module>/:record POST endpoint, you can refer to your instance's help documentation found at:\nhttp://<site url>/rest/v10/help\nOr you can reference the <module> POST PHP example.\nUpdating Existing Records\nWhen updating existing records in Sugar through the API, modules with relationships to email addresses can also utilize the email1 field or the email link field to specify email addresses for a record.\nEmail1 Field\nWhen using the email1 field, the default functionality is to replace the existing email primary address. Assuming the email does not already exist in the database, the new email address is flagged as being valid and is not opted out. Using the /<module>/:record PUT endpoint, you can send the following JSON payload to update a contact records primary email address:\nPUT URL: http://<site url>/rest/v10/Contacts/<record id>\n{\n    \"email1\":\"rob.robertson@sugar.crm\"\n}\nNote: This will replace the current email address on the record with the new data. The old email address will no longer be associated with the record.\nEmail Link Field\nWhen using the email link field, you can specify multiple email addresses to update the record with. You may specify the following additional information regarding each email address being added:\ninvalid_email : Specify this email address as being invalid", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Migration/Importing_Records/Importing_Email_Addresses/index.html"}
{"id": "923a96ebd71a-2", "text": "invalid_email : Specify this email address as being invalid\nopt_out : Specify this email address as being opted out\nprimary_address : Specify this email address as the primary\nUsing the /<module>/:record PUT endpoint, you can send the following JSON payload to update a contact record with multiple email addresses: PUT URL: http://<site url>/rest/v10/Contacts/<record id>\n{\n   \"email\":[\n      {\n         \"email_address\":\"rob.robertson@sugar.crm\",\n         \"primary_address\":\"1\",\n         \"invalid_email\":\"0\",\n         \"opt_out\":\"0\"\n      },\n      {\n         \"email_address\":\"rob@sugar.crm\",\n         \"primary_address\":\"0\",\n         \"invalid_email\":\"0\",\n         \"opt_out\":\"1\"\n      }\n   ]\n}\nFor more information on the /<module>/:record PUT endpoint, you can refer to your instance's help documentation found at:\nhttp://<site url>/rest/v10/help\nOr you can reference the <module>/:record PUT PHP example.\nImporting via Database\nWhen importing records into Sugar directly via the database, it is important that you understand the data structure involved before loading data. Email addresses are not stored directly on the table for the module being imported in, but are related via the email_addr_bean_rel table.\nThe table structure for email addresses can be seen from the database via the following SQL statement:\nSELECT\n email_addr_bean_rel.bean_id,\n email_addr_bean_rel.bean_module,\n email_addresses.email_address\nFROM email_addr_bean_rel\nINNER JOIN email_addresses\n ON email_addresses.id = email_addr_bean_rel.email_address_id\n AND email_addr_bean_rel.deleted = 0\nWHERE email_addresses.deleted = 0;\nChecking for Duplicates", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Migration/Importing_Records/Importing_Email_Addresses/index.html"}
{"id": "923a96ebd71a-3", "text": "WHERE email_addresses.deleted = 0;\nChecking for Duplicates\nEmail addresses can become duplicated in Sugar from a variety of sources including API calls, imports, and from data entry. There are a few ways to have the system check for duplicate contact records, but not many of those methods work for checking email addresses for duplicates. The following section will demonstrate how to find and clean up duplicate email addresses using SQL.\nThe following SQL query can be used to locate if any email addresses are being used against more than one bean record within Sugar:\nSELECT\n email_addresses.email_address,\n COUNT(*) AS email_address_count\nFROM email_addr_bean_rel\nINNER JOIN email_addresses\n ON email_addresses.id = email_addr_bean_rel.email_address_id\n AND email_addr_bean_rel.deleted = 0\nWHERE email_addresses.deleted = 0\nGROUP BY email_addresses.email_address\nHAVING COUNT(*) > 1;\nNote: If you convert a Lead record to a Contact record, both the Lead and the Contact will be related to the same Email Address and will return as having duplicates in this query. You can add the following line to the WHERE clause to filter the duplicate check down to only one bean type:\nAND email_addr_bean_rel.bean_module = 'Contacts'\nEmail addresses can not only be\u00c2\u00a0duplicated in the system but can occasionally be missing critical data. Each bean record with an email address assigned to it\u00c2\u00a0should have an email address designated the primary. The following query will locate any bean records that have at least one email address, where there is not an email address designated as the primary:\nSELECT\n email_addr_bean_rel.bean_module,\n email_addr_bean_rel.bean_id,\n COUNT(*) AS email_count,\n COUNT(primary_email_addr_bean_rel.id) AS primary_email_count\nFROM email_addr_bean_rel\nLEFT JOIN email_addr_bean_rel primary_email_addr_bean_rel", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Migration/Importing_Records/Importing_Email_Addresses/index.html"}
{"id": "923a96ebd71a-4", "text": "LEFT JOIN email_addr_bean_rel primary_email_addr_bean_rel\n ON primary_email_addr_bean_rel.bean_module = email_addr_bean_rel.bean_module\n AND primary_email_addr_bean_rel.bean_id = email_addr_bean_rel.bean_id\n AND primary_email_addr_bean_rel.primary_address = '1'\n AND primary_email_addr_bean_rel.deleted = '0'\nWHERE email_addr_bean_rel.deleted = '0'\nGROUP BY email_addr_bean_rel.bean_module,\n email_addr_bean_rel.bean_id\nHAVING primary_email_count < 1;\nRemoving Duplicates\nIf it is determined you have duplicate email addresses being used in your system, you can use the following query to clean up the records:\nSTART TRANSACTION;\nCREATE \n TABLE email_addr_bean_rel_tmp\nSELECT\n *\nFROM email_addr_bean_rel\nWHERE deleted = '0'\nGROUP BY email_address_id,\n bean_module,\n bean_id\nORDER BY primary_address DESC;\nTRUNCATE TABLE email_addr_bean_rel;\nINSERT INTO email_addr_bean_rel\n SELECT\n *\n FROM email_addr_bean_rel_tmp;\nSELECT\n COUNT(*) AS repetitions,\n date_modified,\n bean_id,\n bean_module\nFROM email_addr_bean_rel\nWHERE deleted = '0'\nGROUP BY bean_id,\n bean_module,\n email_address_id\nHAVING repetitions > 1;\nCOMMIT;\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Migration/Importing_Records/Importing_Email_Addresses/index.html"}
{"id": "85627b082c76-0", "text": "Migrating From SugarCloud to On-Site\nOverview\nOccasionally, system administrators will have the need to deploy versions of their instance hosted on Sugar's cloud service to an on-site system. Reasons for this type of deployment are:\nTesting locally-developed modules\nMigrating from SugarCloud to on-site\nPrerequisites\nBefore migrating Sugar to an on-site environment, you will need to\u00c2\u00a0request a backup of your\u00c2\u00a0SugarCloud system by filing a case\u00c2\u00a0with the Sugar Support team. Once the backup request is received, SugarCRM will provide an FTP account where the following files can be downloaded:instance_name-YYYYMMDDHHmm.sql.gz (backup of database)\ninstance_name-YYYYMMDDHHmm-triggers.sql.gz (backup of database triggers)\ninstance_name-YYYYMMDDHHmm.files.tgz (backup of file system)\nThe local system must be running MySQL. Converting the database to another system, such as SQL Server or Oracle, requires special handling. For more information regarding this type of conversion, please contact your Account Manager.\nOn-site system administrators must be familiar with their stack and the tools (gunzip, tar, mysqladmin, mysql, etc.) referenced\u00c2\u00a0in this guide.\nNote: It is the system administrator's responsibility to diagnose and troubleshoot issues specific to the stack (permissions, environment variables, etc.).\nSteps to Complete\nDeploy the backup files to a local system using the following steps:\nExtract and import the SQL data as follows:\nExtract the SQL file via an archive utility (e.g. 7-Zip) or via command line such as: gunzip instance_name-YYYYMMDDHHmm.sql.gz\nCreate a database on your MySQL server via command line: mysqladmin -u mysql_username -p create instance_name\nOr, if already logged into MySQL, with a command such as: CREATE DATABASE instance_name;", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Migration/Migrating_From_Sugar_Cloud_to_On-Site/index.html"}
{"id": "85627b082c76-1", "text": "Or, if already logged into MySQL, with a command such as: CREATE DATABASE instance_name;\nImport the SQL data to your MySQL server via the command line: mysql -u mysql_username database_name -p < instance_name-YYYYMMDDHHmm.sql\nExtract the Triggers file via an archive utility (e.g. 7-Zip) or via command line such as: gunzip instance_name-YYYYMMDDHHmm.triggers.sql.gz\nImport the Triggers data to your MySQL server via the command line: mysql -u mysql_username database_name -p < instance_name-YYYYMMDDHHmm.triggers.sql\nExtract the tar file to your web server's web root directory (e.g. /var/www/html) with the following command: tar -C /var/www/html -xzf instance_name-YYYYMMDDHHmm.files.tgz\nThis will create a directory named \"instance_name-YYYYMMDDHHmm\" in your web root directory.\nRename the newly created directory: mv /var/www/html/instance_name-YYYYMMDDHHmm /var/www/html/instance_name\nFor Linux-based servers, perform the following actions:\nChange the ownership of the directory to be accessible by the Apache user and group. Please note that the user and group (e.g. apache, www-data, etc.) values can vary depending on your web server configuration. chown -R apache:apache /var/www/html/instance_name\nChange the permissions of the directory to ensure files can be accessed by the application. The actual permission values may differ depending on server security settings. chmod -R 770 /var/www/html/instance_name\nEdit the ./config.php file to point to your database.\nOpen the ./config.php file: vi /var/www/html/instance_name/config.php\nLocate and update the dbconfig\u00c2\u00a0array with the information appropriate for your MySQL server as follows:\n'dbconfig' => array (", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Migration/Migrating_From_Sugar_Cloud_to_On-Site/index.html"}
{"id": "85627b082c76-2", "text": "'dbconfig' => array (\n\t'db_host_name' => 'localhost',\n\t'db_host_instance' => 'SQLEXPRESS',\n\t'db_user_name' => 'mysql_username',\n\t'db_password' => 'mysql_password',\n\t'db_name' => 'instance_name',\n\t'db_type' => 'mysql',\n\t'db_port' => '',\n\t'db_manager' => 'MysqliManager',\n),\nEdit the config.php file and modify the following parameters:\nsite_url should be the URL of the instance on your server (e.g. https://www.mysugarinstance.com)\nhost_name should be the URL of the instance without the https protocol (e.g. www.mysugarinstance.com)\nModify the .htaccess file in the root directory of the instance.\nRemove the following lines if they exist in the file:\n#Added by operations to force SSL\nRewriteEngine On\nRewriteCond %{QUERY_STRING} !^entryPoint=WebToLeadCapture\nRewriteCond %{HTTP:X-SSL-CLUSTER} !^od2$\nRewriteRule ^(.*)$ https://%{HTTP_HOST}%{REQUEST_URI} [R=301,L]\nIf your on-site deployment does not reside in the root of your domain (e.g. https://www.example.com/mysugar/), change the following line from:\nRewriteBase /\nto:\nRewriteBase /mysugar/\nIf you are migrating permanently to an on-site deployment, there are additional modifications that should be made to ensure full functionality for your instance of Sugar.To restore the ability to perform upgrades, open the ./config.php file and remove the following line: 'disable_uw_upload' => true,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Migration/Migrating_From_Sugar_Cloud_to_On-Site/index.html"}
{"id": "85627b082c76-3", "text": "To display the full-text search configuration options under Admin > Search, open the ./config.php file and remove the following line: 'hide_full_text_engine_config' => true,\nTo display the Sugar log settings under Admin > System Settings, open the ./config.php file and remove the following line: 'logger_visible' => false,\nTo bypass security checks when installing packages via Admin > Module Loader, open the ./config.php file and change the following line from:'packageScan' => true,\nto: 'packageScan' => false,\nTo ensure full-text search functions properly, open the ./config.php file and modify the following lines to point to your ElasticSearch\u00c2\u00a0configuration:\n'full_text_engine' => array (\n\t 'Elastic' => array (\n\t\t 'host' => '<your_elastic_search_host>',\n\t\t 'port' => '<your_elastic_search_port>',\n\t ),\n ),\nDisable the SugarCloud Insights service as this is only available for SugarCloud instances. Open the ./config.php file and change\u00c2\u00a0'enabled' => true, to\u00c2\u00a0'enabled' => false, in the following array:'cloud_insight' => \n  array (\n    'enabled' => true,\n    'url' => 'https://sugarcloud-insights.service.sugarcrm.com',\n    'key' => '<insights key>',\n  ),\nFinally, please navigate to Admin > Repair and perform a \"Quick Repair and Rebuild\" to clear all cached elements from the SugarCloud instance.\nYou should now have a working version of your SugarCloud instance accessible from your local server.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Migration/Migrating_From_Sugar_Cloud_to_On-Site/index.html"}
{"id": "2f081e2510ca-0", "text": "Migrating From On-Site to SugarCloud\nOverview\nThe following article describes the process of migrating an on-site deployment to the SugarCloud environment.\nPrerequisites\nA few requirements must be met before an instance can be migrated to the SugarCloud environment:\nThe on-site deployment must be running MySQL. If you are using SQL Server or Oracle, you will need to speak with your Sugar Customer Advocate about data migration options.\nThe instance must be updated to a supported version of Sugar. Refer to the\u00c2\u00a0Managing Your Sugar Subscription\u00c2\u00a0article for information on determining your Sugar version. Once identified, you can check your version against our Supported Versions.\nMigration\nOnce the above requirements have been met you are ready to migrate.\nCase Portal\nInform Sugar Support of your intention to migrate by opening a support case. They will provide you with an FTP site and a set of credentials so you can transfer your instance. Sugar Support will expect you to provide two files. One file will be an archive (zip, tar, etc.) containing all the files and folders of your Sugar instance. The second file will be an export of your SQL database; it is a good idea to archive the resulting SQL export as well.\nFiles and Folders\nYou should be aware of the location of your Sugar instance on your on-site server. If you do not, you can locate the path to your instance by navigating to Admin > Schedulers.\nOnce there, you should see something similar to this:\nTo Set Up Crontab\nNote: In order to run Sugar Schedulers, add the following line to the crontab file: * * * * * cd <path to sugar instance>; php -f cron.php > /dev/null 2>&1", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Migration/Migrating_From_On-Site_to_On-Demand/index.html"}
{"id": "2f081e2510ca-1", "text": "Now that you have located the path to your Sugar instance, archive the entire contents of the Sugar root directory using the archive utility of your choice (zip, tar, WinZip, WinRar, 7zip, etc.). The Sugar root directory is the directory that contains the files config.php, cron.php, sugarcrm.log, and the folders custom, cache, and modules among others.\nDatabase\nThe following describes how to export a MySQL database using the command line utility \"mysqldump\". If you prefer, you may choose to use a tool such as phpMyAdmin to export your database. The command to export a MySQL database is:\nmysqldump -h localhost -u [MySQL user, e.g. root] -p[database password] [name of the database] > backup.sql\nIf you do not know the host, username, password, or database name you may refer to the \"config.php\" file of your Sugar instance. The \"dbconfig\" array in the \"config.php\" file contains all the required information. The example above showed the following \"dbconfig\" array:\n'dbconfig' =>  array (\n    'db_host_name' => 'localhost',\n    'db_host_instance' => 'SQLEXPRESS',\n    'db_user_name' => 'sugarcrm',\n    'db_password' => 'MyP@ssword',\n    'db_name' => 'sugarcrm',\n    'db_type' => 'mysql',\n),\nUsing this information we can rewrite the command:\nmysqldump -h localhost -u sugarcrm -pMyP@ssword sugarcrm > backup.sql\nUpload\nFinally, upload the two files to the FTP site provided by the Sugar Support team. The instance will be deployed to the SugarCloud environment and a URL to the instance will be provided to you.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Migration/Migrating_From_On-Site_to_On-Demand/index.html"}
{"id": "2f081e2510ca-2", "text": "Last modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Migration/Migrating_From_On-Site_to_On-Demand/index.html"}
{"id": "7f987902cd37-0", "text": "Web Services\nOverview\nWeb Services allow for communication between different applications and platforms. Sugar currently supports REST and SOAP APIs. The following sections will outline how to interact with the APIs and what versions of the API we recommend for use.\nVersioning\nAPI versioning is the process of creating a new set of API endpoints for new functionality while leaving pre-existing endpoints available for third-party applications and integrations to continue using. This helps to extend the application in an upgrade-safe manner.\nQuick Reference\nWhen working with the Web Service API, you should be using the latest REST API specific to your release. A quick reference of this can be found below:\nRelease1\nREST Version\nREST URL\nSOAP Version2\nSOAP URL\n13.0.x\nv11.20\n/rest/v11_20/\nv4.1\n/service/v4_1/soap.php\n12.3.x\nv11.19\n/rest/v11_19/\nv4.1\n/service/v4_1/soap.php\n12.2.x\nv11.18\n/rest/v11_18/\nv4.1\n/service/v4_1/soap.php\n12.1.x\nv11.17\n/rest/v11_17/\nv4.1\n/service/v4_1/soap.php\n12.0.x\nv11.16\n/rest/v11_16/\nv4.1\n/service/v4_1/soap.php\n11.3.x\nv11.15\n/rest/v11_15/\nv4.1\n/service/v4_1/soap.php\n11.2.x\nv11.14\n/rest/v11_14/\nv4.1\n/service/v4_1/soap.php\n11.1.x\nv11.13\n/rest/v11_13/\nv4.1\n/service/v4_1/soap.php\n11.0.x", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/index.html"}
{"id": "7f987902cd37-1", "text": "v4.1\n/service/v4_1/soap.php\n11.0.x\nv11.12\n/rest/v11_12/\nv4.1\n/service/v4_1/soap.php\n10.3.x\nv11.11\n/rest/v11_11/\nv4.1\n/service/v4_1/soap.php\n10.2.x\nv11.10\n/rest/v11_10/\nv4.1\n/service/v4_1/soap.php\n10.1.x\nv11.9\n/rest/v11_9/\nv4.1\n/service/v4_1/soap.php\n10.0.x\nv11.8\n/rest/v11_8/\nv4.1\n/service/v4_1/soap.php\n9.3.x\nv11.7\n/rest/v11_7/\nv4.1\n/service/v4_1/soap.php\n9.2.x\nv11.6\n/rest/v11_6/\nv4.1\n/service/v4_1/soap.php\n9.1.x\nv11.5\n/rest/v11_5/\nv4.1\n/service/v4_1/soap.php\n9.0.x\nv11.4\n/rest/v11_4/\nv4.1\n/service/v4_1/soap.php\n8.3.x\nv11.4\n/rest/v11_4/\nv4.1\n/service/v4_1/soap.php\n8.2.x\nv11.3\n/rest/v11_3/\nv4.1\n/service/v4_1/soap.php\n8.1.x\nv11.2\n/rest/v11_2/\nv4.1\n/service/v4_1/soap.php\n8.0.x\nv11.1", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/index.html"}
{"id": "7f987902cd37-2", "text": "/service/v4_1/soap.php\n8.0.x\nv11.1\n/rest/v11_1/\nv4.1\n/service/v4_1/soap.php\n7.11.x\nv11\n/rest/v11/\nv4.1\n/service/v4_1/soap.php\n7.10.x\nv11\n/rest/v11/\nv4.1\n/service/v4_1/soap.php\n7.9.x\nv10\n/rest/v10/\nv4.1\n/service/v4_1/soap.php\n7.8.x\nv10\n/rest/v10/\nv4.1\n/service/v4_1/soap.php\n7.7.x\nv10\n/rest/v10/\nv4.1\n/service/v4_1/soap.php\n6.5.x\nv4.1\n/service/v4_1/rest.php\nv4.1\n/service/v4_1/soap.php\n1 Some of the releases in this table may no longer be officially-supported Sugar versions, but we have included them for archival purposes. For more information, please refer to the Supported Versions resource page. 2 As of Sugar 7.0, SOAP support is no longer offered with the new APIs. The legacy APIs will remain accessible in the product, however, any existing integrations should be updated to use the latest REST endpoints.\nTopicsREST APIv10 - v11.20 API documentation.Legacy APIv1 - v4.1 API documentation.\n  \tLast modified: 2023-04-05 00:07:43", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/index.html"}
{"id": "3ec5f94059b9-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nLegacy API\nOverview\nv1 - v4.1 API\u00c2\u00a0documentation.\nSOAP VS REST\nThere are significant differences between how the legacy REST and SOAP protocols function on an implementation level (e.g. Performance, response size, etc). Deciding which protocol to use is up to the individual developer and is beyond the scope of this guide. Starting in SugarCRM version 6.2.0, there are some deviations between the protocols with the v4 API. There are additional core calls that are only made available through the REST protocol. They are listed below:\nget_module_layout\nget_module_layout_md5\nget_quotes_pdf method\nget_report_pdf method\nsnip_import_emails\nsnip_update_contacts\njob_queue_cycle\njob_queue_next\njob_queue_run\noauth_access method\noauth_access_token\noauth_request_token\nREST\nREST stands for 'Representational State Transfer'. This protocol is used by Sugar to exchange information both internally and externally.\nHow do I access the REST service?\nThe legacy REST services in SugarCRM and be found by navigating to:\nhttp://{site url)/service/{version}/rest.php\nWhere 'site url' is the URL of your Sugar instance and 'version' is the latest version of the API specific to your release of Sugar. You can find out more about versioning in the Web Services documentation.\nInput / Output Datatypes\nThe default input / output datatype for REST is JSON / PHP serialize.\nThese datatype files, SugarRestJSON.php and SugarRestSerialize.php, are in:\n./service/core/REST/\nDefining your own Datatypes\nYou can also define you own datatype. To do this, you need to create a new file such as:\n./service/core/REST/SugarRest<CustomDataType>.php", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/index.html"}
{"id": "3ec5f94059b9-1", "text": "./service/core/REST/SugarRest<CustomDataType>.php\nNext, you will need to override generateResponse() and serve() functions. The Serve function decodes or unserializes the appropriate datatype based on the input type; the generateResponse function encodes or serializes it based on the output type.\nSee service/test.html for more examples on usage. In this file, the getRequestData function, which generates URL with json, is both the input_type and the response_type. That is, the request data from the JavaScript to the server is JSON and response data from server is also JSON. You can mix and match any datatype as input and output. For example, you can have JSON as the input_type and serialize as the response_type based on your application's requirements.\nREST Failure Response\nIf a call failure should occur, the result will be as shown below:\nName\nType\nDescription\nname\nString\nError message.\nnumber\nInteger\nError number.\ndescription\nString\nDescription of error.\nSOAP\nSOAP stands for 'Simple Object Access Protocol'. SOAP is a simple XML-based protocol that is used to allow applications to exchange information.\nHow do I access the SOAP service?\nThe legacy SOAP service in SugarCRM and be found by navigating to:\nhttp://{sugar_url)/service/{version}/soap.php\nWhere 'sugar_url' is the url of your Sugar instance and 'version' is the latest version of the API specific to your release of Sugar. You can find out more about versioning in the section titled 'API: Versioning'. The default WSDL is formatted as rpc/encoded.\nWS-I 1.0 Compliancy\nSugar supports generating a URL that is WS-I compliant. When accessing the soap entry point, you can access the WSDL at:\nhttp://{sugar_url)/service/{version}/soap.php?wsdl", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/index.html"}
{"id": "3ec5f94059b9-2", "text": "http://{sugar_url)/service/{version}/soap.php?wsdl\nBy default, the WSDL is formatted as rpc/encoded, however, this can be changed by specifying a 'style' and 'use' url-paramater. An example of this is:\nhttp://{sugar_url)/service/{version}/soap.php?wsdl&style=rpc&use=literal\nURL Parameters\nstyle\nrpc\nuse\nencoded\nliteral\nValidation\nThis WSDL (rpc/literal) was successfully verified against Apache CXF 2.2.\nSOAP Failure Response\nIf a call failure should occur, the result will be as shown below:\nName\nType\nDescription\nfaultcode\nInteger\nFault ID.\nfaultactor\nString\nProvides information about what caused the fault to happen.\nfaultstring\nString\nFault Message.\ndetail\nString\nDescription of fault.\nTopicsWhat is NuSOAP?NuSOAP is a SOAP Toolkit for PHP that doesn't require PHP extensions.MethodsWeb Service Method Calls.REST Release NotesLists changes between the different versions of the REST API.SOAP Release NotesLists changes between the different versions of the SOAP API.SugarHttpClientThe SugarHttpClient class is used to make REST calls.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/index.html"}
{"id": "c7615e1b9eb4-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nWhat is NuSOAP?\nOverview\nNuSOAP is a SOAP Toolkit for PHP that doesn't require PHP extensions.\nWhere Can I Get It?\nNuSOAP can be downloaded from\u00c2\u00a0http://nusoap.sourceforge.net\nHow Do I Use It?\nAfter you have downloaded NuSOAP, you will need to extract the zip file contents to a storage directory. Once extracted, you will reference \"lib/nusoap.php\" in your PHP SOAP application.\nExample\n<?php\n//require NuSOAP\nrequire_once(\"./lib/nusoap.php\");\n//retrieve WSDL\n$client = new nusoap_client(\"http://{site_url}/service/v4/soap.php?wsdl\", 'wsdl');\n\u00c2\u00a0\n\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/What_is_NuSOAP/index.html"}
{"id": "0f06d7361192-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nSOAP Release Notes\nOverview\nLists changes between the different versions of the SOAP API.\nRelease Notes\nv4_1\nget_modified_relationships method was added.\nget_relationships had the parameter $limit added.\nget_relationships had the parameter $offset added.\nv4\nsearch_by_module had the parameter $favorites added.\nv3_1\nget_entries had the parameter $track_view added.\nget_entry had the parameter $track_view added.\nget_entry_list had the parameter $favorites added.\nsearch_by_module had the parameter $unified_search_only added.\nv3\nget_available_modules had the parameter $filter added.\nget_last_viewed method was added.\nget_module_fields_md5 method was added.\nget_relationships had the parameter $order_by added.\nget_upcoming_activities method was added.\nsearch_by_module had the parameter $assigned_user_id added.\nsearch_by_module had the parameter $select_fields added.\nv2_1\nget_entry_list method logic was modified.\nget_report_entries method logic was modified.\nv2\ncontact_by_email method was removed.\ncreate_account method was removed.\ncreate_case method was removed.\ncreate_contact method was removed.\ncreate_lead method was removed.\ncreate_opportunity method was removed.\ncreate_session method was removed.\nend_session method was removed.\nget_attendee_list method was removed.\nget_contact_relationships method was removed.\nget_disc_client_file_list method was removed.\nget_document_revision return type was changed from return_document_revision to new_return_document_revision.\nget_encoded_file method was removed.\nget_encoded_portal_zip_file method was removed.\nget_encoded_zip_file method was removed.\nget_entries had the parameter $link_name_to_fields_array added.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/SOAP_Release_Notes/index.html"}
{"id": "0f06d7361192-1", "text": "get_entries had the parameter $link_name_to_fields_array added.\nget_entries return type was changed from get_entry_result to get_entry_result_version2.\nget_entry had the parameter $link_name_to_fields_array added.\nget_entry return type was changed from get_entry_result to get_entry_result_version2.\nget_entry_list had the parameter $link_name_to_fields_array added.\nget_entry_list return type was changed from get_entry_list_result to get_entry_list_result_version2.\nget_gmt_time method was removed.\nget_mailmerge_document method was removed.\nget_mailmerge_document2 method was removed.\nget_modified_entries method was removed.\nget_module_fields had the parameter $fields added.\nget_module_fields return type was changed from module_fields to new_module_fields.\nget_note_attachment return type was changed from return_note_attachment to new_return_note_attachment.\nget_quick_sync_data method was removed.\nget_related_notes method was removed.\nget_relationships had the parameter $link_field_name added.\nget_relationships had the parameter $related_fields added.\nget_relationships had the parameter $related_module removed.\nget_relationships had the parameter $related_module_link_name_to_fields_array added.\nget_relationships return type was changed from get_relationships_result to get_entry_result_version2.\nget_report_entries method was added.\nget_required_upgrades method was removed.\nget_server_info method was added.\nget_server_time method was removed.\nget_server_version method was removed.\nget_sugar_flavor method was removed.\nget_system_status method was removed.\nget_unique_system_id method was removed.\nis_loopback method was removed.\nis_user_admin method was removed.\nlogin had the parameter $name_value_list added.\nlogin return type was changed from set_entry_result to entry_value.\nlogout return type was changed from error_value to void.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/SOAP_Release_Notes/index.html"}
{"id": "0f06d7361192-2", "text": "logout return type was changed from error_value to void.\noffline_client_available method was removed.\nrelate_note_to_module method was removed.\nsearch method was removed.\nsearch_by_module had the parameter $password removed.\nsearch_by_module had the parameter $session added.\nsearch_by_module had the parameter $user_name removed.\nsearch_by_module return type was changed from get_entry_list_result to return_search_result.\nset_campaign_merge return type was changed from error_value to void.\nset_document_revision return type was changed from set_entry_result to new_set_entry_result.\nset_entries return type was changed from set_entries_result to new_set_entries_result.\nset_entries_details method was removed.\nset_entry return type was changed from set_entry_result to new_set_entry_result.\nset_note_attachment had the parameter $note type change from note_attachment to new_note_attachment.\nset_note_attachment return type was changed from set_entry_result to new_set_entry_result.\nset_relationship had the parameter $delete added.\nset_relationship had the parameter $link_field_name added.\nset_relationship had the parameter $module_id added.\nset_relationship had the parameter $module_name added.\nset_relationship had the parameter $name_value_list added.\nset_relationship had the parameter $related_ids added.\nset_relationship had the parameter $set_relationship_value removed.\nset_relationship return type was changed from error_value to new_set_relationship_list_result.\nset_relationships had the parameter $delete_array added.\nset_relationships had the parameter $link_field_names added.\nset_relationships had the parameter $module_ids added.\nset_relationships had the parameter $module_names added.\nset_relationships had the parameter $name_value_lists added.\nset_relationships had the parameter $related_ids added.\nset_relationships had the parameter $set_relationship_list removed.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/SOAP_Release_Notes/index.html"}
{"id": "0f06d7361192-3", "text": "set_relationships had the parameter $set_relationship_list removed.\nset_relationships return type was changed from set_relationship_list_result to new_set_relationship_list_result.\nsudo_user method was removed.\nsync_get_entries method was removed.\nsync_get_modified_relationships method was removed.\nsync_get_relationships method was removed.\nsync_set_entries method was removed.\nsync_set_relationships method was removed.\ntrack_email method was removed.\nupdate_portal_user method was removed.\nuser_list method was removed.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/SOAP_Release_Notes/index.html"}
{"id": "9d821780b753-0", "text": "SugarHttpClient\nOverview\nThe SugarHttpClient class is used to make REST calls.\nThe SugarHttpClient Class\nThe SugarHttpClient class is located in 'include/SugarHttpClient.php'. It contains a callRest() method that will allow you to post a request to a REST service via cURL without having to worry about the overhead or the restrictions on the file_get_contents() method when doing outbound webservice calls.\nMaking a Request\n<?php\n    // specify the REST web service to interact with\n    $url = 'http://{sugar_url}/service/v4_1/rest.php';\n    // Open a SugarHttpClient session for making the call\n    require_once('include/SugarHttpClient.php');\n    $client = new SugarHttpClient;\n    // Set the POST arguments to pass to the Sugar server\n    $parameters = array(\n        'user_auth' => array(\n            'user_name' => 'username',\n            'password' => md5('password'),\n        ),\n    );\n    $json = json_encode($parameters);\n    $postArgs = array(\n        'method' => 'login',\n        'input_type' => 'JSON',\n        'response_type' => 'JSON',\n        'rest_data' => $json,\n    );\n    $postArgs = http_build_query($postArgs);\n    // Make the REST call, returning the result\n    $response = $client->callRest($url, $postArgs);\n    if ( $response === false )\n    {\n        die(\"Request failed.\\n\");\n    }\n    // Convert the result from JSON format to a PHP array\n    $result = json_decode($response);\n    if ( !is_object($result) )\n    {\n        die(\"Error handling result.\\n\");\n    }\n    if ( !isset($result->id) )\n    {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/SugarHttpClient/index.html"}
{"id": "9d821780b753-1", "text": "}\n    if ( !isset($result->id) )\n    {\n        die(\"Error: {$result->name} - {$result->description}\\n.\");\n    }\n    // Get the session id\n    $sessionId = $result->id;\n?>\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/SugarHttpClient/index.html"}
{"id": "3993405d48ef-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nREST Release Notes\nOverview\nLists changes between the different versions of the REST API.\nRelease Notes\nv4_1\nget_modified_relationships method was added.\nget_relationships had the parameter $limit added.\nget_relationships had the parameter $offset added.\nv4\nget_entries had the parameter $track_view removed.\njob_queue_cycle method was added.\njob_queue_next method was added.\njob_queue_run method was added.\noauth_access method was added.\noauth_access_token method was added.\noauth_request_token method was added.\nsearch_by_module had the parameter $favorites added.\nsnip_import_emails method was added.\nsnip_update_contacts method was added.\nv3_1\nget_entries had the parameter $track_view added.\nget_entry had the parameter $track_view added.\nget_entry_list had the parameter $favorites added.\nget_language_definition method was added.\nget_module_layout had the parameter $acl_check added.\nget_module_layout_md5 had the parameter $acl_check added.\nget_quotes_pdf method was added.\nget_report_pdf method was added.\nsearch_by_module had the parameter $unified_search_only added.\nset_entry had the parameter $track_view added.\nv3\nget_available_modules had the parameter $filter added.\nget_last_viewed method was added.\nget_module_fields_md5 method was added.\nget_module_layout method was added.\nget_module_layout_md5 method was added.\nget_relationships had the parameter $order_by added.\nget_upcoming_activities method was added.\nsearch_by_module had the parameter $assigned_user_id added.\nsearch_by_module had the parameter $select_fields added.\nv2_1\nget_entry_list method logic was modified.\nget_report_entries method logic was modified.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/REST_Release_Notes/index.html"}
{"id": "3993405d48ef-1", "text": "get_entry_list method logic was modified.\nget_report_entries method logic was modified.\nmd5 method was removed.\nv2 (REST API was introduced into SugarCRM)\nget_available_modules method was added.\nget_document_revision method was added.\nget_entries method was added.\nget_entries_count method was added.\nget_entry method was added.\nget_entry_list method was added.\nget_module_fields method was added.\nget_note_attachment method was added.\nget_relationships method was added.\nget_report_entries method was added.\nget_server_info method was added.\nget_user_id method was added.\nget_user_team_id method was added.\nlogin method was added.\nlogout method was added.\nmd5 method was added.\nseamless_login method was added.\nsearch_by_module method was added.\nset_campaign_merge method was added.\nset_document_revision method was added.\nset_entries method was added.\nset_entry method was added.\nset_note_attachment method was added.\nset_relationship method was added.\nset_relationships method was added.SOAP Release Notes\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/REST_Release_Notes/index.html"}
{"id": "8e06eb137692-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nMethods\nWeb Service Method Calls.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/index.html"}
{"id": "8e06eb137692-1", "text": "Topicsget_available_modulesRetrieves a list of available modules in the system.get_document_revisionRetrieves a specific document revision.get_entriesRetrieves a list of beans based on specified record IDs.get_entries_countRetrieves a list of beans based on query specifications.get_entryRetrieves a single bean based on record ID.get_entry_listRetrieves a list of beans based on query specifications.get_language_definitionRetrieves the language label strings for the specified modules.get_last_viewedRetrieves a list of recently viewed records by module for the current user.get_modified_relationshipsRetrieves a list of modified relationships between a specific date range. Helps facilitate sync operations for users.get_module_fieldsRetrieves the list of field vardefs for a specific module.get_module_fields_md5Retrieves the MD5 hash of the vardefs for the specified modules.get_module_layoutRetrieves the layout metadata for a given module given a specific type and view.get_module_layout_md5Retrieves the MD5 hash value for a layout given a specific module, type and view.get_note_attachmentRetrieves an attachment associated with a specific note record.get_quotes_pdfGenerates a quote PDF for a specific quote.get_relationshipsRetrieves a specific relationship link for a specified record.get_report_entriesRetrieves a list of report entries based on specified record IDs.get_report_pdfGenerates a PDF for a specific report.get_server_infoRetrieves info about the SugarCRM instance.get_upcoming_activitiesRetrieves a list of upcoming activities for the current user.get_user_idRetrieves the id of the user currently logged in.get_user_team_idRetrieves the ID of the default team of the user who is logged into the current session.job_queue_cycleRuns through the scheduler cleanup process and cycles the scheduler jobs.job_queue_nextRetrieves the next job from the job queue and marks it as 'In Progress'.job_queue_runRuns the specified job.loginLogs a user into the SugarCRM", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/index.html"}
{"id": "8e06eb137692-2", "text": "as 'In Progress'.job_queue_runRuns the specified job.loginLogs a user into the SugarCRM application.logoutLogs a user out of the SugarCRM application.oauth_accessRetrieves the OAuth access token.seamless_loginVerifies that a session is authenticated.search_by_moduleSearches modules for a string and returns matched records.set_campaign_mergeHandles campaign log entry creation for mail-merge activity given a specified campaign.set_document_revisionCreates a new document revision for a specific document record.set_entriesCreate or update a list of records.set_entryCreates or updates a specific record.set_note_attachmentCreates an attachment and associated it to a specific note record.set_relationshipSets relationships between two records. You can relate multiple records to a single record using this.set_relationshipsSets multiple relationships between mulitiple record sets.snip_import_emailsUsed to imports an email record from the SNIP archiving service.snip_update_contactsRetrieves new contact emails since a timestamp for the current user.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/index.html"}
{"id": "8e06eb137692-3", "text": "Last modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/index.html"}
{"id": "943e455b3a15-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_module_layout_md5\nOverview\nRetrieves the MD5 hash value for a layout given a specific module, type and view.\nAvailable APIs\nREST\nDefinition\nget_module_layout_md5(session, modules, types, views, acl_check)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nmodules\nArray\nThe list of modules to retrieve layouts for.\ntypes\nArray\nThe types of views requested. Current supported types are 'default' (for application) and 'wireless'.\nviews\nArray\nThe views requested. Current supported types are 'edit', 'detail', 'list', and 'subpanel'.\nacl_check\nBoolean\nWhether or not to check for ACL access.\nResult\nName\nType\nDescription\nresult\nArray\nThe call result. Contains a list of modules.\nresult[][$type]\nArray\nThe list of types requested.\nresult[][$view]\nString\nThe list of MD5 layout view hashes requested.\nChange Log\nVersion\nChange\nv3_1\nAdded acl_check parameter.\nv3\nAdded get_module_layout_md5 method.\nExamples\nPHP\n$get_module_layout_md5_parameters = array(\n    //Session id\n    'session' => $session_id,\n    //The list of modules\n    'modules' => array(\n        'Accounts'\n    ),\n    //The types of views requested\n    'types' => array(\n        'default',\n    ),\n    //The views requested\n    'views' => array(\n        'edit'\n    ),\n    //Whether or not to check for ACL access\n    'acl_check' => false,\n);", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_module_layout_md5/index.html"}
{"id": "943e455b3a15-1", "text": "'acl_check' => false,\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_module_layout_md5/index.html"}
{"id": "2aff22bc915c-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\njob_queue_run\nOverview\nRuns the specified job.\nAvailable APIs\nREST\nDefinition\njob_queue_run(session, jobid, clientid)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\njobid\nString\nThe ID of the job to run.\nclientid\nString\nThe client id calling the application. This parameter is of your choosing for the calling application.\nResult\nName\nType\nDescription\nresult\nArray\nThe call result.\nresult.results\nBoolean\nThe result of the job run.\nresult.message\nString\nThis is only returned if a failure occurs.\nChange Log\nVersion\nChange\nv4\nAdded job_queue_run method.\nExamples\nPHP\n$job_queue_run_parameters = array(\n    //Session id\n    'session' => $session_id,\n    //The ID of the job to run.\n    'jobid' => 'd141efd3-d2c7-8a9c-9c02-50c11b491f16',\n    //The ID of the calling application.\n    'clientid' => 'MyAppID',\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/job_queue_run/index.html"}
{"id": "f65766cf8bb3-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_module_fields_md5\nOverview\nRetrieves the MD5 hash of the vardefs for the specified modules.\nAvailable APIs\nSOAP\nREST\nDefinition\nget_module_fields_md5(session, module_names)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nmodule_names\nselect_fields | Array\nThe list of modules to retrieve MD5 hashes for.\nResult\nName\nType\nDescription\nresult\nmd5_results | Array\nThe call result. Contains a list of module field hashes. Order is based on the module_names parameter.\nChange Log\nVersion\nChange\nExamples\nPHP\n$get_module_fields_md5_parameters = array(\n    //Session id\n    \"session\" => $session_id,\n    //The name of the modules to retrieve field hashes for\n    'module_names' => array(\n        'Contacts',\n        'Accounts'\n    ),\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_module_fields_md5/index.html"}
{"id": "d146ac1f1abb-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_user_team_id\nOverview\nRetrieves the ID of the default team of the user who is logged into the current session.\nAvailable APIs\nSOAP\nREST\nDefinition\nget_user_team_id(session)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nResult\nName\nType\nDescription\ndefault_team_id\nInteger\nThe ID of the current users default ream\nChange Log\nVersion\nChange\nv2\nAdded get_user_team_id method.\nExamples\nPHP\n$get_user_team_id_parameters = array(\n    //Session id\n    \"session\" => $session_id,\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_user_team_id/index.html"}
{"id": "0c9c1270bb2b-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_user_id\nOverview\nRetrieves the id of the user currently logged in.\nAvailable APIs\nSOAP\nREST\nDefinition\nget_user_id(session)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nResult\nName\nType\nDescription\nid\nString\nThe users ID.\nChange Log\nVersion\nChange\nExamples\nPHP\n$get_user_id_parameters = array(\n    //Session id\n    \"session\" => $session_id,\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_user_id/index.html"}
{"id": "27a8c110e12f-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nsearch_by_module\nOverview\nSearches modules for a string and returns matched records.\nAvailable APIs\nSOAP\nREST\nDefinition\nsearch_by_module(session, search_string, modules, offset, max_results, assigned_user_id, select_fields, unified_search_only, favorites)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nsearch_string\nString\nThe string to search for.\nmodules\nInteger\nThe list of modules to query.\noffset\nInteger\nThe record offset from which to start.\nmax_results\nInteger\nThe maximum number of records to return.\nassigned_user_id\nString\nFilters records by the assigned user ID. Leave this empty if no filter should be applied.\nselect_fields\nselect_fields | Array\nAn array of fields to return. If empty the default return fields will be from the active listviewdefs.\nunified_search_only\nBoolean\nIf the search is only against modules participating in the unified search.\nfavorites\nBoolean\nIf only records marked as favorites should be returned.\nResult\nName\nType\nDescription\nresult\nreturn_search_result | Array\nCall result.\nresult.entry_list\nArray\nThe count of records in paged result.\nresult.entry_list[].name\nString\nThe .name of the module\nresult.entry_list[].records\nArray\nA list of name_value lists for each record matched.\nChange Log\nVersion\nChange\nv3_1\nAdded unified_search_only parameter.\nExamples\nPHP\n$search_by_module_parameters = array(\n    //Session id\n    \"session\" => $session_id,\n    //The string to search for.\n    'search_string' => 'example text',\n    //The list of modules to query.\n    'modules' => array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/search_by_module/index.html"}
{"id": "27a8c110e12f-1", "text": "//The list of modules to query.\n    'modules' => array(\n        'Accounts',\n    ),\n    //The record offset from which to start.\n    'offset' => 0,\n    //The maximum number of records to return.\n    'max_results' => 100,\n    //Filters records by the assigned user ID.\n    //Leave this empty if no filter should be applied.\n    'assigned_user_id' => '',\n    //An array of fields to return.\n    //If empty the default return fields will be from the active listviewdefs.\n    'select_fields' => array(\n        'id',\n        'name',\n    ),\n    //If the search is only search modules participating in the unified search.\n    'unified_search_only' => false,\n    //If only records marked as favorites should be returned.\n    'favorites' => false\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/search_by_module/index.html"}
{"id": "0831b9c4992e-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_available_modules\nOverview\nRetrieves a list of available modules in the system.\nAvailable APIs\nSOAP\nREST\nDefinition\nget_available_modules(session, filter)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nfilter\nString\nString to filter the modules with. Possible values are 'default', 'mobile', 'all'.\nResult\nName\nType\nDescription\nresult\nnew_module_fields | Array\nThe call result.\nresult.modules\nArray\nThe list of avaialble modules.\nresult.modules[].module_key\nString\nThe modules key.\nresult.modules[].module_label\nString\nThe display label for the module.\nresult.modules[].favorite_enabled\nString\nWhether favorites are enabled for the module.\nresult.modules[].acls\nArray\nThe ACL list for the module\nChange Log\nVersion\nChange\nv3\nAdded filter parameter. Accepts the values 'default', 'mobile', 'all'.\nExamples\nPHP\n$get_available_modules_parameters = array(\n    //Session id\n    \"session\" => $session_id,\n    //Module filter. Possible values are 'default', 'mobile', 'all'.\n    \"filter\" => 'all',\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_available_modules/index.html"}
{"id": "c3fee7b73ab3-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nset_relationships\nOverview\nSets multiple relationships between mulitiple record sets.\nAvailable APIs\nSOAP\nREST\nDefinition\nset_relationships(session, module_names, module_ids, link_field_names, related_ids, name_value_lists, delete_array)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nmodule_names\nselect_fields | Array\nThe list of modules from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.\nmodule_ids\nselect_fields | Array\nThe list of IDs for the specified module records.\nlink_field_names\nselect_fields | Array\nThe list of link names for the related modules.\nrelated_ids\nnew_set_relationhip_ids | Array\nThe list of related record IDs you are relating.\nname_value_lists\nname_value_lists | Array\nAn array of arrays specifying relationship fields to populate. An example of this is contact_role between Opportunities and Contacts.\ndelete_array\ndeleted_array | Array\nAn array determining whether the relationships are being created or deleted. 0:create, 1:delete\nResult\nName\nType\nDescription\nresult\nnew_set_relationship_list_result | Array\nThe call result.\nresult.created\nInteger\nThe number of relationships created.\nresult.failed\nInteger\nDetermines whether or not the relationship failed. This is normally thrown when the parameters module_name or link_field_name are incorrect.\nresult.deleted\nInteger\nThe number of relationships deleted.\nChange Log\nVersion\nChange\nv2\nRemoved set_relationship_value parameter.\nv2\nAdded module_names parameter.\nv2\nAdded module_ids parameter.\nv2\nAdded link_field_names parameter.\nv2\nAdded related_ids parameter.\nv2\nAdded name_value_lists parameter.\nv2", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_relationships/index.html"}
{"id": "c3fee7b73ab3-1", "text": "Added related_ids parameter.\nv2\nAdded name_value_lists parameter.\nv2\nAdded delete_array parameter.\nv2\nReturn type was changed from set_relationship_list_result to new_set_relationship_list_result.\nExamples\nPHP\n$set_relationships_parameters = array(\n    //session id\n    'session' => $session_id,\n    //The name of the modules from which to relate records.\n    'module_names' => array(\n        'Opportunities',\n        'Accounts',\n    ),\n    //The IDs of the specified module beans.\n    'module_ids' => array(\n        '15e79b92-5025-827f-0784-50aa578270d8', //Opportunity ID\n        '27035f04-f6ec-492d-b89e-50aa57f5247f'  //Account ID\n    ),\n    //The relationship names of the linked fields from which to relate records.\n    'link_field_names' => array(\n        'contacts', //Contacts link field to Opportunities\n        'leads' //Leads link field to Accounts\n    ),\n    //The lists of record ids to relate\n    'related_ids' => array(\n        //Contact IDs\n        array(\n            '19b8799e-64ae-9502-588c-50aa575454c9'\n        ),\n        //Lead IDs\n        array(\n            '16d8d519-5f56-0984-2092-50aa576a7333',\n            '15ae07eb-63f0-dbac-6e4c-50aa57c5a609'\n        ),\n    ),\n    //Sets the value for relationship based fields\n    'name_value_lists' => array(\n        //Opportunity-Contact relationship fields", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_relationships/index.html"}
{"id": "c3fee7b73ab3-2", "text": "'name_value_lists' => array(\n        //Opportunity-Contact relationship fields\n        array(\n            array(\n                'name' => 'contact_role',\n                'value' => 'Other'\n            ),\n        ),\n        //Account-Lead relationship fields\n        array(),\n    ),\n    //Whether or not to delete the relationships. 0:create, 1:delete\n    'delete_array'=> array(\n        0, //Opportunity-Contact\n        0 //Account-Lead\n    ),\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_relationships/index.html"}
{"id": "5ac5555701f8-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_server_info\nOverview\nRetrieves info about the SugarCRM instance.\nAvailable APIs\nSOAP\nREST\nDefinition\nget_server_info()\nParameters\nName\nType\nDescription\nnull\nnull\nNo parameters available.\nResult\nName\nType\nDescription\nresult\nget_server_info_result | Array\nThe call result.\nresult.flavor\nString\nThe flavor of the instance.\nresult.version\nString\nThe version of the instance.\nresult.gmt_time\nString\nThe GMT time of the server.\nChange Log\nVersion\nChange\nv2\nMethod get_server_info was added to replace get_server_time, get_server_version and get_sugar_flavor.\nv2\nMethod get_server_time was removed.\nv2\nMethod get_server_version was removed.\nv2\nMethod get_sugar_flavor was removed.\nExamples\nPHP\n    //this method does not have any parameters\n    $get_server_info_parameters = array();\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_server_info/index.html"}
{"id": "40b4182dd9d0-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nseamless_login\nOverview\nVerifies that a session is authenticated.\nAvailable APIs\nSOAP\nREST\nDefinition\nseamless_login(session)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nResult\nName\nType\nDescription\nresult\nInteger\nReturns 1 if the session is authenticated. Otherwise 0 will be returned.\nChange Log\nVersion\nChange\nConsiderations\nIf you are attempting to log a user into SugarCRM seamlessly, you can do this by passing the validated session_id in the url.\nAn example is shown below:\nhttp://{site_url}/index.php?module=Home&action=index&MSID={session_id}\nExamples\nPHP\n$seamless_login_parameters = array(\n    //Session id\n    \"session\" => $session_id,\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/seamless_login/index.html"}
{"id": "a1910e80fe92-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_report_pdf\nOverview\nGenerates a PDF for a specific report.\nAvailable APIs\nREST\nDefinition\nget_report_pdf(session, report_id)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nreport_id\nString\nThe ID of the report record to generate the PDF for.\nResult\nName\nType\nDescription\nresult\nArray\nThe call result.\nresult.file_contents\nString\nThe binary contents of the PDF file.\nChange Log\nVersion\nChange\nv3_1\nAdded get_report_pdf method.\nExamples\nPHP\n$get_report_pdf_parameters = array(\n    //Session id\n    'session' => $session_id,\n    //The report to generate the pdf for.\n    'report_id' => '68ca4de9-7486-72e1-1a56-50aa5757aaab',\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_report_pdf/index.html"}
{"id": "95b5c598661f-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_upcoming_activities\nOverview\nRetrieves a list of upcoming activities for the current user.\nAvailable APIs\nSOAP\nREST\nDefinition\nget_upcoming_activities(session)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nResult\nName\nType\nDescription\nresult\nupcoming_activities_list | Array\nThe call result. Contains a list of upcoming activity records.\nresult[].id\nInteger\nThe record ID.\nresult[].module\nString\nThe activity module.\nresult[].date_due\nString\nThe date the activity is due.\nresult[].summary\nString\nThe summary of the activity.\nChange Log\nVersion\nChange\nExamples\nPHP\n$get_upcoming_activities_parameters = array(\n    //Session id\n    \"session\" => $session_id,\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_upcoming_activities/index.html"}
{"id": "033d0bd70c7c-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nset_relationship\nOverview\nSets relationships between two records. You can relate multiple records to a single record using this.\nAvailable APIs\nSOAP\nREST\nDefinition\nset_relationship(session, module_name, module_id, link_field_name, related_ids, name_value_list, delete)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nmodule_name\nString\nThe name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.\nmodule_id\nString\nThe ID of the specified module record.\nlink_field_name\nString\nThe name of the link field for the related module.\nrelated_ids\nselect_fields | Array\nThe list of related record IDs you are relating\nname_value_list\nname_value_list | Array\nAn array specifying relationship fields to populate. An example of this is contact_role between Opportunities and Contacts.\ndelete\nInteger\nDetermines whether the relationship is being created or deleted. 0:create, 1:delete\nResult\nName\nType\nDescription\nresult\nnew_set_relationship_list_result | Array\nThe call result\nresult.created\nInteger\nThe number of relationships created.\nresult.failed\nInteger\nDetermines whether or not the relationship failed. This is normally thrown when the parameters module_name or link_field_name are incorrect.\nresult.deleted\nInteger\nThe number of relationships deleted.\nChange Log\nVersion\nChange\nv2\nRemoved set_relationship_value parameter.\nv2\nAdded module_name parameter.\nv2\nAdded module_id parameter.\nv2\nAdded link_field_name parameter.\nv2\nAdded related_ids parameter.\nv2\nAdded name_value_list parameter.\nv2\nAdded delete parameter.\nv2", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_relationship/index.html"}
{"id": "033d0bd70c7c-1", "text": "Added name_value_list parameter.\nv2\nAdded delete parameter.\nv2\nReturn type was changed from error_value to new_set_relationship_list_result.\nExamples\nPHP\n$set_relationship_parameters = array(\n    //session id\n    'session' => $session_id,\n    //The name of the module.\n    'module_name' => 'Opportunities',\n    //The ID of the specified module bean.\n    'module_id' => '15e79b92-5025-827f-0784-50aa578270d8',\n    //The relationship name of the linked field from which to relate records.\n    'link_field_name' => 'contacts',\n    //The list of record ids to relate\n    'related_ids' => array(\n        '19b8799e-64ae-9502-588c-50aa575454c9',\n    ),\n    //Sets the value for relationship based fields\n    'name_value_list' => array(\n        array(\n            'name' => 'contact_role',\n            'value' => 'Other'\n        )\n    ),\n    //Whether or not to delete the relationship. 0:create, 1:delete\n    'delete'=> 0,\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_relationship/index.html"}
{"id": "f5f9c35a82da-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nset_entries\nOverview\nCreate or update a list of records.\nAvailable APIs\nSOAP\nREST\nDefinition\nset_entries(session, module_name, name_value_lists)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nmodule_name\nString\nThe name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.\nname_value_lists\nname_value_lists | Array\nThe an array of name/value lists containing the record attributes.\nResult\nName\nType\nDescription\nresult\nnew_set_entries_result | Array\nThe call result.\nresult.ids\nArray\nThe list of record IDs that were created or updated\nChange Log\nVersion\nChange\nv2\nReturn type was changed from set_entry_result to new_set_entries_result.\nConsiderations\nTo update an existing record, you will need to specify 'id' for the name_value_list item in the name_value_lists parameter.\nTo create a new record with a specific ID, you will need to set 'new_with_id' in the name_value_list item in the name_value_lists parameter.\nExamples\nPHP\n$set_entries_parameters = array(\n    //Session id\n    \"session\" => $session_id,\n    //The name of the module from which to retrieve records.\n    \"module_name\" => \"Accounts\",\n    //Record attributes\n    \"name_value_lists\" => array(\n        array(\n            //to update a record\n            /*\n            array(\n                \"name\" => \"id\",\n                \"value\" => \"da0b107d-cfbc-cb08-4f90-50b7b9cb9ad7\"\n            ),\n            */", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_entries/index.html"}
{"id": "f5f9c35a82da-1", "text": "),\n            */\n            //to create a new record with a specific ID\n            /*\n            array(\n                \"name\" => \"new_with_id\",\n                \"value\" => 1\n            ),\n            */\n            array(\n                \"name\" => \"name\",\n                \"value\" => \"Example Account 1\"\n            ),\n        ),\n        array(\n            //to update a record\n            /*\n            array(\n                \"name\" => \"id\",\n                \"value\" => \"da0b107d-cfbc-cb08-4f90-50b7b9cb9ad7\"\n            ),\n            */\n            //to create a new record with a specific ID\n            /*\n            array(\n                \"name\" => \"new_with_id\",\n                \"value\" => 1\n            ),\n            */\n            array(\n                \"name\" => \"name\",\n                \"value\" => \"Example Account 2\"\n            ),\n        ),\n    )\n,);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_entries/index.html"}
{"id": "82d6b546b5ef-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\njob_queue_cycle\nOverview\nRuns through the scheduler cleanup process and cycles the scheduler jobs.\nAvailable APIs\nREST\nDefinition\njob_queue_cycle(session, clientid)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nclientid\nString\nThe client id calling the application. This parameter is of your choosing for the calling application.\nResult\nName\nType\nDescription\nresult\nArray\nThe call result.\nresult.results\nString\nThe cycle result. Returns 'ok' on success.\nChange Log\nVersion\nChange\nv4\nAdded job_queue_cycle method.\nExamples\nPHP\n$job_queue_cycle_parameters = array(\n    //Session id\n    'session' => $session_id,\n    //The ID of the calling application.\n    'clientid' => 'MyAppID',\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/job_queue_cycle/index.html"}
{"id": "fc8bc909653e-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nlogin\nOverview\nLogs a user into the SugarCRM application.\nAvailable APIs\nSOAP\nREST\nDefinition\nlogin(user_auth, application_name, name_value_list)\nParameters\nName\nType\nDescription\nuser_auth\nuser_auth | Array\nContains the parameters to authenticate a user.\nuser_auth.user_name\nString\nThe user name of your user\nuser_auth.password\nString\nThe MD5 hash of the users password.\napplication name\nString\nThe name of the application logging in.\nname_value_list\nname_value_list | Array\nSets the name_value pair. The parameter is used to set values for the 'language' and 'notifyonsave' user settings.\nname_value_list.language\nString\nThe language for the user.\nname_value_list.notifyonsave\nBoolean\nAlerts users on new record creations when set to true.\nResult\nName\nType\nDescription\nresult\nentry_value | Array\nThe call result\nresult.id\nString\nThis is the session id required to make other method calls.\nresult.module_name\nString\nReturns the 'Users' module.\nresult.name_value_list\nArray\nAuthenticated user properties.\nresult.name_value_list.user_id\nString\nID of the authenitcated user.\nresult.name_value_list.user_name\nString\nUsername of the authenticated user.\nresult.name_value_list.user_language\nString\nDefault language of the authenticated user.\nresult.name_value_list.user_currency_id\nString\nDefault currency ID of the authenticated user.\nresult.name_value_list.user_is_admin\nString\nAdmin status of the authenticated user.\nresult.name_value_list.user_default_team_id\nString\nDefault team of the authenticated user.\nresult.name_value_list.user_default_dateformat\nString\nDefault date format for the authenticated user.\nresult.name_value_list.user_default_timeformat", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/login/index.html"}
{"id": "fc8bc909653e-1", "text": "String\nDefault date format for the authenticated user.\nresult.name_value_list.user_default_timeformat\nString\nDefault time format for the authenticated user.\nresult.name_value_list.user_number_seperator\nString\nNumber seperator for the authenticated user.\nresult.name_value_list.user_decimal_seperator\nString\nDecimal sperator for the authenticated user.\nresult.name_value_list.mobile_max_list_entries\nString\nMax list entires for the authenticated user.\nresult.name_value_list.mobile_max_subpanel_entries\nString\nMax subpanel entries for the authenticated user.\nresult.name_value_list.user_currency_name\nString\nDefault currency name for the authenticated user.\nChange Log\nVersion\nChange\nv3_1\nAdded additional return values to name_value_list. The list now also includes user_number_seperator, user_decimal_seperator, mobile_max_list_entries, mobile_max_subpanel_entries.\nv3\nAdded additional return values to name_value_list. The list now also includes user_is_admin, user_default_team_id, user_default_dateformat, user_default_timeformat.\nv2\nAdded name_value_list to response. Returns user_id, user_name, user_language, user_currency_id, user_currency_name.\nv2\nAdded module_name to response.\nv2\nRemoved error from response.\nv2\nAdded name_value_list parameter\nv2\nReturn type was changed from set_entry_result to entry_value.\nExamples\nPHP\n$login_parameters = array(\n    //user authentication\n    \"user_auth\" => array(\n        \"user_name\" => $username,\n        \"password\" => md5($password),\n    ),\n    //application name\n    \"application_name\" => \"My Application\",\n    //name value list for 'language' and 'notifyonsave'\n    \"name_value_list\" => array(\n        array(\n            'name' => 'language',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/login/index.html"}
{"id": "fc8bc909653e-2", "text": "array(\n            'name' => 'language',\n            'value' => 'en_us',\n        ),\n        array(\n            'name' => 'notifyonsave',\n            'value' => true\n        ),\n    ),\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/login/index.html"}
{"id": "01a3155c5c24-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nset_document_revision\nOverview\nCreates a new document revision for a specific document record.\nAvailable APIs\nSOAP\nREST\nDefinition\nset_document_revision(session, note)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nnote\ndocument_revision | Array\nThe file attachment details\nnote.id\nString\nThe ID of the note record to associate the attachment to.\nnote.file\nString\nThe binary contents of the file.\nnote.filename\nString\nThe file name of the file attachment.\nnote.revision\nString\nThe revision number\nResult\nName\nType\nDescription\nresult\nnew_set_entry_result | array\nThe results from the call.\nresult.id\nString\nThe ID of the document revision.\nChange Log\nVersion\nChange\nv2\nReturn type was changed from set_entry_result to new_set_entry_result.\nExamples\nPHP\n$file_contents = file_get_contents(\"/path/to/example_document.txt\");\n$set_document_revision_parameters = array(\n    //Session id\n    \"session\" => $session_id,\n    //The attachment details\n    \"note\" => array(\n        //The ID of the parent document.\n        'id' => $document_id,\n        //The binary contents of the file.\n        'file' => base64_encode($file_contents),\n        //The name of the file\n        'filename' => 'example_document.txt',\n        //The revision number\n        'revision' => '1',\n    ),\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_document_revision/index.html"}
{"id": "65afaf653083-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nlogout\nOverview\nLogs a user out of the SugarCRM application.\nAvailable APIs\nSOAP\nREST\nDefinition\nlogout(session)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous call to login.\nResult\nName\nType\nDescription\nnull\nvoid\nNo return value.\nChange Log\nVersion\nChange\nv2\nReturn type was changed from error_value to void.\nExample\nPHP\n$logout_parameters = array(\n    //session id to expire\n    \"session\" => $session_id,\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/logout/index.html"}
{"id": "dc0ca8ceeeb2-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_entry_list\nOverview\nRetrieves a list of beans based on query specifications.\nAvailable APIs\nSOAP\nREST\nDefinition\nget_entry_list(session, module_name, query, order_by, offset, select_fields, link_name_to_fields_array, max_results, deleted, favorites)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nmodule_name\nString\nThe name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.\nquery\nString\nThe SQL WHERE clause without the word \"where\". You should remember to specify the table name for the fields to avoid any ambiguous column errors.\norder_by\nString\nThe SQL ORDER BY clause without the phrase \"order by\".\noffset\nInteger\nThe record offset from which to start.\nselect_fields\nselect_fields | Array\nThe list of fields to be returned in the results. Specifying an empty array will return all fields.\nlink_name_to_fields_array\nlink_names_to_fields_array | Array\nA list of link names and the fields to be returned for each link.\nmax_results\nInteger\nThe maximum number of results to return.\ndeleted\nInteger\nIf deleted records should be included in the results.\nfavorites\nBoolean\nIf only records marked as favorites should be returned.\nResult\nName\nType\nDescription\nresult\nget_entry_result_version2 | Array\nThe call result.\nresult.result_count\nInteger\nThe total number of records returned in the call.\nresult.total_count\nInteger\nThe total number of records.\nresultnext_offset\nInteger\nThe next offset to retrieve records.\nresult.entry_list\nArray", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entry_list/index.html"}
{"id": "dc0ca8ceeeb2-1", "text": "resultnext_offset\nInteger\nThe next offset to retrieve records.\nresult.entry_list\nArray\nThe record's name-value pair for the simple datatypes excluding the link field data. If you do not have access to the object, entry_list[].name_value_list will notify you.\nresult.relationship_list\nArray\nThe records link field data.\nChange Log\nVersion\nChange\nv3_1\nAdded favorites parameter.\nv2\nAdded link_name_to_fields_array parameter.\nv2\nReturn type was changed from get_entry_list_result to get_entry_list_result_version2.\nExamples\nPHP\n$get_entry_list_parameters = array(\n    //session id\n    'session' => $session_id,\n    //The name of the module from which to retrieve records\n    'module_name' => 'Leads',\n    //The SQL WHERE clause without the word \"where\".\n    'query' => \"\",\n    //The SQL ORDER BY clause without the phrase \"order by\".\n    'order_by' => \"\",\n    //The record offset from which to start.\n    'offset' => 0,\n    //A list of fields to include in the results.\n    'select_fields' => array(\n        'id',\n        'name',\n        'title',\n    ),\n    //A list of link names and the fields to be returned for each link name.\n    'link_name_to_fields_array' => array(\n        array(\n            'name' => 'email_addresses',\n            'value' => array(\n                'email_address',\n                'opt_out',\n                'primary_address'\n            ),\n        ),\n    ),\n    //The maximum number of results to return.\n    'max_results' => 2,\n    //If deleted records should be included in results.\n    'deleted' => 0,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entry_list/index.html"}
{"id": "dc0ca8ceeeb2-2", "text": "'deleted' => 0,\n    //If only records marked as favorites should be returned.\n    'favorites' => false,\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entry_list/index.html"}
{"id": "652250f7fa01-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nset_campaign_merge\nOverview\nHandles campaign log entry creation for mail-merge activity given a specified campaign.\nAvailable APIs\nSOAP\nREST\nDefinition\nset_campaign_merge(session, targets, campaign_id)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous call to login.\ntargets\nselect_fields | Array\nA string array of IDs identifying the targets used in the merge. The IDs used in this parameter come from the column 'prospect_lists_prospects.id'.\ncampaign_id\nString\nThe campaign ID used for the mail merge.\nResult\nName\nType\nDescription\nnull\nvoid\nNo return value.\nChange Log\nVersion\nChange\nv2\nReturn type was changed from error_value to void.\nExample\nPHP\n$set_campaign_merge_parameters = array(\n    //Session id\n    \"session\" => $session_id,\n    //A string array of IDs identifying the targets used in the merge.\n    //The IDs used in this parameter come from the column 'prospect_lists_prospects.id'.\n    \"targets\" => array(\n        '403787cc-ab19-bec8-3ef4-50bd4896c9b3',\n        'c5341c8d-4b0a-2b56-7108-50bd48b91213'\n    ),\n    //The campaign ID used for the mail merge.\n    \"campaign_id\" => '781d4471-fb48-8dd2-ae62-50bd475950b2'\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_campaign_merge/index.html"}
{"id": "8158334d247d-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\noauth_access\nOverview\nRetrieves the OAuth access token.\nAvailable APIs\nREST\nDefinition\noauth_access()\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nResult\nName\nType\nDescription\nresult\nArray\nThe call result.\nresult.id\nString\nThe OAuth access token.\nChange Log\nVersion\nChange\nv4\nAdded oauth_access method.\nExamples\nPHP\n$oauth_access_parameters = array(\n    //Session id\n    'session' => $session_id,\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/oauth_access/index.html"}
{"id": "5ce778aba4cd-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nsnip_update_contacts\nOverview\nRetrieves new contact emails since a timestamp for the current user.\nAvailable APIs\nREST\nDefinition\nsnip_update_contacts(session, report_id)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nreport_id\nString\nThe ID of the report record to generate the PDF for.\nResult\nName\nType\nDescription\nresult\nArray\nThe call result.\nresult.results\nBoolean\nThe new emails.\nresult.count\nInteger\nThe count of results.\nresult.message\nString\nThe return message.\nChange Log\nVersion\nChange\nv4\nAdded snip_update_contacts method.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/snip_update_contacts/index.html"}
{"id": "ed63c92bf06f-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nsnip_import_emails\nOverview\nUsed to imports an email record from the SNIP archiving service.\nAvailable APIs\nREST\nDefinition\nsnip_import_emails(session, email)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nemail\nArray\nThe contents of the email being imported.\nemail.message\nArray\nContains the email attributes.\nemail.message.message_id\nString\nThe ID of the email message.\nemail.message.subject\nString\nEmail subject.\nemail.message.attachments\nArray\nThe list of attachments to be imported\nemail.message.from_name\nString\nFrom sender name.\nemail.message.description\nString\nPlain text content body.\nemail.message.description_html\nString\nHTML email content body.\nemail.message.to_addrs\nString\nEmail addresses the email was sent to.\nemail.message.cc_addrs\nString\nEmail addresses the email was CCed to.\nemail.message.bcc_addrs\nString\nEmail addresses the email was BCCed to.\nemail.message.date_sent\nString\nDate the email was sent.\nResult\nName\nType\nDescription\nresult\nArray\nThe call result.\nresult.results\nBoolean\nThe success of the import.\nresult.count\nInteger\nThe count of records imported.\nresult.message\nString\nThe return message.\nChange Log\nVersion\nChange\nv4\nAdded snip_import_emails method.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/snip_import_emails/index.html"}
{"id": "42f404235a77-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_entries_count\nOverview\nRetrieves a list of beans based on query specifications.\nAvailable APIs\nSOAP\nREST\nDefinition\nget_entries_count(session, module_name, query, deleted)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nmodule_name\nString\nThe name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.\nquery\nString\nThe SQL WHERE clause without the word \"where\".\ndeleted\nInteger\nIf deleted records should be included in the results.\nResult\nName\nType\nDescription\nresult\nget_entries_count_result | Array\nThe call result.\nresult.result_count\nInteger\nThe count of total records.\nChange Log\nVersion\nChange\nExamples\nPHP\n$get_entries_count_parameters = array(\n    //Session id\n    'session' => $session_id,\n    //The name of the module from which to retrieve records\n    'module_name' => 'Accounts',\n    //The SQL WHERE clause without the word \"where\".\n    'query' => \" accounts.name like '%example text%' \",\n    //If deleted records should be included in results.\n    'deleted' => false\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entries_count/index.html"}
{"id": "31f3628676c6-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_last_viewed\nOverview\nRetrieves a list of recently viewed records by module for the current user.\nAvailable APIs\nSOAP\nREST\nDefinition\nget_last_viewed(session, module_names)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nmodule_names\nmodule_names | Array\nThe list of modules to retrieve last viewed records for.\nResult\nName\nType\nDescription\nresult\nlast_viewed_list | Array\nThe call result. Contains a list of reciently viewed records.\nresult[].id\nInteger\nThe result ID.\nresult[].item_id\nString\nThe reciently viewed record ID.\nresult[].item_summary\nString\nThe name of the reciently viewed record.\nresult[].module_name\nString\nThe name of the module.\nresult[].monitor_id\nString\nThe monitor ID from the tracker table.\nresult[].date_modified\nString\nThe date the record was viewed.\nChange Log\nVersion\nChange\nExamples\nPHP\n$get_last_viewed_parameters = array(\n    //Session id\n    \"session\" => $session_id,\n    //The name of the modules to retrieve last viewed for\n    'module_names' => array(\n        'Contacts',\n        'Accounts'\n    ),\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_last_viewed/index.html"}
{"id": "3c9657735cb3-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_note_attachment\nOverview\nRetrieves an attachment associated with a specific note record.\nAvailable APIs\nSOAP\nREST\nDefinition\nget_note_attachment(session, id)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nid\nString\nThe ID of the note record to associate the attachment to.\nResult\nName\nType\nDescription\nresult\nnew_return_note_attachment | Array\nThe call result.\nresult.note_attachment\nArray\nThe details of the file attachment.\nresult.note_attachment.id\nString\nThe ID of the note record / attachment.\nresult.note_attachment.filename\nString\nThe filename of the attachment.\nresult.note_attachment.file\nString\nThe binary contents of the file.\nresult.note_attachment.related_module_id\nString\nThe related parent ID.\nresult.note_attachment.related_module_name\nString\nThe related parent module.\nChange Log\nVersion\nChange\nv2\nReturn type was changed from return_note_attachment to new_return_note_attachment.\nExamples\nPHP\n$get_note_attachment_parameters = array(\n    //Session id\n    \"session\" => $session_id,\n    //The ID of the note containing the attachment.\n    'id' => \"9057784d-de17-4f28-c5f9-50bd0f260a43\",\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_note_attachment/index.html"}
{"id": "6161fd76f9fd-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_quotes_pdf\nOverview\nGenerates a quote PDF for a specific quote.\nAvailable APIs\nREST\nDefinition\nget_quotes_pdf(session, quote_id, pdf_format)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nquote_id\nString\nThe ID of the quote record to generate the PDF for.\npdf_format\nString\nThe pdf type requested. 'Standard' is an example.\nResult\nName\nType\nDescription\nresult\nArray\nThe call result.\nresult.file_contents\nString\nThe binary contents of the PDF file.\nChange Log\nVersion\nChange\nv3_1\nAdded get_quotes_pdf method.\nExamples\nPHP\n$get_quotes_pdf_parameters = array(\n    //Session id\n    'session' => $session_id,\n    //The quote to generate the pdf for\n    'quote_id' => '490cc844-f83a-9b74-9888-50aa575b517c',\n    //The pdf type\n    'pdf_format' => 'Standard',\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_quotes_pdf/index.html"}
{"id": "018d1800cd5d-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_language_definition\nOverview\nRetrieves the language label strings for the specified modules.\nAvailable APIs\nREST\nDefinition\nget_available_modules(session, modules, md5)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nmodules\nArray\nThe list of modules to retrieve language definitions for.\nmd5\nBoolean\nSetting this to true will return an MD5 hash of the modules labels strings instead of the label strings themselves.\nResult\nName\nType\nDescription\nresult\nArray\nThe call result. Contains a list of modules.\nresult[]\nArray or String\nThe list of language definitions or MD5 hashes. This is dependent on the 'md5' parameter.\nChange Log\nVersion\nChange\nv3_1\nAdded get_language_definition method.\nExamples\nPHP\n$get_language_definition_parameters = array(\n    //Session id\n    'session' => $session_id,\n    //The list of modules\n    'modules' => array(\n        'Accounts'\n    ),\n    //Whether to return the results as an MD5 hash\n    'md5' => false,\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_language_definition/index.html"}
{"id": "2e7e0c118e09-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_entry\nOverview\nRetrieves a single bean based on record ID.\nAvailable APIs\nSOAP\nREST\nDefinition\nget_entry(session, module_name, id, select_fields, link_name_to_fields_array, track_view)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nmodule_name\nString\nThe name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.\nid\nString\nThe ID of the record to retrieve.\nselect_fields\nselect_fields | Array\nThe list of fields to be returned in the results. Specifying an empty array will return all fields.\nlink_name_to_fields_array\nlink_names_to_fields_array | Array\nA list of link names and the fields to be returned for each link.\ntrack_view\nBoolean\nFlag the record as a recently viewed item.\nResult\nName\nType\nDescription\nresult\nget_entry_result_version2 | Array\nThe call result.\nresult.entry_list\nArray\nThe record's name-value pair for the simple datatypes excluding the link field data. If you do not have access to the object, entry_list[].name_value_list will notify you.\nresult.relationship_list\nArray\nThe records link field data.\nChange Log\nVersion\nChange\nv3_1\nAdded track_view parameter.\nv2\nAdded link_name_to_fields_array parameter.\nv2\nReturn type was changed from get_entry_result to get_entry_result_version2.\nExamples\nPHP\n$get_entry_parameters = array(\n    //session id\n    'session' => $session_id,\n    //The name of the module from which to retrieve records\n    'module_name' => \"Contacts\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entry/index.html"}
{"id": "2e7e0c118e09-1", "text": "'module_name' => \"Contacts\",\n    //The ID of the record to retrieve.\n    'id' => \"18df70e4-1422-8bff-6f5f-50aa571fe4e5\",\n    //The list of fields to be returned in the results\n    'select_fields' => array(\n        'id',\n        'first_name',\n        'last_name',\n    ),\n    //A list of link names and the fields to be returned for each link name\n    'link_name_to_fields_array' => array(\n        array(\n            'name' => 'email_addresses',\n            'value' => array(\n                'email_address',\n                'opt_out',\n                'primary_address'\n            ),\n        ),\n    ),\n    //Flag the record as a recently viewed item\n    'track_view' => true,\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entry/index.html"}
{"id": "a9fcd7ec2738-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_document_revision\nOverview\nRetrieves a specific document revision.\nAvailable APIs\nSOAP\nREST\nDefinition\nget_document_revision(session, i)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\ni\nString\nThe ID of the document revision.\nResult\nName\nType\nDescription\nresult\nnew_return_document_revision| Array\nThe call result.\nresult.document_revision\nArray\nThe details of the document revision.\nresult.document_revision.id\nString\nThe document ID.\nresult.document_revision.document_name\nString\nThe document name.\nresult.document_revision.revision\nString\nThe document revision number\nresult.document_revision.filename\nString\nThe filename of the file.\nresult.document_revision.file\nString\nThe binary contents of the file.\nChange Log\nVersion\nChange\nv2\nReturn type was changed from return_document_revision to new_return_document_revision.\nExamples\nPHP\n$get_document_revision_parameters = array(\n    //Session id\n    \"session\" => $session_id,\n    //The attachment details\n    \"i\" => '723b7dcb-27b3-e53d-b348-50bd283f8e48',\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_document_revision/index.html"}
{"id": "be6ed1322c87-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\njob_queue_next\nOverview\nRetrieves the next job from the job queue and marks it as 'In Progress'.\nAvailable APIs\nREST\nDefinition\njob_queue_next(session, clientid)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nclientid\nString\nThe client id calling the application. This parameter is of your choosing for the calling application.\nResult\nName\nType\nDescription\nresult\nArray\nThe call result.\nresult.results\nString\nThe next job ID.\nChange Log\nVersion\nChange\nv4\nAdded job_queue_next method.\nExamples\nPHP\n$job_queue_next_parameters = array(\n    //Session id\n    'session' => $session_id,\n    //The ID of the calling application.\n    'clientid' => 'MyAppID',\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/job_queue_next/index.html"}
{"id": "b8f8c368f1ad-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_entries\nOverview\nRetrieves a list of beans based on specified record IDs.\nAvailable APIs\nSOAP\nREST\nDefinition\nget_entries(session, module_name, ids, select_fields, link_name_to_fields_array, track_view)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nmodule_name\nString\nThe name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.\nids\nString\nThe list of record IDs to retrieve.\nselect_fields\nselect_fields | Array\nThe list of fields to be returned in the results. Specifying an empty array will return all fields.\nlink_name_to_fields_array\nlink_names_to_fields_array | Array\nA list of link names and the fields to be returned for each link.\ntrack_view\nBoolean\nFlag the record as a recently viewed item.\nResult\nName\nType\nDescription\nresult\nget_entry_result_version2 | Array\nThe call result.\nresult.entry_list\nArray\nThe record's name-value pair for the simple datatypes excluding the link field data. If you do not have access to the object, entry_list[].name_value_list will notify you.\nresult.relationship_list\nArray\nThe records link field data.\nChange Log\nVersion\nChange\nv3_1\nAdded track_view parameter.\nv2\nAdded link_name_to_fields_array parameter.\nv2\nReturn type was changed from get_entry_result to get_entry_result_version2.\nExamples\nPHP\n$get_entries_parameters = array(\n    //session id\n    'session' => $session_id,\n    //The name of the module from which to retrieve records\n    'module_name' => 'Accounts',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entries/index.html"}
{"id": "b8f8c368f1ad-1", "text": "'module_name' => 'Accounts',\n    //An array of record IDs\n    'ids' => array(\n        '14b0c0ca-3ea2-0ee8-f3be-50aa57c11ee7',\n    ),\n    //The list of fields to be returned in the results\n    'select_fields' => array(\n        'name',\n        'billing_address_state',\n        'billing_address_country'\n    ),\n    //A list of link names and the fields to be returned for each link name\n    'link_name_to_fields_array' => array(\n        array(\n            'name' => 'email_addresses',\n            'value' => array(\n                'email_address',\n                'opt_out',\n                'primary_address'\n            ),\n        ),\n    ),\n    //Flag the record as a recently viewed item\n    'track_view' => true,\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entries/index.html"}
{"id": "c09ee9f02e3b-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nset_note_attachment\nOverview\nCreates an attachment and associated it to a specific note record.\nAvailable APIs\nSOAP\nREST\nDefinition\nset_note_attachment(session, note)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nnote\nnew_note_attachment | Array\nThe file attachment details\nnote.id\nString\nThe ID of the note record to associate the attachment to.\nnote.filename\nString\nThe file name of the file attachment.\nnote.file\nString\nThe binary contents of the file.\nResult\nName\nType\nDescription\nresult\nnew_set_entry_result | Array\nThe call result.\nresult.id\nString\nThe ID of the note record / attachment\nChange Log\nVersion\nChange\nv2\nReturn type was changed from set_entry_result to new_set_entry_result.\nv2\nParameter note type change from note_attachment to new_note_attachment.\nExamples\nPHP\n$file_contents = file_get_contents(\"/path/to/example_file.php\");\n$set_note_attachment_parameters = array(\n    //Session id\n    \"session\" => $session_id,\n    //The attachment details\n    \"note\" => array(\n        //The ID of the note containing the attachment.\n        'id' => $note_id,\n        //The file name of the attachment.\n        'filename' => 'example_file.php',\n        //The binary contents of the file.\n        'file' => base64_encode($file_contents),\n    ),\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_note_attachment/index.html"}
{"id": "3090a5b950e0-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nset_entry\nOverview\nCreates or updates a specific record.\nAvailable APIs\nSOAP\nREST\nDefinition\nset_entry(session, module_name, name_value_list)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nmodule_name\nString\nThe name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.\nname_value_list\nname_value_list | Array\nThe name/value list of the record attributes.\nResult\nName\nType\nDescription\nresult\nnew_set_entry_result | Array\nThe call result.\nresult.id\nString\nThe ID of the record that was created/updated.\nChange Log\nVersion\nChange\nv2\nReturn type was changed from set_entry_result to new_set_entry_result.\nConsiderations\nTo update an existing record, you will need to specify 'id' in the name_value_list parameter.\nTo create a new record with a specific ID, you will need to set 'new_with_id' in the name_value_list parameter.\nExamples\nPHP\n$set_entry_parameters = array(\n    //session id\n    \"session\" => $session_id,\n    //The name of the module from which to retrieve records.\n    \"module_name\" => \"Accounts\",\n    //Record attributes\n    \"name_value_list\" => array(\n        //to update a record\n        /*\n        array(\n            \"name\" => \"id\",\n            \"value\" => \"da0b107d-cfbc-cb08-4f90-50b7b9cb9ad7\"\n        ),\n        */\n        //to create a new record with a specific ID\n        /*\n        array(", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_entry/index.html"}
{"id": "3090a5b950e0-1", "text": "//to create a new record with a specific ID\n        /*\n        array(\n            \"name\" => \"new_with_id\",\n            \"value\" => true\n        ),\n        */\n        array(\n            \"name\" => \"name\",\n            \"value\" => \"Example Account\"\n        ),\n    ),\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/set_entry/index.html"}
{"id": "758d006b1395-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_modified_relationships\nOverview\nRetrieves a list of modified relationships between a specific date range. Helps facilitate sync operations for users.\nAvailable APIs\nSOAP\nREST\nDefinition\nget_modified_relationships(session, module_name, related_module, from_date, to_date, offset, max_results, deleted, module_user_id, select_fields, relationship_name, deletion_date)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nmodule_name\nString\nThe module key to retrieve relationships against.\nrelated_module\nString\nThe related module key to retrieve records off of. This parameter should always be 'Users'.\nfrom_date\nString\nStart date in YYYY-MM-DD HH:MM:SS format for the date range.\nto_date\nString\nEnd date in YYYY-MM-DD HH:MM:SS format for the date range.\noffset\nInteger\nThe offset to begin returning records from.\nmax_results\nInteger\nThe max_results to return.\ndeleted\nInteger\nWhether or not to include deleted records. Set to 1 to find deleted records.\nmodule_user_id\nString\n*This parameter is no longer used and is only present for backward compatibility purposes.\nselect_fields\nselect_fields\nList of fields to select and return as name/value pairs.\nrelationship_name\nString\nThe name of the relationship name to search on.\ndeletion_date\nString\nDate value in YYYY-MM-DD HH:MM:SS format for filtering on deleted records whose date_modified falls within range.\nResult\nName\nType\nDescription\nresult\nmodified_relationship_result | Array\nThe call result.\nresult.result_count\nInteger\nThe result count.\nresult.next_offset\nInteger\nThe next offset to retrieve from.\nresult.entry_list\nArray\nList of found records.\nresult.error", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_modified_relationships/index.html"}
{"id": "758d006b1395-1", "text": "result.entry_list\nArray\nList of found records.\nresult.error\nArray\nError Message.\nresult.error.number\nInteger\nThe error number.\nresult.error.name\nString\nThe name of the error.\nresult.error.description\nString\nThe description of the error.\nChange Log\nVersion\nChange\nv4_1\nAdded get_modified_relationships method.\nConsiderations\nThe module_name parameter should always be 'Users'.\nExamples\nPHP\n$get_modified_relationships_parameters = array(\n    //Session id\n    'session' => $session_id,\n    //The module key to retrieve relationships against.\n    //This parameter should always be 'Users'.\n    'module_name' => 'Users',\n    //The related module key to retrieve records off of.\n    'related_module' => 'Meetings',\n    //Start date in YYYY-MM-DD HH:MM:SS format for the date range.\n    'from_date' => '2000-01-01 01:01:01',\n    //End date in YYYY-MM-DD HH:MM:SS format for the date range\n    'to_date' => '2013-01-01 01:01:01',\n    //The offset to begin returning records from.\n    'offset' => 0,\n    //The max_results to return.\n    'max_results' => 5,\n    //Whether or not to include deleted records. Set to 1 to find deleted records.\n    'deleted' => 0,\n    //This parameter is not used.\n    'module_user_id' => '',\n    //List of fields to select and return as name/value pairs.\n    'select_fields' => array(),\n    //The name of the relationship name to search on.\n    'relationhip_name' => 'meetings_users',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_modified_relationships/index.html"}
{"id": "758d006b1395-2", "text": "'relationhip_name' => 'meetings_users',\n    //Date value in YYYY-MM-DD HH:MM:SS format for filtering on deleted records.\n    'deletion_date' => '2012-01-01 01:01:01'\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_modified_relationships/index.html"}
{"id": "ddd3342a2bee-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_module_layout\nOverview\nRetrieves the layout metadata for a given module given a specific type and view.\nAvailable APIs\nREST\nDefinition\nget_module_layout(session, modules, types, views, acl_check, md5)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nmodules\nArray\nThe list of modules to retrieve layouts for.\ntypes\nArray\nThe types of views requested. Current supported types are 'default' (for application) and 'wireless'.\nviews\nArray\nThe views requested. Current supported types are 'edit', 'detail', 'list', and 'subpanel'.\nacl_check\nBoolean\nWhether or not to check for ACL access.\nmd5\nBoolean\nSetting this to true will return an MD5 hash of the modules layouts instead of the layouts themselves.\nResult\nName\nType\nDescription\nresult\nArray\nThe call result. Contains a list of modules.\nresult[][$type]\nArray\nThe list of types requested.\nresult[][$view]\nArray or String\nThe list of layout views requested or MD5 hashes. This is dependent on the 'md5' parameter.\nChange Log\nVersion\nChange\nv3_1\nAdded acl_check parameter.\nv3\nAdded get_module_layout method.\nExamples\nPHP\n$get_module_layout_parameters = array(\n    //Session id\n    'session' => $session_id,\n    //The list of modules\n    'modules' => array(\n        'Accounts'\n    ),\n    //The types of views requested\n    'types' => array(\n        'default',\n    ),\n    //The views requested\n    'views' => array(\n        'edit'\n    ),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_module_layout/index.html"}
{"id": "ddd3342a2bee-1", "text": "'views' => array(\n        'edit'\n    ),\n    //Whether or not to check for ACL access\n    'acl_check' => false,\n    //Whether to return the results as an MD5 hash\n    'md5' => true,\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_module_layout/index.html"}
{"id": "0a616c2d703d-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_relationships\nOverview\nRetrieves a specific relationship link for a specified record.\nAvailable APIs\nSOAP\nREST\nDefinition\nget_relationships(session, module_name, module_id, link_field_name, related_module_query, related_fields, related_module_link_name_to_fields_array, deleted, order_by, offset, limit)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nmodule_name\nString\nThe name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.\nmodule_id\nString\nThe ID of the specified module record.\nlink_field_name\nString\nThe name of the link field for the related module.\nrelated_module_query\nString\nThe list of related record IDs you are relating\nrelated_fields\nselect_fields | Array\nAn array specifying relationship fields to populate. An example of this is contact_role between Opportunities and Contacts.\nrelated_module_link_name_to_fields_array\nlink_names_to_fields_array | Array\nFor every related record returned, specify link field names to field information.\ndeleted\nInteger\norder_by\nString\nThe SQL ORDER BY clause without the phrase \"order by\".\noffset\nInteger\nThe record offset from which to start.\nlimit\nInteger\nThe maximum number of results to return.\nResult\nName\nType\nDescription\nresult\nget_entry_result_version2 | Array\nThe call result.\nresult.entry_list\nArray\nThe record's name-value pair for the simple datatypes excluding the link field data. If you do not have access to the object, entry_list[].name_value_list will notify you.\nresult.relationship_list\nArray\nThe records link field data.\nChange Log\nVersion\nChange\nv3\nAdded order_by parameter.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_relationships/index.html"}
{"id": "0a616c2d703d-1", "text": "Change Log\nVersion\nChange\nv3\nAdded order_by parameter.\nv2\nRemoved related_module parameter.\nv2\nAdded link_field_name parameter.\nv2\nAdded related_fields parameter.\nv2\nAdded related_module_link_name_to_fields_array parameter.\nv2\nReturn type was changed from get_relationships_result to get_entry_result_version2.\nExamples\nPHP\n$get_relationships_parameters = array(\n    //session id\n    'session' => $session_id,\n    //The name of the module from which to retrieve records.\n    'module_name' => 'Accounts',\n    //The ID of the specified module bean.\n    'module_id' => '9f0c0ceb-c512-7103-9456-50aa5787c3f6',\n    //The relationship name of the linked field from which to return records.\n    'link_field_name' => 'opportunities',\n    //The portion of the WHERE clause from the SQL statement used to find the related items.\n    'related_module_query' => \" opportunities.name IS NOT NULL \",\n    //The related fields to be returned.\n    'related_fields' => array(\n        'id',\n        'name'\n    ),\n    //For every related bean returned,\n    //specify link field names to field information.\n    'related_module_link_name_to_fields_array' => array(\n        array(\n            'name' => 'contacts',\n            'value' => array(\n                'id',\n                'first_name',\n                'last_name',\n            ),\n        ),\n    ),\n    //To exclude deleted records\n    'deleted'=> 0,\n    //order by\n    'order_by' => ' opportunities.name ',\n    //offset\n    'offset' => 0,\n    //limit", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_relationships/index.html"}
{"id": "0a616c2d703d-2", "text": "//offset\n    'offset' => 0,\n    //limit\n    'limit' => 200,\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_relationships/index.html"}
{"id": "06af186bca60-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_report_entries\nOverview\nRetrieves a list of report entries based on specified record IDs.\nAvailable APIs\nSOAP\nREST\nDefinition\nget_report_entries(session, ids, select_fields)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nids\nselect_fields | Array\nAn array of record IDs to retrieve.\nselect_fields\nselect_fields | Array\nThe list of fields to be included in the results.\nResult\nName\nType\nDescription\nresult\nget_entry_result_for_reports | Array\nThe call result.\nresult.field_list\nArray\nThe list of selected fields.\nresult.field_list[].name\nString\nThe name of the report.\nresult.field_list[].type\nString\nThe type of the report.\nresult.field_list[].label\nString\nThe label of the report.\nresult.field_list[].required\nBoolean\nresult.field_list[].options\nArray\nresult.entry_list\nArray\nThe list of report results\nresult.entry_list[].id\nString\nThe result ID. This is not the record ID.\nresult.entry_list[].module_name\nString\nThe name of the module. Normally contains the value 'Reports'.\nresult.entry_list[].name_value_list\nArray\nThe name value list of the report results.\nChange Log\nVersion\nChange\nv2\nMethod get_report_entries was added.\nConsiderations\nThis method is not available in CE.\nExamples\nPHP\n$get_report_entries_parameters = array(\n    //Session id\n    'session' => $session_id,\n    //An array of record IDs to retrieve.\n    'ids' => array(\n        '63f1b905-d206-14cb-cb95-50aa5734815f'\n    ),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_report_entries/index.html"}
{"id": "06af186bca60-1", "text": "),\n    //The list of fields to be included in the results.\n    'select_fields' => array()\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_report_entries/index.html"}
{"id": "3279c62f324a-0", "text": "This API has been succeeded by a new version. It is recommended to upgrade to the latest API.\nget_module_fields\nOverview\nRetrieves the list of field vardefs for a specific module.\nAvailable APIs\nSOAP\nREST\nDefinition\nget_module_fields(session, module_name, fields)\nParameters\nName\nType\nDescription\nsession\nString\nSession ID returned by a previous login call.\nmodule_name\nString\nThe name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.\nfields\nselect_fields | Array\nThe list of fields to retrieve. An empty parameter will return all.\nResult\nName\nType\nDescription\nresult\nnew_module_fields | Array\nThe call result.\nresult.module_name\nString\nThe name of the module.\nresult.table_name\nString\nThe name of the modules primary table.\nresult.module_fields\nArray\nThe vardefs for each individual field.\nChange Log\nVersion\nChange\nv2\nAdded fields parameter.\nv2\nReturn type was changed from module_fields to new_module_fields.\nExamples\nPHP\n$get_module_fields_parameters = array(\n    //Session id\n    \"session\" => $session_id,\n    //The name of the module from which to retrieve fields\n    'module_name' => \"Contacts\",\n    //List of specific fields\n    'fields' => array(),\n);\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_module_fields/index.html"}
{"id": "3fd6acf5f208-0", "text": "REST API\nOverview\nv10 - v11.20 API documentation.\nWhat Is REST?\nREST stands for 'Representational State Transfer'. As of 7.x, REST is a core component of Sugar that defines how all information is exchanged within the application. The v10+ API is separate from the v1 - v4_1 REST APIs in that it has been rebuilt with the latest REST standards. Most functionality in the system, whether fetching or posting data, is interacting with the API in some way.\nGetting Started\nHow to Access the REST Service\nThe base endpoint for the REST service can be found at\u00c2\u00a0https://<site_url>/rest/v{version}/.\nNote: version refers to the version of the API\u00c2\u00a0you are accessing.\nFor your reference, the help documentation for all versioned endpoints can be found by navigating to\u00c2\u00a0https://<site_url>/rest/v{version}/help. Once you have identified your instance's base endpoint, we can begin by authenticating.\nAuthentication\nSugar uses two-legged OAuth2 for authentication. You simply need to do a POST to\u00c2\u00a0/rest/<version>/oauth2/token\u00c2\u00a0with the following parameters:\ngrant_type\nString\nType of request. Available grant types are \"password\" and \"refresh_token\".\nclient_id\nString\nThe client_id of \"sugar\" will automatically create an OAuth Key in the system and can be used for \"password\" authentication. The client_id of \"support_portal\" will create an OAuth Key if the portal system is enabled and will allow for portal authentication. Other client_id's can be created by the administrator in the OAuthKeys section in the Administration section and can be used in the future for additional grant types, if the client secret is filled in, it will be checked to validate the use of the client id.\nclient_secret\nString\nThe client's secret key.\nusername\nString", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/index.html"}
{"id": "3fd6acf5f208-1", "text": "client_secret\nString\nThe client's secret key.\nusername\nString\nThe username of the user authenticating to the system.\npassword\nString\nThe plaintext password the user authenticating to the system.\nplatform\nString\nDefaults to \"base\" allows you to have custom meta-data per platform. If using a value other than \"base\", you should make sure it is registered using the Platform extension\u00c2\u00a0or configure an API platform\u00c2\u00a0in Administration panel.\nFirst, we are going to log in using a\u00c2\u00a0grant_type\u00c2\u00a0of \"password\" and a\u00c2\u00a0platform\u00c2\u00a0of \"custom\". Normally, when logging into Sugar, users log in with a\u00c2\u00a0platform\u00c2\u00a0type of \"base\". We are using \"custom\" to avoid any potential\u00c2\u00a0login conflicts.\ncurl -X POST -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{ \n    \"grant_type\":\"password\", \n    \"client_id\":\"sugar\", \n    \"client_secret\":\"\", \n    \"username\":\"<username>\", \n    \"password\":\"<password>\", \n    \"platform\":\"custom\" \n}' https:/<site_url>/rest/<version>/oauth2/token\nOnce you get the response you will need to hold onto the\u00c2\u00a0access_token\u00c2\u00a0and the\u00c2\u00a0refresh_token. Anytime the\u00c2\u00a0access_token\u00c2\u00a0is invalidated, you will want to make another request to the token endpoint with a\u00c2\u00a0grant_type\u00c2\u00a0of \"refresh_token\". Store just the\u00c2\u00a0refresh_token\u00c2\u00a0in long-term storage \u00e2\u0080\u0093 not the username and password. The response from the server will be as follows:\n{\n    \"access_token\": \"5ee48ec7-023e-ecff-5184-530bd0358868\",\n    \"expires_in\": 3600,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/index.html"}
{"id": "3fd6acf5f208-2", "text": "\"expires_in\": 3600,\n    \"token_type\": \"bearer\",\n    \"scope\": null,\n    \"refresh_token\": \"5f197357-0167-f7a6-7912-530bd03275b6\",\n    \"refresh_expires_in\": 1209600,\n    \"download_token\": \"5f531625-e301-e3ea-1b11-530bd098be41\"\n}\nAvoiding Login Conflicts\nLogin conflicts often occur when building integrations or running data migrations with the\u00c2\u00a0platform\u00c2\u00a0of \"base\" or any other client type that is in use. This is due to the fact that Sugar uses the same REST API to power all the various clients such as Sugar, Portal, Mobile, and even the Outlook Plugin. Due to this, you need to let the API know you aren't conflicting with another client that may be in use. The way to accomplish this is the\u00c2\u00a0/rest/<version>/oauth2/token\u00c2\u00a0call by changing the\u00c2\u00a0platform\u00c2\u00a0parameter to something other than \"base\", \"mobile\", or \"portal\". It is best to name it something that describes and identifies your current integration.\nInput / Output Data Types\nThe default input / output datatype for REST is JSON.\nDate Handling\nDate and date time inputs should be formatted following the ISO 8601 format. If the time zone is not included in a request, Sugar will assume the time zone of the user making the request.\nFilter on a specific date:\n{\n    \"date_start\": \"2015-08-12\"\n}\nFilter on a date keyword using $dateRange:\n{\n    \"date_start\": {\n        \"$dateRange\": \"today\"\n    }\n}\nFilter on date range using manual time zones:\n{\n    \"date_start\": {\n        \"$dateBetween\": [", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/index.html"}
{"id": "3fd6acf5f208-3", "text": "{\n    \"date_start\": {\n        \"$dateBetween\": [\n            \"2015-09-10T00:00:00+10:00\",\n            \"2015-09-10T23:59:59+10:00\"\n        ]\n    }\n}\nTopicsEndpointsThe following sections contain the in-app help documentation for the REST endpoints.Extending EndpointsHow to add your own custom endpoints to the REST API.API ExceptionsSugar comes with some predefined API Exceptions, located in ./include/api/, that can be called from API endpoints. These exceptions return a specific HTTP code and a message.\n  \tLast modified: 2023-04-05 00:08:11", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/index.html"}
{"id": "26cf9eac6623-0", "text": "API Exceptions\nOverview\nSugar comes with some predefined API Exceptions, located in ./include/api/, that can be called from API endpoints. These exceptions return a specific HTTP code and a message.\nStock Exceptions\nException Class\nHTTP Code\nError Label\nLanguage Label Key\nLanguage Label Value\nSugarApiExceptionError\n500\u00c2\u00a0\nfatal_error\u00c2\u00a0\nEXCEPTION_FATAL_ERROR\u00c2\u00a0\nYour request failed to complete. A fatal error occurred. Check logs for more details.\nSugarApiExceptionIncorrectVersion\n301\nincorrect_version\nEXCEPTION_INCORRECT_VERSION\u00c2\u00a0\nThe version of the API you are using is not correct for the current request.\nSugarApiExceptionNeedLogin\n401\nneed_login\nEXCEPTION_NEED_LOGIN\u00c2\u00a0\nYou need to be logged in to perform this action.\nSugarApiExceptionInvalidGrant\n401\ninvalid_grant\nEXCEPTION_INVALID_TOKEN\u00c2\u00a0\nYour authentication token is invalid.\nSugarApiExceptionNotAuthorized\n403\nnot_authorized\nEXCEPTION_NOT_AUTHORIZED\nYou are not authorized to perform this action. Contact your administrator if you need access.\nSugarApiExceptionPortalUserInactive\n403\ninactive_portal_user\nEXCEPTION_INACTIVE_PORTAL_USER\u00c2\u00a0\nYou cannot access Portal because your portal account is inactive. Please contact customer support if you need access.\nSugarApiExceptionPortalNotConfigured\n403\nportal_not_configured\nEXCEPTION_PORTAL_NOT_CONFIGURED\u00c2\u00a0\nPortal is not configured properly. Contact your Portal Administrator for assistance.\nSugarApiExceptionNoMethod\n404\nno_method\nEXCEPTION_NO_METHOD\u00c2\u00a0\nYour request was not supported. Could not find the HTTP method of your request for this path.\nSugarApiExceptionNotFound\n404\nnot_found\nEXCEPTION_NOT_FOUND\u00c2\u00a0\nYour requested resource was not found. Could not find a handler for the path specified in the request.\nSugarApiExceptionEditConflict\n409\nedit_conflict", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/API_Exceptions/index.html"}
{"id": "26cf9eac6623-1", "text": "SugarApiExceptionEditConflict\n409\nedit_conflict\nEXCEPTION_EDIT_CONFLICT\u00c2\u00a0\nEdit conflict, please reload the record data.\nSugarApiExceptionInvalidHash\n412\nmetadata_out_of_date\nEXCEPTION_METADATA_OUT_OF_DATE\nYour metadata or user hash did not match the server. Please resync your metadata.\nSugarApiExceptionRequestTooLarge\n413\nrequest_too_large\nEXCEPTION_REQUEST_TOO_LARGE\nYour request is too large to process.\nSugarApiExceptionMissingParameter\n422\nmissing_parameter\nEXCEPTION_MISSING_PARAMTER\nA required parameter in your request was missing.\nSugarApiExceptionInvalidParameter\n422\ninvalid_parameter\nEXCEPTION_INVALID_PARAMETER\nA parameter in your request was invalid.\nSugarApiExceptionRequestMethodFailure\n424\nrequest_failure\nEXCEPTION_REQUEST_FAILURE\nYour request failed to complete.\nSugarApiExceptionClientOutdated\n433\nclient_outdated\nEXCEPTION_CLIENT_OUTDATED\nYour software is out of date, please update your client before attempting to connect again.\nSugarApiExceptionConnectorResponse\n502\nbad_gateway\nEXCEPTION_CONNECTOR_RESPONSE\nA connector or an integration request resulted in a failed response.\nSugarApiExceptionMaintenance\n503\nmaintenance\nEXCEPTION_MAINTENANCE\nSugarCRM is in maintenance mode. Only admins can login. Please contact your administrator for details.\nSugarApiExceptionServiceUnavailable\n503\nservice_unavailable\nEXCEPTION_SERVICE_UNAVAILABLE\nThe server cannot process your request because it is busy or unavailable at this time.\nSugarApiExceptionSearchUnavailable\n400\nsearch_unavailable\nEXCEPTION_SEARCH_UNAVAILABLE\nSearch engine is temporarily unavailable.\nSugarApiExceptionSearchRuntime\n400\nsearch_runtime\nEXCEPTION_SEARCH_RUNTIME\u00c2\u00a0\nA search engine runtime error occurred. Please contact your System Administrator.\nUsing Exceptions", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/API_Exceptions/index.html"}
{"id": "26cf9eac6623-2", "text": "A search engine runtime error occurred. Please contact your System Administrator.\nUsing Exceptions\nWhen\u00c2\u00a0extending endpoints in Sugar,\u00c2\u00a0the\u00c2\u00a0stock API exceptions\u00c2\u00a0can be used to return errors and messages. The exception classes accept a single parameter on creation for the message value to return. This parameter can accept\u00c2\u00a0language label keys or plain text. If no parameter is passed exception, the error will default to the exception's default language label key. To call a stock API exception from custom code add the following snippet :\n//throwing an api exception using the stock message \nthrow new SugarApiExceptionError();\n//throwing an api exception using a custom language label key\nthrow new SugarApiExceptionError('EXCEPTION_CSTM_LABEL_KEY');\n//throwing an api exception with text\nthrow new SugarApiExceptionError('There has been an error.');\nThis will return an http response code of 500 with the following response data:\n{\n    \"error\": \"fatal_error\",\n    \"error_message\": \"There has been an error.\"\n}\nCustom Exceptions\nSugar gives you the ability to create custom API exceptions by creating a new class in ./custom/include/api/ that extends the stock\u00c2\u00a0SugarApiException class. When extending the class you can provide the following properties in your custom\u00c2\u00a0code:\n$httpCode\nThe http response code to send back in the header. Defaults to 400 if not specified.\n$errorLabel\nThe string value returned in the 'error' key response.\n$messageLabel\nThe label to return as a default\u00c2\u00a0response if a message is not provided.\nExample\nThe following example will demonstrate how to create a custom exception.\n./custom/include/api/<name>.php\n<?php\nrequire_once 'include/api/SugarApiException.php';\n/**\n * Custom error.\n */\nclass cstmSugarApiExceptionError extends SugarApiException\n{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/API_Exceptions/index.html"}
{"id": "26cf9eac6623-3", "text": "*/\nclass cstmSugarApiExceptionError extends SugarApiException\n{\n    public $httpCode = 404;\n    public $errorLabel = 'my_error';\n    public $messageLabel = 'EXCEPTION_CSTM_LABEL_KEY';\n}\nCreate a custom language label using the extension framework:\n./custom/Extension/application/Ext/Language/<name>.php\n<?php\n$app_strings['EXCEPTION_CSTM_LABEL_KEY'] = 'My Exception Message.';\nYou can call your new exception by using the following code :\u00c2\u00a0\nrequire_once 'custom/include/api/<name>.php';\n//throwing custom api exception using the default message \nthrow new cstmSugarApiExceptionError();\n//throwing custom api exception using a custom language label key\nthrow new cstmSugarApiExceptionError('EXCEPTION_CSTM_LABEL_KEY');\n//throwing custom api exception with text\nthrow new cstmSugarApiExceptionError('There has been an error.');\nYou will then need to navigate to Admin > Repair > Quick Repair and Rebuild before using your exception.\nThe exception error will return a response of:\u00c2\u00a0\n{\n    \"error\": \"my_error\",\n    \"error_message\": \"There has been an error.\"\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/API_Exceptions/index.html"}
{"id": "356359101acc-0", "text": "Extending Endpoints\nOverview\nHow to add your own custom endpoints to the REST API.\nCustom Endpoints\nWith the REST architecture, you can easily define your own endpoint. All custom global endpoints will be located in\u00c2\u00a0./custom/clients/<client>/api/. All custom endpoints specific to a module will be located in\u00c2\u00a0./custom/modules/<module>/clients/<client>/api/.\nNote: The Sugar application client type is \"base\". More information on the various client types can be found in the Clients section.\nDefining New Endpoints\nThe endpoint class will be created in ./custom/clients/<client>/api/ and will extend SugarApi. Within this class, you will need to implement a registerApiRest() function that will define your endpoint paths. When creating a new endpoint, please note that the file name must match the class name for the endpoint definitions. The example below demonstrates creating a GET endpoint.\n./custom/clients/base/api/MyEndpointsApi.php\n<?php\nif(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nclass MyEndpointsApi extends SugarApi\n{\n    public function registerApiRest()\n    {\n        return array(\n            //GET\n            'MyGetEndpoint' => array(\n                //request type\n                'reqType' => 'GET',\n                //set authentication\n                'noLoginRequired' => false,\n                //endpoint path\n                'path' => array('MyEndpoint', 'GetExample', '?'),\n                //endpoint variables\n                'pathVars' => array('', '', 'data'),\n                //method to call\n                'method' => 'MyGetMethod',\n                //short help string to be displayed in the help documentation\n                'shortHelp' => 'An example of a GET endpoint',\n                //long help to be displayed in the help documentation", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html"}
{"id": "356359101acc-1", "text": "//long help to be displayed in the help documentation\n                'longHelp' => 'custom/clients/base/api/help/MyEndPoint_MyGetEndPoint_help.html',\n            ),\n        );\n    }\n    /**\n     * Method to be used for my MyEndpoint/GetExample endpoint\n     */\n    public function MyGetMethod($api, $args)\n    {\n        //custom logic\n        return $args;\n    }\n}\n?>\nNote: The file name must match the class name for the endpoint definitions. Given\u00c2\u00a0the example above, a class name of MyEndpointsApi must be created as\u00c2\u00a0MyEndpointsApi.php.\nregisterApiRest() Method\nYour extended class will contain two methods. The first method is registerApiRest() which will return an array that defines your REST endpoints. Each endpoint will need the following properties:\nName\nType\nDescription\nreqType\nArray | String\nAn array of one or many request types of the endpoint. Possible values are: GET, PUT, POST and DELETE.\nnoLoginRequired\nBoolean\nDetermines whether the endpoint is authenticated. Setting this value to true will remove the authentication requirement.\npath\nArray\nThe endpoint path. An endpoint path of:\n'path' => array('MyEndpoint', 'GetExample'),\nWill equate to the URL path of http://{site url}/rest/{REST VERSION}/MyEndpoint/GetExample.\nTo pass in a variable string to your endpoint, you will add a path of '?'. This will allow you to pass URL data to your selected method given that it is specified in the pathVars.\npathVars\nArray\nThe path variables. For each path on your endpoint, you can opt to pass its value in as a parameter to your selected method. An empty path variable will ignore the path.\nExample:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html"}
{"id": "356359101acc-2", "text": "Example:\n'path' => array('MyEndpoint', 'GetExample', '?'),\n'pathVars' => array('', '', 'data'),\nThe above will pass information\u00c2\u00a0to your selected method as the $args parameter when calling http://{site url}/rest/{REST VERSION}/MyEndpoint/GetExample/MyData\nmethod\nString\nThe method to pass the pathVars to. This can be named anything you choose and will be located in your SugarApi extended class.\nshortHelp\nString\nA short help string for developers when looking at the help documentation.\nlongHelp\nString\nPath to a long help file. This file will be loaded when a user clicks an endpoint from the help documentation.\nminVersion\nInteger\nThe minimum API Version this endpoint can be used with.\u00c2\u00a0See\u00c2\u00a0Scoring Section below.\u00c2\u00a0\nmaxVersion\nInteger\u00c2\u00a0\nThe maximum API Version this endpoint can be used with. See\u00c2\u00a0Scoring Section below.\u00c2\u00a0\nextraScore\nInteger\u00c2\u00a0\nAdd an extra score value to the Scoring of this endpoint, to place priority on its usage. See Scoring Section below.\nEndpoint Method\nThe second method can be named anything you choose but it is important to note that it will need to match the name of the method you specified for your endpoint. This method will require the parameters $api and $args. The MyGetMethod() in the example above will be used when the endpoint MyEndpoint/GetExample is called. Any path variables, query string parameters or posted data will be available in the $args parameter for you to work with.\npublic function MyEndpointMethod($api, $args)\n{\n    //logic\n    return $returnData;\n}\nHelp Documentation", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html"}
{"id": "356359101acc-3", "text": "{\n    //logic\n    return $returnData;\n}\nHelp Documentation\nThe final step once you have your endpoint working is to document it. This file can reside anywhere in the system and will be referenced in your endpoints longHelp property. An example of the help documentation can be found below:\ncustom/clients/base/api/help/MyEndPoint_MyGetEndPoint_help.html\n<h2>Overview</h2>\n<span class=\"lead\">\n    A custom GET endpoint. Returns the $args parameter that is passed to the endpoint method.\n</span>\n<h2>Path Variables</h2>\n<table class=\"table table-hover\">\n    <thead>\n    <tr>\n        <th>Name</th>\n        <th>Description</th>\n    </tr>\n    </thead>\n    <tbody>\n    <tr>\n        <td>\n            :data\n        </td>\n        <td>\n            Data string to pass to the endpoint.\n        </td>\n    </tr>\n    </tbody>\n</table>\n<h2>Input Parameters</h2>\n<span class=\"lead\">\n    This endpoint does not accept any input parameters.\n</span>\n<h2>Result</h2>\n<table class=\"table table-hover\">\n    <thead>\n    <tr>\n        <th>Name</th>\n        <th>Type</th>\n        <th>Description</th>\n    </tr>\n    </thead>\n    <tbody>\n    <tr>\n        <td>\n            __sugar_url\n        </td>\n        <td>\n            String\n        </td>\n        <td>\n            The endpoint path.\n        </td>\n    </tr>\n    <tr>\n        <td>\n            data\n        </td>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html"}
{"id": "356359101acc-4", "text": "<tr>\n        <td>\n            data\n        </td>\n        <td>\n            String\n        </td>\n        <td>\n            The data from path variable.\n        </td>\n    </tr>\n    </tbody>\n</table>\n<h3>Output Example</h3>\n<pre class=\"pre-scrollable\">\n{\n    \"__sugar_url\":\"v10\\/MyEndpoint\\/GetExample\\/MyData\",\n    \"data\":\"MyData\"\n}\n</pre>\n<h2>Change Log</h2>\n<table class=\"table table-hover\">\n    <thead>\n    <tr>\n        <th>Version</th>\n        <th>Change</th>\n    </tr>\n    </thead>\n    <tbody>\n    <tr>\n        <td>\n            v10\n        </td>\n        <td>\n            Added <code>/MyEndpoint/GetExample/:data</code> GET endpoint.\n        </td>\n    </tr>\n    </tbody>\n</table>\nQuick Repair and Rebuild\nOnce all of the files are in place, you will need to navigate to Admin > Repair > Quick Repair and Rebuild. This will rebuild the ./cache/file_map.php and ./cache/include/api/ServiceDictionary.rest.php files to make your endpoint available.\nExample\n./custom/clients/base/api/MyEndpointsApi.php\n<?php\nif(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nclass MyEndpointsApi extends SugarApi\n{\n    public function registerApiRest()\n    {\n        return array(\n            //GET & POST\n            'MyGetEndpoint' => array(\n                //request type\n                'reqType' => array('GET','POST'),", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html"}
{"id": "356359101acc-5", "text": "//request type\n                'reqType' => array('GET','POST'),\n                //set authentication\n                'noLoginRequired' => false,\n                //endpoint path\n                'path' => array('MyEndpoint', 'GetExample', '?'),\n                //endpoint variables\n                'pathVars' => array('', '', 'data'),\n                //method to call\n                'method' => 'MyGetMethod',\n                //short help string to be displayed in the help documentation\n                'shortHelp' => 'An example of a GET endpoint',\n                //long help to be displayed in the help documentation\n                'longHelp' => 'custom/clients/base/api/help/MyEndPoint_MyGetEndPoint_help.html',\n            ),\n        );\n    }\n    /**\n     * Method to be used for my MyEndpoint/GetExample endpoint\n     */\n    public function MyGetMethod($api, $args)\n    {\n        //custom logic\n        return $args;\n    }\n}\n?>\nRedefining Existing Endpoints\nWith endpoints, you may have a need to extend an existing endpoint to meet your needs. When doing this it is important that you do not remove anything from the return array of the endpoint. Doing so could result in unexpected behavior due to other functionality using the same endpoint.\nFor this example, we will extend the ping endpoint to return \"Pong <timestamp>\". To do this, we will need to extend the existing PingApi class and define our method overrides. When creating a new endpoint, please note that the file name must match the class name for the endpoint definitions. For our example, we will prefix the original class name with \"custom\" to create our overriding endpoint.\n./custom/clients/base/api/CustomPingApi.php\n<?php\nif(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html"}
{"id": "356359101acc-6", "text": "require_once(\"clients/base/api/PingApi.php\");\nclass CustomPingApi extends PingApi\n{\n    public function registerApiRest()\n    {\n        //in case we want to add additional endpoints\n        return parent::registerApiRest();\n    }\n    //override to modify the ping function of the ping endpoint\n    public function ping($api, $args)\n    {\n        $result = parent::ping($api, $args);\n        //append the current timestamp\n        return $result . ' ' . time();\n    }\n}\nNote: The file name must match the class name for the endpoint definitions. Given\u00c2\u00a0the example above, a class name of CustomPingApi\u00c2\u00a0must be created as\u00c2\u00a0CustomPingApi.php.\nAs you can see, we extended registerApiRest to fetch existing endpoint definitions in case we want to add our own. We then added an override for the ping method to return our new value. Once the file is in place you will need to navigate to Admin > Repair > Quick Repair and Rebuild. Once completed, any call made to <url>/rest/{REST VERSION}/ping will result in a response of \"ping <timestamp>\".\nEndpoint Scoring\nWhen generating custom endpoints or overriding existing endpoints, the system can determine which endpoint to use based on the score placed on the registered endpoints. The scoring calculation works in the following manner for registered endpoints.\nRoute Path\nScore\n?\n0.75\n<module>\n1.0\nExact Match\n1.75\nCustom\n0.5\nEndpoint 'extraScore' property\nDefined Extra Score\n\u00c2", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html"}
{"id": "356359101acc-7", "text": "Custom\n0.5\nEndpoint 'extraScore' property\nDefined Extra Score\n\u00c2\u00a0\nThe defined Path and extraScore properties in the registerApiRest() method, help determine the score for any given\u00c2\u00a0Endpoint. The higher the score allows the API to determine which Endpoint is being used for a given request. For example, if you had extended the /Accounts/:record GET API Endpoint as\u00c2\u00a0follows:\u00c2\u00a0\n/custom/modules/Accounts/clients/base/api/CustomAccountsApi.php\n<?php\nif(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');\nrequire_once(\"clients/base/api/ModuleApi.php\");\nclass CustomAccountsApi extends ModuleApi\n{\n    public function registerApiRest()\n    {\n        return array(\n            //GET & POST\n            'getAccount' => array(\n                //request type\n                'reqType' => array('GET'),\n                //set authentication\n                'noLoginRequired' => false,\n                //endpoint path\n                'path' => array('Accounts', '?'),\n                //endpoint variables\n                'pathVars' => array('module', 'record'),\n                //method to call\n                'method' => 'retrieveRecord',\n                //short help string to be displayed in the help documentation\n                'shortHelp' => 'An example of a GET endpoint',\n                //long help to be displayed in the help documentation\n                'longHelp' => 'custom/clients/base/api/help/MyEndPoint_MyGetEndPoint_help.html',\n            ),\n        );\n    }\n    /**\n     * Method to be used for my Accounts/:record endpoint\n     */\n    public function retrieveRecord($api, $args)\n    {\n        //custom logic\n        return parent::retrieveRecord($api,$args);\n    }\n}\n?>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html"}
{"id": "356359101acc-8", "text": "return parent::retrieveRecord($api,$args);\n    }\n}\n?>\n\u00c2\u00a0This Endpoint will be used when accessing /Accounts/<record_id> since the Exact Match of Accounts in the path property gives a greater score than the <module> match that comes with the standard /<module>/:record Endpoint defined in ModuleApi.\nEndpoint Versioning\nPart of the scoring calculation allows for versioning of the API Endpoints\u00c2\u00a0to accommodate the same endpoint path in the Rest API, for other versions of the API. If you have a custom Endpoint at /rest/v10/CustomEndpoint, and would like to alter the logic slightly for another use without deprecating or removing the old Endpoint, you can use the versioning techniques to have the new logic reside at /rest/v11/CustomEndpoint. The following table describes how the Versioning properties on the Endpoint definition affect the score of the Endpoint to allow the API to determine which Endpoint should be used for a given request.\n\u00c2\u00a0Property\nScore\u00c2\u00a0\n\u00c2\u00a0minVersion\n0.02 + minVersion/1000\u00c2\u00a0\n\u00c2\u00a0maxVersion\n0.02\u00c2\u00a0\n\u00c2\u00a0minVersion === maxVersion (i.e. Both minVersion and maxVersion properties are defined on Endpoint to the same value)\n0.06 + minVersion/1000\n\u00c2\u00a0\nTo allow for additional Versions in the API, you will first need to customize the 'maxVersion' property in the $apiSettings array. To do this, create ./custom/include/api/metadata.php. Inside the file you can set the $apiSettings['maxVersion'] property as follows:\n<?php\n$apiSettings['maxVersion'] = 11;\n\u00c2", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html"}
{"id": "356359101acc-9", "text": "<?php\n$apiSettings['maxVersion'] = 11;\n\u00c2\u00a0\nOnce you have configured the Max Version property, you can then set the minVersion and maxVersion properties on the Endpoint definition in the custom registerApiRest() method. For example, the following Endpoint definitions:\u00c2\u00a0\n<?php \n...\n    return array(\n        'foo1' => array(\n            'reqType' => 'GET',\n            'path' => array('Accounts','config',\n            'pathVars' => array('module', 'record'),\n            'method' => 'foo1',\n        ),\n        'foo2' => array(\n            'reqType' => 'GET',\n            'minVersion' => 11,\n            'path' => array('Accounts','config',\n            'pathVars' => array('module', 'record'),\n            'method' => 'foo2',\n        ),\n        'foo3' => array(\n            'reqType' => 'GET',\n            'minVersion' => 11,\n            'maxVersion' => 11,\n            'path' => array('Accounts','config',\n            'pathVars' => array('module', 'record'),\n            'method' => 'foo3',\n        ),\n        'foo4' => array(\n            'reqType' => 'GET',\n            'minVersion' => 11,\n            'maxVersion' => 12,\n            'path' => array('Accounts','config',\n            'pathVars' => array('module', 'record'),\n            'method' => 'foo3',\n        ),\n        'foo5' => array(\n            'reqType' => 'GET',\n            'minVersion' => 14,\n            'path' => array('Accounts','config',", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html"}
{"id": "356359101acc-10", "text": "'path' => array('Accounts','config',\n            'pathVars' => array('module', 'record'),\n            'method' => 'foo5',\n        ),\n    );\n...\nWith the above definitions, the following table provides the Expected Request for each Endpoint.\n\u00c2\u00a0Request URI\nBest Route\u00c2\u00a0\n\u00c2\u00a0/rest/v10/Accounts/config\nfoo1\n\u00c2\u00a0/rest/v11/Accounts/config\nfoo3\n\u00c2\u00a0/rest/v12/Accounts/config\nfoo4\u00c2\u00a0\n\u00c2\u00a0/rest/v13/Accounts/config\nfoo2\u00c2\u00a0\n\u00c2\u00a0/rest/v14/Accounts/config\nfoo5\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html"}
{"id": "612910f18ca5-0", "text": "Endpoints\nThe following sections contain the in-app help documentation for the REST endpoints.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "612910f18ca5-1", "text": "Topics/Accounts/:record/link/:link_name/filter GETLists related filtered records./Activities GETActivities on the home page/Activities/filter GETActivities on the home page/Administration/aws GET[ADMIN] Gets Amazon Web Services configs from Sugar Serve./Administration/aws POST[ADMIN] Set Amazon Web Services configs in Sugar Serve./Administration/config/:category GET[ADMIN] Get Configuration Settings for a Category./Administration/config/:category POST[ADMIN] Set Configuration Settings for a Category./Administration/elasticsearch/indices GET[ADMIN] Elasticsearch index statistics/Administration/elasticsearch/mapping GET[ADMIN] Elasticsearch mapping/Administration/elasticsearch/queue GET[ADMIN] Elasticsearch queue statistics/Administration/elasticsearch/refresh/enable POST[ADMIN] Elasticsearch enable refresh_interval/Administration/elasticsearch/refresh/status GET[ADMIN] Elasticsearch index refresh interval status/Administration/elasticsearch/refresh/trigger POST[ADMIN] Elasticsearch trigger explicit index refresh on all indices/Administration/elasticsearch/replicas/enable POST[ADMIN] Elasticsearch enable replicas/Administration/elasticsearch/replicas/status GET[ADMIN] Elasticsearch index replica status/Administration/elasticsearch/routing GET[ADMIN] Elasticsearch index routing/Administration/idm/migration/disable POST[ADMIN] Disable Idm migrations/Administration/idm/migration/enable POST[ADMIN] Enable Idm migrations/Administration/idm/users GETLists filtered user records./Administration/license/limits GET[ADMIN] Get License Limits./Administration/packages GET[ADMIN] PackageManager list packages./Administration/packages POST[ADMIN] PackageManager upload package./Administration/packages/:file_install/install GET[ADMIN] PackageManager install a package./Administration/packages/:id/disable GET[ADMIN] PackageManager disable a package./Administration/packages/:id/enable GET[ADMIN] PackageManager enable a package./Administration/packages/:id/uninstall GET[ADMIN] PackageManager uninstall a package./Administration/packages/installed GET[ADMIN] PackageManager lists installed packages./Administration/packages/staged GET[ADMIN] PackageManager lists staged packages./Administration/packages/:unFile DELETE[ADMIN] PackageManager delete a", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "612910f18ca5-2", "text": "PackageManager lists staged packages./Administration/packages/:unFile DELETE[ADMIN] PackageManager delete a package./Administration/portalmodules GET[ADMIN] Gets an array of modules currently enabled for Sugar Portal./Administration/search/fields GET[ADMIN] Search field configuration/Administration/search/reindex POST[ADMIN] Search schedule reindex/Administration/search/status GET[ADMIN] Search status/Administration/settings/auth GET[ADMIN] Fetch auth settings./Administration/settings/idmMode DELETE[ADMIN] Turn IDM-mode off./Administration/settings/idmMode POST[ADMIN] Turn IDM-mode on./Calendar/invitee_search GETTemporary API - Do Not Use! This endpoint will be removed in an upcoming release. Use /search endpoint instead./Calls POSTCreate a single event or a series of event records./Calls/:record DELETEDeletes either a single event record or a series of event records/Calls/:record PUTUpdate a calendar event record of the specified type./Cases/clients/portal PUT[ADMIN] Set a case as 'Requested For Close'/CommentLog/:record GETRetrieves a record./ConsoleConfiguration/config POSTSaves configuration changes in the database./ConsoleConfiguration/default-metadata GETGets the request metadata in JSON format./Contact/:record/Cases GETGet a contact's related cases, filtered by an expression, which are accessible to a contact with portal visibility./Contacts/:record/freebusy GETGet a contact's FreeBusy schedule/Currencies GETReturns a collection of Currency models/Dashboards/Activities GETList current user's filtered Activity Stream dashboards./Dashboards GETList current user's filtered Home dashboards./Dashboards POSTCreate a new Home dashboard./Dashboards/:id/restore-metadata PUTRestores the metadata for a module's dashboard to the default metadata./Dashboards/<module> GETList current user's filtered dashboards./Dashboards/<module> POSTCreate a new dashboard./DataArchiver/:id/run POST[ADMIN] Performs the archiving process./Documents/:record/file/:field POSTAttaches", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "612910f18ca5-3", "text": "POST[ADMIN] Performs the archiving process./Documents/:record/file/:field POSTAttaches a file to a field on a record./Documents/:record/file/:field PUTThis endpoint takes a file or image and saves it to a record that already contains an attachment in the specified field. The PUT method is very similar to the POST method but differs slightly in how the request is constructed. PUT requests should send the file data as the body of the request. Optionally, a filename query parameter can be sent with the request to assign a name. Additionally, the PUT/EmailAddresses POSTCreate a new email address./EmailAddresses/:record PUTUpdate an existing email address./Emails GETLists filtered emails./Emails POSTCreate a new Emails record./Emails/count GETLists filtered emails./Emails/filter GETLists filtered emails./Emails/filter POSTLists filtered records./Emails/filter/count GETLists filtered records./Emails/filter/count POSTLists filtered records./Emails/:record GETRetrieves an Emails record./Emails/:record PUTUpdate an existing Emails record./Emails/:record/link POSTCreates a relationship to a pre-existing email./Emails/:record/link/:link_name/add_record_list/:remote_id POSTCreates relationships to a pre-existing email from a record list./Emails/:record/link/:link_name/:remote_id DELETEDeletes an existing relationship between an email and another record./Emails/:record/link/:link_name/:remote_id POSTCreates a relationship to a pre-existing email./EmbeddedFiles/:record/file/:field GETRetrieves an attached file for a specific field on a record./EmbeddedFiles/:record/file/:field POSTAttaches a file to a field on a record./EmbeddedFiles/:record/file/:field PUTThis endpoint takes a file or image and saves it to a record that already contains an attachment in the specified field. The PUT method is very similar to the POST method but differs slightly in how the request is constructed. PUT requests should send the", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "612910f18ca5-4", "text": "similar to the POST method but differs slightly in how the request is constructed. PUT requests should send the file data as the body of the request. Optionally, a filename query parameter can be sent with the request to assign a name. Additionally, the PUT/Employees GETLists filtered records./ExpressionEngine/:record/related GETRetrieve a Forecasting Information In SugarChart Format/ExpressionEngine/:record/related POSTRetrieve a Forecasting Information In SugarChart Format/Filters GETLists filtered records./ForecastManagerWorksheets GETReturns a collection of ForecastManagerWorksheet models/ForecastManagerWorksheets/assignQuota POSTAssign Quotas to All Reporting Users for a given timeperiod/ForecastManagerWorksheets/export GETReturns a record set in CSV format along with HTTP headers to indicate content type./ForecastManagerWorksheets/filter GETReturns a collection of ForecastManagerWorksheet models/ForecastManagerWorksheets/filter POSTReturns a collection of ForecastManagerWorksheet models/ForecastManagerWorksheets/:timeperiod_id GETReturns a collection of ForecastManagerWorksheet models/ForecastManagerWorksheets/:timeperiod_id/:user_id GETReturns a collection of ForecastManagerWorksheet models/ForecastWorksheets GETReturns a collection of ForecastWorksheet models/ForecastWorksheets/export GETReturns a record set in CSV format along with HTTP headers to indicate content type./ForecastWorksheets/filter GETReturns a collection of ForecastWorksheet models/ForecastWorksheets/filter POSTReturns a collection of ForecastWorksheet models/ForecastWorksheets/:record PUTSaves a collection of ForecastWorksheet models/ForecastWorksheets/:timeperiod_id GETReturns a collection of ForecastWorksheet models/ForecastWorksheets/:timeperiod_id/:user_id GETReturns a collection of ForecastWorksheet models/Forecasts GETUpdates a record of a specified type as a favorite for the current user./Forecasts/config POSTCreates and/or updates the config settings for the Forecasts module/Forecasts/config PUTCreates and/or updates the config settings for the Forecasts module/Forecasts/enum/selectedTimePeriod GETForecastsApi Timeperiod", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "612910f18ca5-5", "text": "for the Forecasts module/Forecasts/enum/selectedTimePeriod GETForecastsApi Timeperiod filter info/Forecasts/init GETThis endpoint is used to return initialization data for the Forecasts module./Forecasts/reportees/:user_id GETForecastsApi Reportees/Forecasts/:timeperiod_id/progressManager/:user_id GETProjected Manager Data/Forecasts/:timeperiod_id/progressRep/:user_id GETThis endpoint is used to return the json Data not already in client view for the Forecasts rep projected panel./Forecasts/:timeperiod_id/quotas/direct/:user_id GETForecastsQuotasApi - Get/Forecasts/:timeperiod_id/quotas/rollup/:user_id GETForecastsQuotasApi - Get/Forecasts/:timeperiod_id/:user_id/chart/:display_manager GETRetrieve a Forecasting Information In SugarChart Format/Forecasts/user/:user_id GETThis endpoint is used to return a user's id, user_name, full_name, first_name, last_name, and is_manager param given a user's id./Genericsearch GETThis endpoint searches the content of the given modules using the provider specified by the \"generic_search\" configuration variable. If the variable is absent, the default provider is \"Elastic\"./Genericsearch POSTThis endpoint searches the content of the given modules using the provider specified by the \"generic_search\" configuration variable. If the variable is absent, the default provider is \"Elastic\"./integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value DELETERemoves a relationship based on lhs_sync_key_field_name and rhs_sync_key_field_name. If both the LHS and RHS records can be found with the respective fields, and those records are related, then remove the relationship of the RHS record to the LHS", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "612910f18ca5-6", "text": "fields, and those records are related, then remove the relationship of the RHS record to the LHS record./integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value POSTCreates a relationship based on lhs_sync_key_field_name and rhs_sync_key_field_name. If both the LHS and RHS records can be found with the respective fields, then relate the RHS record to the LHS record./integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value PATCHSets a sync key value for a record./integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value PUTSets a sync key value for a record. Note that the PATCH method is recommended over the PUT method./integrate/<module>/:sync_key_field_name/:sync_key_field_value DELETEDeletes the record with the given sync_key_field_name./integrate/<module>/:sync_key_field_name/:sync_key_field_value GETRetrieves the record with the given sync_key_field_name./integrate/<module>/:sync_key_field_name/:sync_key_field_value PATCHUpserts based on sync_key_field_name. If a record can be found with sync_key_field_name, then update. If the record does not exist, then create it./integrate/<module>/:sync_key_field_name/:sync_key_field_value PUTUpserts based on sync_key_field_name. If a record can be found with sync_key_field_name, then update. If the record does not exist, then create it. Note that the PATCH method is recommended over the PUT method./KBContents GETLists filtered records./KBContents/config POSTCreates and/or updates the config settings for the KBContents module/KBContents/config PUTCreates and/or updates the config settings for the KBContents module/KBContents/duplicateCheck POSTRuns a duplicate check against specified data./KBContents/filter GETLists", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "612910f18ca5-7", "text": "POSTRuns a duplicate check against specified data./KBContents/filter GETLists filtered records./KBContents/:record/link POSTCreates relationships to a pre-existing record./KBContents/:record/notuseful PUTVote for Knowledge Base article./KBContents/:record/useful PUTVote for Knowledge Base article./Leads POSTCreate Lead with optional post-save actions/Leads/:leadId/convert POSTConvert Lead to a Contact and optionally link it to a new or existing instance of the modules specified/Leads/:record/freebusy GETGet a lead's FreeBusy schedule/Leads/register POSTCreates new Leads./Mail POSTCreate an email and send or save as draft./Mail/address/validate POSTValidate one or more email addresses./Mail/archive POSTArchives an email./Mail/attachment POSTUpload an email attachment/Mail/attachment/cache DELETEClears the user's attachment cache directory/Mail/attachment/:file_guid DELETEDelete an updated email attachment (where :file_guid is the guid value returned from the /Mail/attachment API)/Mail/recipients/find GETFinds recipients that match the search term./Mail/recipients/lookup POSTAccepts an array of one or more recipients and tries to resolve unsupplied arguments to provide more comprehensive/Meetings POSTCreate a single event or a series of event records./Meetings/:record DELETEDeletes either a single event record or a series of event records/Meetings/:record PUTUpdate a calendar event record of the specified type./Meetings/:record/external GETRetrieves info about launching an external meeting/Notifications GETLists filtered records./Opportunities/config POSTOpportunity Config Save/Opportunities/enum/:field GETRetrieves the enum values for a specific field./Opportunities/:record PUTUpdate a record of the specified type./OutboundEmailConfiguration/list GETLists the current user's outbound email configurations for sending email./OutboundEmail POSTCreate a new OutboundEmail configuration to use to send emails over", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "612910f18ca5-8", "text": "sending email./OutboundEmail POSTCreate a new OutboundEmail configuration to use to send emails over SMTP./OutboundEmail/:record PUTUpdate an OutboundEmail configuration./PdfManager GETLists filtered records./PdfManager/generate GETPdfManager Generate Endpoint Help/ProductTemplates/tree GETThis endpoint is designed to return a paged recordset of one level of product templates and product categories in/ProductTemplates/tree POSTThis endpoint is designed to return a paged recordset of one level of product templates and product categories in/Quotes/config GETQuote Config GET Help/Quotes/config POSTQuote Config POST Help/Quotes/:record/opportunity POSTQuote Convert to Opportunity/Reports/:record/chart GETAn API to get chart data for a saved report./Reports/:record/record_count GETAn API to get total number of filtered records from a saved report./Reports/:record/records GETAn API to deliver filtered records from a saved report./Reports/:record/:type GETAn API to run a saved report and export the result./RevenueLineItems/multi-quote POSTConvert Multiple Revenue Line Item to a quote./RevenueLineItems/:record/quote POSTConvert a Revenue Line Item to a quote./Tags/:record PUTUpdate a record of the specified type./Teams/:record/link POSTCreates relationships to a pre-existing record./Teams/:record/link/:link_name/:remote_id DELETEDeletes an existing relationship between two records./Teams/:record/link/:link_name/:remote_id POSTCreates a relationship to a pre-existing record./TimePeriods GETLists filtered records./TimePeriods/current GETGet the get the current timeperiod/TimePeriods/:date GETReturn a Timeperiod by a given date/TimePeriods/filter GETLists filtered records./Users GETLists filtered records./Users/:record DELETEDelete a User and return its ID/Users/:record/freebusy GETGet a user's FreeBusy schedule/Users/:record/link POSTCreates relationships to a pre-existing", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "612910f18ca5-9", "text": "GETGet a user's FreeBusy schedule/Users/:record/link POSTCreates relationships to a pre-existing record./Users/:record/link/:link_name/:remote_id DELETEDeletes an existing relationship between two records./Users/:record/link/:link_name/:remote_id POSTCreates a relationship to a pre-existing record./VCardDownload GETDownloads a vCard./bulk POSTRun API calls in bulk./collection/:collection_name GETLists records from multiple modules at a time./connectors GETGets general info about connectors./connector/twitter/currentUser GETResponds with twitter timeline if connector is set up in administration/connector/twitter/:twitterId GETResponds with twitter timeline if connector is set up in administration/css GETRuns LessPHP for a platform and a theme and outputs an array of css files. If not found the css files/css/preview GETRuns LessPHP for a platform and a theme and outputs the compiled CSS. It only allows to preview the theme because/globalsearch GETThis endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the/globalsearch POSTThis endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the/help GETFetches the help documentation/help/exceptions GETFetches the documentation on which exceptions are thrown by the API, their/lang/labels/dropdown PUTUpdate display labels of dropdown items for dropdowns under different languages./lang/labels/module PUTUpdate display labels of fields for modules under different languages./logger POSTLogs a message to the Sugar Log/login/content GETReturns information to facilitate receiving marketing content from SugarCRM./login/marketingContentUrl GETReturns the SugarCRM marketing content URL that is managed by the marketing team./me GETReturns the current user object./me PUTReturns the current user object./me/following GETReturns all of the current users followed records/me/password POSTCreate a new record of a specified type./me/password PUTCreate a new record of a specified type./me/preference/:preference_name", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "612910f18ca5-10", "text": "PUTCreate a new record of a specified type./me/preference/:preference_name DELETEDeletes a specific preference for the current user./me/preference/:preference_name GETReturns a specific preference for the current user./me/preference/:preference_name POSTCreates a preference for the current user./me/preference/:preference_name PUTUpdates a specific preference for the current user./me/preferences GETReturns all the current user's stored preferences./me/preferences PUTMass updates preferences for the user./metadata/<module>/:segment GET[ADMIN] Gets the desired segment for a given module./<module>/Activities GETActivities on a module's list view/<module>/Activities/filter GETActivities on a module's list view/<module>/MassUpdate DELETEAn API to mass delete records./<module>/MassUpdate PUTAn API to mass update records./<module> GETLists filtered records./<module> POSTCreate a new record of a specified type./<module>/append/:target POSTAppend new node to target node as last child./<module>/audit/export GETReturns a list of data changes for a specific module./<module>/config GETRetrieves the config settings for a given module./<module>/config POSTRetrieves the config settings for a given module./<module>/config PUTRetrieves the config settings for a given module./<module>/count GETLists filtered records./<module>/customfield POSTCreate a new custom field for a specified module./<module>/customfield/:field DELETEDelete a custom field for a specified module./<module>/duplicateCheck POSTRuns a duplicate check against specified data./<module>/enum/:field GETRetrieves the enum values for a specific field./<module>/export/:record_list_id GETReturns a record set in CSV format along with HTTP headers to indicate content type./<module>/favorites GETOpportunity Favorites Help/<module>/favorites POSTOpportunity Favorites Help/<module>/file/vcard_import", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "612910f18ca5-11", "text": "Favorites Help/<module>/favorites POSTOpportunity Favorites Help/<module>/file/vcard_import POSTImports a person record from a vcard./<module>/filter GETLists filtered records./<module>/filter POSTLists filtered records./<module>/filter/count GETLists filtered records./<module>/filter/count POSTLists filtered records./<module>/globalsearch GETThis endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the/<module>/globalsearch POSTThis endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the/<module>/insertafter/:target POSTInsert new node after target node./<module>/insertbefore/:target POSTInsert new node before target node./<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value DELETERemoves a relationship based on sync_key. If both the LHS and RHS records can be found with the respective fields, and those records are related, then remove the relationship of the RHS record to the LHS record./<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value POSTCreates a relationship based on sync_key. If both the LHS and RHS records can be found with the respective fields, then relate the RHS record to the LHS record./<module>/prepend/:target POSTAppend new node to target node as first child./<module>/recent-product GETOpportunity Recent Product Help/<module>/recent-product POSTOpportunity Recent Product Help/<module>/:record DELETEDelete a record of a specified type./<module>/:record GETRetrieves a record./<module>/:record PUTUpdate a record of the specified type./<module>/record_list POSTAn API to create and save lists of records./<module>/record_list/:record_list_id DELETEAn API to delete lists of records/<module>/record_list/:record_list_id GETAn API to return", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "612910f18ca5-12", "text": "API to delete lists of records/<module>/record_list/:record_list_id GETAn API to return record list data/<module>/:record/audit GETReturns data changes for a specific record./<module>/:record/children GETRetrieves all children of selected record./<module>/:record/collection/:collection_name GETLists related records from multiple links at a time./<module>/:record/collection/:collection_name/count GETCounts related records from multiple links at a time./<module>/:record/favorite DELETERemoves a record of a specified type as a favorite for the current user./<module>/:record/favorite PUTUpdates a record of a specified type as a favorite for the current user./<module>/:record/file GETLists all populated fields of type \"file\" or of type \"image\" for a record./<module>/:record/file/:field DELETERemoves an attachment from a field for a record and subsequently removes the file from the file system./<module>/:record/file/:field GETRetrieves an attached file for a specific field on a record./<module>/:record/file/:field POSTAttaches a file to a field on a record./<module>/:record/file/:field PUTThis endpoint takes a file or image and saves it to a record that already contains an attachment in the specified field. The PUT method is very similar to the POST method but differs slightly in how the request is constructed. PUT requests should send the file data as the body of the request. Optionally, a filename query parameter can be sent with the request to assign a name. Additionally, the PUT/<module>/:record/link POSTCreates relationships to a pre-existing record./<module>/:record/link/activities GETActivities on a module's list view/<module>/:record/link/activities/filter GETActivities on a module's list view/<module>/:record/link/history GETLists history filtered", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "612910f18ca5-13", "text": "GETActivities on a module's list view/<module>/:record/link/history GETLists history filtered records./<module>/:record/link/:link_name GETLists related filtered records./<module>/:record/link/:link_name POSTCreates a related record./<module>/:record/link/:link_name/add_record_list/:remote_id POSTCreates relationships to pre-existing record from a record list./<module>/:record/link/:link_name/count GETLists related filtered records./<module>/:record/link/:link_name/filter GETLists related filtered records./<module>/:record/link/:link_name/filter/count GETLists related filtered records./<module>/:record/link/:link_name/filter/leancount GETLists related filtered records./<module>/:record/link/:link_name/leancount GETLists related filtered records./<module>/:record/link/:link_name/:remote_id DELETEDeletes an existing relationship between two records./<module>/:record/link/:link_name/:remote_id GETRetrieves a related record with relationship role information./<module>/:record/link/:link_name/:remote_id POSTCreates a relationship to a pre-existing record./<module>/:record/link/:link_name/:remote_id PUTUpdates relationship specific information on an existing relationship./<module>/:record/link/related_activities GETReturns related activity records for a specified record./<module>/:record/moveafter/:target PUTMove existing node after target node./<module>/:record/movebefore/:target PUTMove existing node before target node./<module>/:record/movefirst/:target PUTMove existing node as first child of target node./<module>/:record/movelast/:target PUTMove existing node as last child of target node./<module>/:record/next GETRetrieves next sibling of selected record./<module>/:record/parent GETRetrieves parent node for selected record./<module>/:record/path GETRetrieves all parents", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "612910f18ca5-14", "text": "parent node for selected record./<module>/:record/path GETRetrieves all parents of selected record./<module>/:record/pii GETReturns personally identifiable information (pii) fields with current data and source of data capture for a specific record./<module>/:record/prev GETRetrieves previous sibling of selected record./<module>/:record/subscribe POSTThis endpoint creates a subscription record in the Subscriptions table, from a specified record and module. It allows the user to be subscribed to activity stream messages for the record being subscribed to, or \"followed\"./<module>/:record/unfavorite PUTRemoves a record of a specified type as a favorite for the current user./<module>/:record/unsubscribe DELETEThis endpoint deletes a subscription record in the Subscriptions table, from a specified record and module. It allows the user to be unsubscribe from activity stream messages for the record being subscribed to, or \"followed\"./<module>/:record/vcard GETDownloads a vCard./<module>/:root/tree GETRetrieves full tree for selected root record./<module>/sync_key/:sync_key_field_value DELETEDeletes the record with the given sync_key./<module>/sync_key/:sync_key_field_value GETRetrieves the record with the given sync_key./<module>/sync_key/:sync_key_field_value PATCHUpserts based on sync_key. If a record can be found with sync_key, then update. If the record does not exist, then create it./<module>/sync_key/:sync_key_field_value PUTUpserts based on sync_key. If a record can be found with sync_key, then update. If the record does not exist, then create it. Note that the PATCH method is recommended over the PUT method./<module>/temp/file/:field POSTSaves an image to a temporary folder./<module>/temp/file/:field/:temp_id GETReads a temporary image and deletes", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "612910f18ca5-15", "text": "folder./<module>/temp/file/:field/:temp_id GETReads a temporary image and deletes it./mostactiveusers GETFetches the most active users for meetings, calls, inbound emails, and outbound emails./oauth2/bwc/login POSTATTENTION: FOR INTERNAL USAGE ONLY/oauth2/logout POSTExpires the token portion of the OAuth 2.0 specification./oauth2/sudo/:user_name POSTGet an access token as another user. The current user must be an admin in order to access this endpoint. This method is useful for integrations in order to be able to access the system with the same permission restrictions as a specified user. The calling user does not lose their existing token, this one is granted in addition./oauth2/token POSTRetrieves the token portion of the OAuth 2.0 specification./password/request GETSends an email request to reset a users password./ping GETResponds with \"pong\" if the access_token is valid./ping/whattimeisit GETResponds with the current time in server format./pmse_Business_Rules GETLists filtered records./pmse_Business_Rules/file/businessrules_import POSTImports a Process Business Rules definition from a .pbr file/pmse_Business_Rules/:record/brules GETExports a .pbr file with a Process Business Rules definition/pmse_Emails_Templates GETLists filtered records./pmse_Emails_Templates/file/emailtemplates_import POSTImports a Process Email Templates definition from a .pet file/pmse_Emails_Templates/:/find_modules GETGet the related module list for a module/pmse_Emails_Templates/:record/etemplate GETExports a .pet file with a Process Email Templates definition/pmse_Emails_Templates/variables/find GETGet the variable list for a module/pmse_Inbox/AdhocReassign PUTDeprecated endpoint./pmse_Inbox/AdhocReassign/:data/:flowId GETDeprecated", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "612910f18ca5-16", "text": "PUTDeprecated endpoint./pmse_Inbox/AdhocReassign/:data/:flowId GETDeprecated endpoint./pmse_Inbox/ReassignForm PUTDeprecated endpoint./pmse_Inbox/ReassignForm/:data/:flowId GETDeprecated endpoint./pmse_Inbox GETReturns a list of Processes by user using filters/pmse_Inbox/cancelCases PUTCall methods to cancel a process/pmse_Inbox/case/:id/:idflow GETRetrieve information of the process record/pmse_Inbox/casesList GETReturns a list with the processes for Process Management/pmse_Inbox/changeCaseUser/:cas_id GETDeprecated endpoint./pmse_Inbox/clearLog/:typelog PUTClear the PMSE.log file log/pmse_Inbox/delete_notes/:id DELETEDeletes a process note/pmse_Inbox/engine_claim PUTClaims the processes to the current user/pmse_Inbox/engine_route PUTEvaluates the response of the user form Show Process [Approve, Reject, Route]/pmse_Inbox/filter GETReturns a list of Processes by user/pmse_Inbox/getLog GETReturn the text of the PMSE.log file/pmse_Inbox/historyLog/:filter GETGets the history log for a process/pmse_Inbox/note_list/:cas_id GETReturns the notes list for a process/pmse_Inbox/reactivateFlows PUTDeprecated endpoint./pmse_Inbox/reassignFlows PUTCall methods to reassign processes/pmse_Inbox/reassignFlows/:record GETRetrieve information to reassign processes/pmse_Inbox/:record/file/:field GETReturns the process status image file/pmse_Inbox/save_notes POSTCreates a new note for a process/pmse_Inbox/settings GETRetrieve settings for the PA engine/pmse_Inbox/settings PUTUpdate settings for the SugarBPMTM engine/pmse_Inbox/unattendedCases GETRetrieves the processes to show on Unattended Process view/pmse_Inbox/userListByTeam/:id GETDeprecated", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "612910f18ca5-17", "text": "processes to show on Unattended Process view/pmse_Inbox/userListByTeam/:id GETDeprecated endpoint./pmse_Project/ActivityDefinition/:record GETRetrieves the definition data for an activity/pmse_Project/ActivityDefinition/:record PUTUpdates the definition data for an activity/pmse_Project/CrmData/:data/:filter GETRetrieves information about Fields, Modules, Users, Roles, etc./pmse_Project/CrmData/:record/:filter PUTUpdates information about Fields, Modules, Users, Roles, etc./pmse_Project/EventDefinition/:record GETRetrieves the definition data for an event/pmse_Project/EventDefinition/:record PUTUpdates the definition data for an event/pmse_Project/GatewayDefinition/:record GETRetrieves the definition data for a gateway/pmse_Project/GatewayDefinition/:record PUTUpdates the definition data for a gateway/pmse_Project GETLists filtered records./pmse_Project/file/project_import POSTImports a Process Definition from a .bpm file/pmse_Project/project/:record GETRetrieves the schema data to be used by the Process Definition designer/pmse_Project/project/:record PUTUpdates the schema data from the Process Definition designer/pmse_Project/:record/dproject GETExports a .bpm file with a Process Definition/pmse_Project/:record/verify GETVerifies whether the Process Definition has any pending processes/pmse_Project/validateCrmData/:data/:filter GETValidates information about Fields, Modules, Users, Roles, etc./recent GETReturns all of the current users recently viewed records./rssfeed GETConsumes an RSS feed as a proxy and returns the feed up to a certain number of entries./search GETList records in a module. Searching, filtering and ordering can be applied to only fetch the records you are interested in. Additionally the set of returned fields can be restricted to speed up processing and reduce download times./theme GETFetches the customizable variables of a theme./theme POSTUpdates the variables.less (less file containing customizable", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "612910f18ca5-18", "text": "the customizable variables of a theme./theme POSTUpdates the variables.less (less file containing customizable vars in the theme folder) with the set of variables passed as arguments.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "612910f18ca5-19", "text": "Last modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html"}
{"id": "18c96c145523-0", "text": "/ForecastWorksheets GET\nReturns a collection of ForecastWorksheet models\nSummary:\nThis end point is used to return the Worksheets for a user at a given timeperiod.  If no timeperiod is provide it\n    will use the default timeperiod, likewise if no user is provided, it will default to the logged in user.\nAlso this end points use the visibility requirements set forth by the application, that if the records being requested\n    belong to you, you will get the draft version,  If the worksheet is not yours, you will only see the committed version.\nUrl Parameters:\nParam\nDescription\nOptional\ntimeperiod_id\nShow for a specific time period, defaults to the current time period if one is not passed\nOptional\nuser_id\nShow for a specific user, defaults to current user if not defined\nOptional\nQuery Parameters:\nParam\nDescription\nOptional\ntype\nWhich type to return, currently the ones that are supported are, opportunity and product\nOptional\nPossible Errors\nError\nDescription\n412 - Invalid Parameter\nWhen the passed in timeperiod and/or user can not be found\n403 - Not Authorized\nIf you are not a manager, but you are tyring to view another sales rep forecast worksheet, you will receive a 403 Not Authorized Error\nUrl Example:\n        /rest/v10/ForecastWorksheets/:timeperiod_id/:user_id\n    \nOutput Example:\n        { \"next_offset\": -1,\n        \"records\": [\n            {\n                \"id\": \"ad3908c7-83a3-f360-c223-51117844c208\",\n                \"name\": \"Grow-Fast Inc - 1000 units\",\n                \"date_entered\": \"2013-02-05T21:22:00+00:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheets_GET/index.html"}
{"id": "18c96c145523-1", "text": "\"date_modified\": \"2013-02-05T21:22:00+00:00\",\n                \"modified_user_id\": \"1\",\n                \"modified_by_name\": \"Administrator\",\n                \"created_by\": \"1\",\n                \"created_by_name\": \"Administrator\",\n                \"description\": \"\",\n                \"img\": \"\",\n                \"deleted\": \"0\",\n                \"assigned_user_id\": \"seed_jim_id\",\n                \"assigned_user_name\": \"Jim Brennan\",\n                \"team_name\": [\n                    {\n                        \"id\": \"East\",\n                        \"name\": \"East\",\n                        \"name_2\": \"\",\n                        \"primary\": true\n                    }\n                ],\n                \"parent_id\": \"50b90565-e748-ed77-d9d7-511178f5acae\",\n                \"parent_type\": \"Opportunities\",\n                \"account_name\": \"\",\n                \"account_id\": \"\",\n                \"likely_case\": \"75000\",\n                \"best_case\": \"75000\",\n                \"worst_case\": \"75000\",\n                \"base_rate\": \"1\",\n                \"currency_id\": \"-99\",\n                \"currency_name\": \"\",\n                \"currency_symbol\": \"\",\n                \"date_closed\": \"2013-02-10\",\n                \"date_closed_timestamp\": \"1360531443\",\n                \"sales_stage\": \"Perception Analysis\",\n                \"probability\": \"70\",\n                \"commit_stage\": \"include\",\n                \"draft\": \"1\",\n                \"my_favorite\": false,\n                \"_acl\": {\n                    \"fields\": {}\n                }\n            }]\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheets_GET/index.html"}
{"id": "b7fb1c0da32a-0", "text": "/pmse_Project/file/project_import POST\nOverview\n    Imports a Process Definition from a .bpm file\nSummary\n    This endpoint will import a Process Definition from the uploaded .bpm file\n    containing JSON encoded data.\nRequest Arguments\nName\nType\nDescription\nRequired\nselectedIds\narray\nA list of IDs for dependent elements to import.\nFalse\nRequest\nNote: A JSON encoded .bpm file attachment should be included with\nthe request as part of the form-data. An optional array of IDs can be included to indicate\nwhich dependent Business Rules and Email Templates to import and link with the Process Definition.\nThe file must contain the metadata for the dependent elements as well for the selectedIds to be used.\nImportant: The request format must be multipart/form-data.\nResponse Arguments\nName\nType\nDescription\nproject_import\nObject\nResult of the import operation\nResponse\n{\n    \"project_import\":\n    {\n        \"success\":true,\n        \"id\":\"459f05de-3c3a-c0e7-ce1e-573cabe79e7c\",\n        \"br_warning\":true,\n        \"et_warning\":true\n    }\n}\nCompatibility\nSugarBPMTM files exported from Sugar version 7.6.1.0 or earlier cannot be imported to Sugar instances running 7.6.2.0 or later.\nChange Log\nVersion\nChange\n            v11_2\n        \n            Added support for selectedIds to specify which dependent elements to import.\n        \n            v10\n        \n            Added /pmse_Project/file/project_import POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectfileproject_import_POST/index.html"}
{"id": "f28c535027f0-0", "text": "/<module>/config PUT\nOverview\n    Retrieves the config settings for a given module.\nSummary\n    This endpoint is normally used to manage the forecasting module.\nRequest Arguments\nName\nType\nDescription\nRequired\n            <config field>\n        \n            <config field type>\n        \n            The list of config fields to update.\n        \n            False\n        \nRequest\n{\n    \"MyConfigOption\":\"MyConfigValue\"\n}\nResponse Arguments\nName\nType\nDescription\n            <config field>\n        \n            <config field type>\n        \n            The list of config fields will be returned.\n        \nResponse\n{\n   \"MyConfigOption\":\"MyConfigValue\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/config PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleconfig_PUT/index.html"}
{"id": "2d1bce1bfc24-0", "text": "/<module>/insertbefore/:target POST\nOverview\n    Insert new node before target node.\nRequest Arguments\nName\nType\nDescription\nRequired\n                module\n            \n                String\n            \n                The name of sugar module that contains a nested set data and implements the NestedSetInterface.\n            \n                True\n            \n                target\n            \n                String\n            \n                The ID of record that will be used as target to insert new node before\n            \n                True\n            \nRequest\n{\n    \"name\" : \"Children Node 1\"\n}\nResponse Arguments\n    This endpoint does not return any response arguments.\nResponse\nThis endpoint returns a newly created bean\n    {\n    \"my_favorite\":false,\n    \"following\":\"\",\n    \"id\":\"59fa8dd7-0f2c-4bfd-364f-54495f77fa3f\",\n    \"name\":\"Default title\",\n    \"date_entered\":\"2014-10-23T23:03:22+03:00\",\n    \"date_modified\":\"2014-10-23T23:03:22+03:00\",\n    \"modified_user_id\":\"1\",\n    \"modified_by_name\":\"Administrator\",\n    \"created_by\":\"1\",\n    \"created_by_name\":\"Administrator\",\n    \"doc_owner\":\"\",\n    \"description\":\"\",\n    \"deleted\":false,\n    \"source_id\":\"\",\n    \"source_type\":\"\",\n    \"source_meta\":\"\",\n    \"root\":\"be9b0c4a-8b78-1ffa-4f14-54481c2f6269\",\n    \"lft\":118,\n    \"rgt\":119,\n    \"level\":1,\n    \"_acl\":{\"fields\":{}},\n    \"_module\":\"Categories\"\n    }\nChange Log\nVersion", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleinsertbeforetarget_POST/index.html"}
{"id": "2d1bce1bfc24-1", "text": "\"_module\":\"Categories\"\n    }\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/insertbefore/:target POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleinsertbeforetarget_POST/index.html"}
{"id": "4d2807c9548f-0", "text": "/Activities/filter GET\nActivities on the home page\nSummary:\n  This endpoint lists activities across the entire sytstem. It uses a subscription model, and can be queried like a normal bean collection, but without search, ordering or filtering.\nQuery Parameters:\nParamDescriptionOptionalmax_numA maximum number of records to returnOptionaloffsetHow many records to skip over before records are returnedOptional\nInput Example:\nThis endpoint does not accept any input\nOutput Example:\n{\n    \"next_offset\": 20, This will be set to -1 when there are no more records after this \"page\".\n    \"records\": [{\n        \"id\": \"22fb8b16-de1d-f1dc-b15b-51240efde177\",\n        \"date_entered\": \"2013-02-19T23:47:11+00:00\",\n        \"date_modified\": \"2013-02-19T23:47:11+00:00\",\n        \"created_by\": \"1\",\n        \"deleted\": \"0\",\n        \"parent_id\": \"f5bb0331-2c0f-5c7c-b4db-5123caac0056\",\n        \"parent_type\": \"Contacts\",\n        \"activity_type\": \"post\", This will be the type of activity performed.\n        \"data\": {\n            \"value\": \"This is a test post on a contact I'm subscribed to.\"\n        },\n        \"comment_count\": 0, This will be set to the total number of comments on the post.\n        \"last_comment\": { This will be the last comment on the post, which can be used to create a comment model on the frontend.\n            \"deleted\": 0,\n            \"data\": []\n        },\n        \"fields\": [],\n        \"first_name\": null,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Activitiesfilter_GET/index.html"}
{"id": "4d2807c9548f-1", "text": "},\n        \"fields\": [],\n        \"first_name\": null,\n        \"last_name\": \"Administrator\",\n        \"created_by_name\": \" Administrator\" This will be the locale-formatted full name of the user.\n    }, ... ]\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Activitiesfilter_GET/index.html"}
{"id": "f68af5ca38ab-0", "text": "/<module>/MassUpdate PUT\nOverview\n    An API to mass update records.\nQuery String Parameters\nName\nType\nDescription\nRequired\n            massupdate_params\n        \n            Array\n        \n            Mass update parameters.\n        \n            True\n        \n            massupdate_params.uid\n        \n            Array\n        \n            A list of ids.\n        \n            True\n        \n            massupdate_params.[field name]\n        \n            [field type]\n        \n            The field to be modified.\n        \n            False\n        \n            massupdate_params.team_name\n        \n            Array\n        \n            Team array.\n        \n            False\n        \n            massupdate_params.team_name_type\n        \n            String\n        \n            Whether to replace or add teams. Possible values are 'add' and 'replace'.\n        \n            False\n        \nRequest\nMass Updating Records by ID in a Module\n{\n    \"massupdate_params\":{\n        \"uid\":[\n            \"f22d1955-97d8-387d-9866-512d09cc1520\",\n            \"ef1b40aa-5815-4f8d-e909-512d09617ac8\"\n        ],\n        \"department\":\"Marketing\"\n    }\n}\nMass Updating Records with Teams\n{\n   \"massupdate_params\":{\n      \"uid\":[\n         \"f22d1955-97d8-387d-9866-512d09cc1520\",\n         \"ef1b40aa-5815-4f8d-e909-512d09617ac8\"\n      ],\n      \"team_name\":[\n         {\n            \"id\":\"35eab226-c20d-48f4-4670-512d095c8c6f\",\n            \"primary\":true\n         },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleMassUpdate_PUT/index.html"}
{"id": "f68af5ca38ab-1", "text": "\"primary\":true\n         },\n         {\n            \"id\":\"8f640aba-f356-7374-7eb4-512d09745551\",\n            \"primary\":false\n         }\n      ],\n      \"team_name_type\":\"replace\"\n   }\n}\nMass Add Leads, Contacts or Prospects to a Target List\n{\n    \"massupdate_params\": {\n        \"uid\": [     /* Leads, Contacts, or Prospects to Add */\n            \"f3d90a49-14b4-a81c-6cac-526e6c71d33e\",\n            \"f22cde0d-9a20-89d3-ca14-526e6c3c4d08\",\n            \"f15f10bd-1445-5e20-9b5c-526e6ceb71d0\"\n        ],\n        \"prospect_lists\": [\n                 /* Prospect List(s) to Add them To */\n            \"bc5bc249-9c9c-52ad-52b9-526e71f0e18d\"\n        ]\n    }\n}\nResponse Arguments\nName\nType\nDescription\n            Status\n        \n            String\n        \n            The status of the mass update. Possible value is 'done'.\n        \nOutput Done Example\n{\n    \"status\":\"done\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/MassUpdate PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleMassUpdate_PUT/index.html"}
{"id": "193181ce7356-0", "text": "/KBContents GET\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n            Note that JSON-encoded filters can be specified as query parameters\n            in one of two ways for GET requests:\n            \n                    By specifying individual filter arguments as distinct parameters.\n                    Example: filter[0][id]=1.\n                \n                    By specifying the whole filter as a single JSON-encoded string.\n                    Note that this syntax is currently not supported on certain modules.\n                    Example: filter=[{\"id\":\"1\"}].\n                \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContents_GET/index.html"}
{"id": "193181ce7356-1", "text": "False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. Each field may be represented either by string, or by map\n            containing field name and additional field parameters (applicable to link and collection fields).\n            The fields id and date_modified will always be returned.\n            \n            Example: name,account_type,description,{\"name\":\"opportunities\",\"fields\":[\"id\",\"name\",\"sales_status\"],\"order_by\":\"date_closed:desc\"}\n            For more details on additional field parameters, see\n            Relate API and\n            Collection API.\n        \n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \n            q\n        \n            String\n        \n            A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.\n        \n            False\n        \n            deleted\n        \n            Boolean\n        \n            Boolean to show deleted records in the result set.\n        \n            False\n        \n            nulls_last\n        \n            Boolean", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContents_GET/index.html"}
{"id": "193181ce7356-2", "text": "False\n        \n            nulls_last\n        \n            Boolean\n        \n            Boolean to return records with null values in order_by fields last in the result set.\n        \n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\nExample\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContents_GET/index.html"}
{"id": "193181ce7356-3", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContents_GET/index.html"}
{"id": "193181ce7356-4", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\",\n               \"id\": \"b0701501-1fab-8ae7-3942-540da93f5017\",\n               \"name\": \"360 Vacations - 228 Units\",\n               \"date_modified\": \"2014-09-08T16:05:00+03:00\",\n               \"sales_status\": \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContents_GET/index.html"}
{"id": "193181ce7356-5", "text": "{\n               _module: \"Opportunities\"\n               date_modified: \"2014-09-08T16:05:00+03:00\"\n               id: \"9ce7c088-8ee4-7cd3-18f1-540da944d4c0\"\n               name: \"360 Vacations - 312 Units\"\n               sales_status: \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContents_GET/index.html"}
{"id": "4eaaa2cae4d7-0", "text": "/mostactiveusers GET\nOverview\n    Fetches the most active users for meetings, calls, inbound emails, and outbound emails.\nRequest Arguments\nName\nType\nDescription\nRequired\ndays\nInteger\nReturns most active users for the last specified quantity of days. Defaults to 30 days if not specified.\nFalse\nRequest\nhttp://{site_url}/rest/v10/mostactiveusers?days=30\nNote: GET endpoint parameters are passed in the form of a query string.\nResponse Arguments\nResponse\n{\n   \"meetings\":{\n      \"user_id\":\"seed_sarah_id\",\n      \"count\":\"20\",\n      \"first_name\":\"Sarah\",\n      \"last_name\":\"Smith\"\n   },\n   \"calls\":{\n      \"user_id\":\"seed_will_id\",\n      \"count\":\"7\",\n      \"first_name\":\"Will\",\n      \"last_name\":\"Westin\"\n   },\n   \"inbound_emails\":{\n      \"user_id\":\"seed_sarah_id\",\n      \"count\":\"20\",\n      \"first_name\":\"Sarah\",\n      \"last_name\":\"Smith\"\n   },\n   \"outbound_emails\":{\n      \"user_id\":\"seed_max_id\",\n      \"count\":\"17\",\n      \"first_name\":\"Max\",\n      \"last_name\":\"Jensen\"\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /mostactiveusers GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mostactiveusers_GET/index.html"}
{"id": "3c72bd551969-0", "text": "/pmse_Business_Rules GET\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n            Note that JSON-encoded filters can be specified as query parameters\n            in one of two ways for GET requests:\n            \n                    By specifying individual filter arguments as distinct parameters.\n                    Example: filter[0][id]=1.\n                \n                    By specifying the whole filter as a single JSON-encoded string.\n                    Note that this syntax is currently not supported on certain modules.\n                    Example: filter=[{\"id\":\"1\"}].\n                \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Business_Rules_GET/index.html"}
{"id": "3c72bd551969-1", "text": "False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. Each field may be represented either by string, or by map\n            containing field name and additional field parameters (applicable to link and collection fields).\n            The fields id and date_modified will always be returned.\n            \n            Example: name,account_type,description,{\"name\":\"opportunities\",\"fields\":[\"id\",\"name\",\"sales_status\"],\"order_by\":\"date_closed:desc\"}\n            For more details on additional field parameters, see\n            Relate API and\n            Collection API.\n        \n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \n            q\n        \n            String\n        \n            A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.\n        \n            False\n        \n            deleted\n        \n            Boolean\n        \n            Boolean to show deleted records in the result set.\n        \n            False\n        \n            nulls_last\n        \n            Boolean", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Business_Rules_GET/index.html"}
{"id": "3c72bd551969-2", "text": "False\n        \n            nulls_last\n        \n            Boolean\n        \n            Boolean to return records with null values in order_by fields last in the result set.\n        \n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\nExample\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Business_Rules_GET/index.html"}
{"id": "3c72bd551969-3", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Business_Rules_GET/index.html"}
{"id": "3c72bd551969-4", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\",\n               \"id\": \"b0701501-1fab-8ae7-3942-540da93f5017\",\n               \"name\": \"360 Vacations - 228 Units\",\n               \"date_modified\": \"2014-09-08T16:05:00+03:00\",\n               \"sales_status\": \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Business_Rules_GET/index.html"}
{"id": "3c72bd551969-5", "text": "{\n               _module: \"Opportunities\"\n               date_modified: \"2014-09-08T16:05:00+03:00\"\n               id: \"9ce7c088-8ee4-7cd3-18f1-540da944d4c0\"\n               name: \"360 Vacations - 312 Units\"\n               sales_status: \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Business_Rules_GET/index.html"}
{"id": "3fa8e4c533c6-0", "text": "/Opportunities/enum/:field GET\nOverview\n    Retrieves the enum values for a specific field.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            <list values>\n        \n           Array\n        \n            Returns the enum values for a field.\n        \nResponse\n{\n   \"\":\"\",\n   \"Analyst\":\"Analyst\",\n   \"Competitor\":\"Competitor\",\n   \"Customer\":\"Customer\",\n   \"Integrator\":\"Integrator\",\n   \"Investor\":\"Investor\",\n   \"Partner\":\"Partner\",\n   \"Press\":\"Press\",\n   \"Prospect\":\"Prospect\",\n   \"Reseller\":\"Reseller\",\n   \"Other\":\"Other\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/enum/:field GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Opportunitiesenumfield_GET/index.html"}
{"id": "2a2f8f76c87f-0", "text": "/TimePeriods/current GET\nGet the get the current timeperiod\nSummary:\n     This endpoint is used to get the current TimePeriod.  If one is not found a 404 is returned\nOutput Example:\n        {\n           \"id\":\"e394485a-5889-ea75-84c8-51543bd1a5ba\",\n           \"name\":\"Q1 (01\\/01\\/2013 - 03\\/31\\/2013)\",\n           \"parent_id\":\"e28efe2d-c51c-be45-3d84-51543b4d2910\",\n           \"start_date\":\"2013-01-01\",\n           \"start_date_timestamp\":\"1356998400\",\n           \"end_date\":\"2013-03-31\",\n           \"end_date_timestamp\":\"1364774399\",\n           \"created_by\":\"1\",\n           \"date_entered\":\"2013-03-28 12:46:36\",\n           \"date_modified\":\"2013-03-28 12:46:36\",\n           \"deleted\":\"0\",\n           \"is_fiscal\":\"0\",\n           \"is_fiscal_year\":\"0\",\n           \"leaf_cycle\":\"1\",\n           \"type\":\"Quarter\",\n           \"related_timeperiods\":\"\"\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriodscurrent_GET/index.html"}
{"id": "00699a82d9b4-0", "text": "/me GET\nOverview\n    Returns the current user object.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nResponse User\n{\n   \"current_user\":{\n      \"type\":\"user\",\n      \"id\":\"1\",\n      \"full_name\":\"Administrator\",\n      \"timepref\":\"h:ia\",\n      \"timezone\":\"America/Los_Angles\",\n      \"user_name\":\"admin\"\n   }\n}\nResponse Portal User\n{\n   \"current_user\":{\n      \"type\":\"support_portal\",\n      \"id\":\"1234-567\",\n      \"user_id\":\"abcd-123\",\n      \"full_name\":\"Bill Williamson\",\n      \"timepref\":\"h:ia\",\n      \"timezone\":\"America/Denver\",\n      \"user_name\":\"SupportPortalApi\"\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /me GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/me_GET/index.html"}
{"id": "58629a6ccfc2-0", "text": "/EmailAddresses POST\nOverview\n    Create a new email address.\nSummary\n    In the event that the email address already exists, that record will be returned without making any changes.\nRequest Arguments\nName\nType\nDescription\nRequired\n                email_address\n            \n                String\n            \n                The email address.\n            \n                True\n            \n                invalid_email\n            \n                Boolean\n            \ntrue if the email address is invalid. false is the default.\n            \n                False\n            \n                opt_out\n            \n                Boolean\n            \ntrue if the email address is opted out. false is the default.\n            \n                False\n            \nRequest\n{\n  \"email_address\": \"eharmon@example.com\",\n  \"invalid_email\": false,\n  \"opt_out\": false\n}\nResponse Arguments\nName\nType\nDescription\n                <record field>\n            \n                <record field type>\n            \n                Returns the fields for the newly created record.\n            \nResponse\n{\n  \"id\": \"a028341c-ba92-9343-55e7-56cf5beda121\",\n  \"date_created\": \"2016-02-25T11:53:07-08:00\",\n  \"date_modified\": \"2016-02-25T11:53:07-08:00\",\n  \"deleted\": false,\n  \"email_address\": \"eharmon@example.com\",\n  \"email_address_caps\": \"EHARMON@EXAMPLE.COM\",\n  \"invalid_email\": false,\n  \"opt_out\": false,\n  \"_acl\": {\n    \"fields\": {}\n  },\n  \"_module\": \"EmailAddresses\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /EmailAddresses POST endpoint.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmailAddresses_POST/index.html"}
{"id": "58629a6ccfc2-1", "text": "Change\n            v10\n        \n            Added /EmailAddresses POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmailAddresses_POST/index.html"}
{"id": "824a2b077520-0", "text": "/<module>/globalsearch POST\nOverview\n    Global search\nSummary\n    This endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the\n    /search endpoint. This endpoint can be used with a long list of request arguments. Instead of using GET request\n    arguments, all described arguments can be used inside a JSON encoded request body using a the GET request. If your\n    client has no support for GET requests with a body, the POST method can be used as an alternative.\nRequest Arguments\nName\nType\nDescription\nRequired\n            q\n        \n            String\n        \n            The search expression. Multiple terms can be specified at once. All enabled fields will be searched in. The\n            results are ordered by relevance which is based on a multitude of settings based on token counts, hit\n            ratio, (weighted) boost values and type of field. Currently no operators are supported in the search\n            expression itself. By refining the search expression more relevant results will be returned as top results.\n            If no search expression is given results are returned based on last modified date.\n        \n            False\n        \n            module_list\n        \n            String\n        \n            Comma delimited list of modules to search. If omitted, all search enabled modules will be queried. Note that\n            when consuming the endpoint /:module/globalsearch that this parameter is ignored.\n            \n            Example: Accounts,Contacts\n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            highlights\n        \n            Boolean\n        \n            Wether or not to return highlighted results. Default is true.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleglobalsearch_POST/index.html"}
{"id": "824a2b077520-1", "text": "Wether or not to return highlighted results. Default is true.\n        \n            False\n        \n            sort\n        \n            Array\n        \n            Define the sort order of the results. By default the results are returned by relevance which is the\n            preferred approach. Using this argument any search enabled field can be used to sort on. Keep in mind the\n            not sorting by relevance may have a negative performance impact.\n            \n            Example: {\"date_modified\":\"desc\",\"name\":\"asc\"}\n            False\n        \nRequest\n{\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /globalsearch GET/POST endpoint.\n        \n            v10\n        \n            Added /:module/globalsearch GET/POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleglobalsearch_POST/index.html"}
{"id": "1809ef4cfa9d-0", "text": "/ForecastWorksheets/:record PUT\nSaves a collection of ForecastWorksheet models\nSummary:\n    This endpoint is used to save the json Data for an array of worksheet data array entries\nQuery Parameters:\nParam\nDescription\nOptional\nThis endpoint does not accept any parameters.\nInput Example:\n        { \"amount\" : \"10000.000000\",\n          \"assigned_user_id\" : \"seed_max_id\",\n          \"base_rate\" : \"1\",\n          \"best_case\" : \"25000\",\n          \"commit_stage\" : \"include\",\n          \"currency_id\" : \"-99\",\n          \"current_user\" : \"seed_max_id\",\n          \"date_closed\" : \"2013-01-14\",\n          \"date_modified\" : \"2013-01-14T10:58:27-05:00\",\n          \"draft\" : 1,\n          \"id\" : \"347beb60-d57c-b3aa-5922-50f42b6c27d4\",\n          \"likely_case\" : \"15000\",\n          \"name\" : \"RR. Talker Co - 1000 units\",\n          \"probability\" : \"90\",\n          \"product_id\" : \"34b0d547-adaf-03ea-146c-50f42b3e6f04\",\n          \"sales_stage\" : \"Value Proposition\",\n          \"timeperiod_id\" : \"36f7085a-5889-ea75-84c8-50f42bd1a5ba\",\n          \"version\" : 1,\n          \"w_date_modified\" : \"2013-01-14T10:58:27-05:00\",\n          \"worksheet_id\" : \"e0adb532-7d1c-eb49-b102-50f42b455164\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsrecord_PUT/index.html"}
{"id": "1809ef4cfa9d-1", "text": "\"worst_case\" : \"10000.000000\"\n        }\n    \nOutput Example:\n        { \"amount\" : \"15000.000000\",\n          \"assigned_user_id\" : \"seed_max_id\",\n          \"base_rate\" : \"1\",\n          \"best_case\" : \"25000.000000\",\n          \"commit_stage\" : \"include\",\n          \"currency_id\" : \"-99\",\n          \"date_closed\" : \"2013-01-14\",\n          \"date_modified\" : \"2013-01-15T10:52:31-05:00\",\n          \"id\" : \"347beb60-d57c-b3aa-5922-50f42b6c27d4\",\n          \"likely_case\" : \"15000.000000\",\n          \"name\" : \"RR. Talker Co - 1000 units\",\n          \"probability\" : \"90\",\n          \"product_id\" : \"34b0d547-adaf-03ea-146c-50f42b3e6f04\",\n          \"sales_stage\" : \"Value Proposition\",\n          \"version\" : 1,\n          \"w_date_modified\" : \"2013-01-14T10:58:27-05:00\",\n          \"worksheet_id\" : \"e0adb532-7d1c-eb49-b102-50f42b455164\",\n          \"worst_case\" : \"10000.000000\"\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsrecord_PUT/index.html"}
{"id": "73c4617d7c87-0", "text": "/<module>/:record/link POST\nOverview\n    Creates relationships to a pre-existing record.\nRequest Arguments\nName\nType\nDescription\nRequired\n            <relationship link>\n        \n            <string>\n        \n            Link between targeted and related records.\n        \n            True\n        \n            <record ID>\n        \n            <string>\n        \n            The name value list of related records. Each item of the list may be either string equal to related item ID,\n            or map containing record ID (\"id\" key is required in this case)\n            and addition relationship properties.\n        \n            True\n        \nRequest\n{\n    link_name: \"accounts\"\n    ids: [\n        \"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n        {\n            \"id\": \"e689173e-c953-1e14-c215-512d0927e7a2\",\n            \"role\": \"owner\"\n        }\n    ]\n}\nResponse Arguments\nName\nType\nDescription\n            record\n        \n            Array\n        \n            The record linked to related records.\n        \n            related_records\n        \n            Array\n        \n            Records that were associated.\n        \nResponse\n    \"record\": {\n        \"id\": \"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n        \"name\": \"Slender Broadband Inc - 1000 units\",\n        \"date_entered\": \"2013-02-26T19:12:00+00:00\",\n        \"date_modified\": \"2013-02-26T19:12:00+00:00\",\n        \"modified_user_id\": \"1\",\n        \"modified_by_name\": \"Administrator\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlink_POST/index.html"}
{"id": "73c4617d7c87-1", "text": "\"modified_user_id\": \"1\",\n        \"modified_by_name\": \"Administrator\",\n        \"created_by\": \"1\",\n        \"created_by_name\": \"Administrator\",\n        \"description\": \"\",\n        \"img\": \"\",\n        \"last_activity_date\": \"2013-02-28T18:21:00+00:00\",\n        \"deleted\": false,\n        \"assigned_user_id\": \"seed_max_id\",\n        \"assigned_user_name\": \"Max Jensen\",\n        \"team_name\": [\n            {\n                \"id\": \"East\",\n                \"name\": \"East\",\n                \"name_2\": \"\",\n                \"primary\": false\n            },\n            {\n                \"id\": \"West\",\n                \"name\": \"West\",\n                \"name_2\": \"\",\n                \"primary\": true\n            }\n        ],\n        \"opportunity_type\": \"\",\n        \"account_name\": \"Slender Broadband Inc\",\n        \"account_id\": \"181461c6-dc81-1115-1fe0-512d092e8f15\",\n        \"campaign_id\": \"\",\n        \"campaign_name\": \"\",\n        \"lead_source\": \"Campaign\",\n        \"amount\": \"25000\",\n        \"base_rate\": \"1\",\n        \"amount_usdollar\": \"25000\",\n        \"currency_id\": \"-99\",\n        \"currency_name\": \"\",\n        \"currency_symbol\": \"\",\n        \"date_closed\": \"2013-02-27\",\n        \"date_closed_timestamp\": \"1361992480\",\n        \"next_step\": \"\",\n        \"sales_stage\": \"Needs Analysis\",\n        \"sales_status\": \"New\",\n        \"probability\": \"90\",\n        \"best_case\": \"25000\",\n        \"worst_case\": \"25000\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlink_POST/index.html"}
{"id": "73c4617d7c87-2", "text": "\"worst_case\": \"25000\",\n        \"commit_stage\": \"include\",\n        \"my_favorite\": false,\n        \"_acl\": {\n            \"fields\": {\n            }\n        }\n    },\n    \"related_records\": [\n        {\n            \"id\": \"e689173e-c953-1e14-c215-512d0927e7a2\",\n            \"name\": \"Gus Dales\",\n            \"date_entered\": \"2013-02-26T19:12:00+00:00\",\n            \"date_modified\": \"2013-02-26T19:12:00+00:00\",\n            \"modified_user_id\": \"1\",\n            \"modified_by_name\": \"Administrator\",\n            \"created_by\": \"1\",\n            \"created_by_name\": \"Administrator\",\n            \"description\": \"\",\n            \"img\": \"\",\n            \"deleted\": false,\n            \"assigned_user_id\": \"seed_sally_id\",\n            \"assigned_user_name\": \"Sally Bronsen\",\n            \"team_name\": [\n                {\n                    \"id\": \"West\",\n                    \"name\": \"West\",\n                    \"name_2\": \"\",\n                    \"primary\": true\n                }\n            ],\n            \"salutation\": \"\",\n            \"first_name\": \"Gus\",\n            \"last_name\": \"Dales\",\n            \"full_name\": \"Gus Dales\",\n            \"title\": \"Director Operations\",\n            \"linkedin\": \"\",\n            \"facebook\": \"\",\n            \"twitter\": \"\",\n            \"googleplus\": \"\",\n            \"department\": \"\",\n            \"do_not_call\": false,\n            \"phone_home\": \"(661) 120-2292\",\n            \"email\": [\n                {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlink_POST/index.html"}
{"id": "73c4617d7c87-3", "text": "\"email\": [\n                {\n                    \"email_address\": \"section.sugar.section@example.it\",\n                    \"opt_out\": \"1\",\n                    \"invalid_email\": \"0\",\n                    \"primary_address\": \"0\"\n                },\n                {\n                    \"email_address\": \"support.qa.kid@example.co.uk\",\n                    \"opt_out\": \"0\",\n                    \"invalid_email\": \"0\",\n                    \"primary_address\": \"1\"\n                }\n            ],\n            \"phone_mobile\": \"(294) 447-9707\",\n            \"phone_work\": \"(036) 840-3216\",\n            \"phone_other\": \"\",\n            \"phone_fax\": \"\",\n            \"email1\": \"support.qa.kid@example.co.uk\",\n            \"email2\": \"section.sugar.section@example.it\",\n            \"invalid_email\": false,\n            \"email_opt_out\": false,\n            \"primary_address_street\": \"48920 San Carlos Ave\",\n            \"primary_address_street_2\": \"\",\n            \"primary_address_street_3\": \"\",\n            \"primary_address_city\": \"Persistance\",\n            \"primary_address_state\": \"CA\",\n            \"primary_address_postalcode\": \"54556\",\n            \"primary_address_country\": \"USA\",\n            \"alt_address_street\": \"\",\n            \"alt_address_street_2\": \"\",\n            \"alt_address_street_3\": \"\",\n            \"alt_address_city\": \"\",\n            \"alt_address_state\": \"\",\n            \"alt_address_postalcode\": \"\",\n            \"alt_address_country\": \"\",\n            \"assistant\": \"\",\n            \"assistant_phone\": \"\",\n            \"picture\": \"\",\n            \"email_and_name1\": \"\",\n            \"lead_source\": \"Support Portal User Registration\",\n            \"account_name\": \"Arts & Crafts Inc\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlink_POST/index.html"}
{"id": "73c4617d7c87-4", "text": "\"account_name\": \"Arts & Crafts Inc\",\n            \"account_id\": \"d43243c6-9b8e-2973-aee2-512d09bc34b4\",\n            \"opportunity_role_fields\": \"\",\n            \"opportunity_role_id\": \"\",\n            \"opportunity_role\": \"Technical Advisor\",\n            \"reports_to_id\": \"\",\n            \"report_to_name\": \"\",\n            \"portal_name\": \"GusDales145\",\n            \"portal_active\": true,\n            \"portal_password\": \"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0\",\n            \"portal_password1\": \"\",\n            \"portal_app\": \"\",\n            \"preferred_language\": \"en_us\",\n            \"campaign_id\": \"\",\n            \"campaign_name\": \"\",\n            \"c_accept_status_fields\": \"\",\n            \"m_accept_status_fields\": \"\",\n            \"accept_status_id\": \"\",\n            \"accept_status_name\": \"\",\n            \"sync_contact\": \"\",\n            \"my_favorite\": false,\n            \"_acl\": {\n                \"fields\": {\n                }\n            }\n        },\n        {\n            \"id\": \"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n            \"name\": \"Slender Broadband Inc - 1000 units\",\n            \"date_entered\": \"2013-02-26T19:12:00+00:00\",\n            \"date_modified\": \"2013-02-26T19:12:00+00:00\",\n            \"modified_user_id\": \"1\",\n            \"modified_by_name\": \"Administrator\",\n            \"created_by\": \"1\",\n            \"created_by_name\": \"Administrator\",\n            \"description\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlink_POST/index.html"}
{"id": "73c4617d7c87-5", "text": "\"created_by_name\": \"Administrator\",\n            \"description\": \"\",\n            \"img\": \"\",\n            \"last_activity_date\": \"2013-02-28T18:36:00+00:00\",\n            \"deleted\": false,\n            \"assigned_user_id\": \"seed_max_id\",\n            \"assigned_user_name\": \"Max Jensen\",\n            \"team_name\": [\n                {\n                    \"id\": \"East\",\n                    \"name\": \"East\",\n                    \"name_2\": \"\",\n                    \"primary\": false\n                },\n                {\n                    \"id\": \"West\",\n                    \"name\": \"West\",\n                    \"name_2\": \"\",\n                    \"primary\": true\n                }\n            ],\n            \"opportunity_type\": \"\",\n            \"account_name\": \"Slender Broadband Inc\",\n            \"account_id\": \"181461c6-dc81-1115-1fe0-512d092e8f15\",\n            \"campaign_id\": \"\",\n            \"campaign_name\": \"\",\n            \"lead_source\": \"Campaign\",\n            \"amount\": \"25000\",\n            \"base_rate\": \"1\",\n            \"amount_usdollar\": \"25000\",\n            \"currency_id\": \"-99\",\n            \"currency_name\": \"\",\n            \"currency_symbol\": \"\",\n            \"date_closed\": \"2013-02-27\",\n            \"date_closed_timestamp\": \"1361992480\",\n            \"next_step\": \"\",\n            \"sales_stage\": \"Needs Analysis\",\n            \"sales_status\": \"New\",\n            \"probability\": \"90\",\n            \"best_case\": \"25000\",\n            \"worst_case\": \"25000\",\n            \"commit_stage\": \"include\",\n            \"my_favorite\": false,\n            \"_acl\": {\n                \"fields\": {\n                }", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlink_POST/index.html"}
{"id": "73c4617d7c87-6", "text": "\"_acl\": {\n                \"fields\": {\n                }\n            }\n        }\n    ]\n}\nChange Log\nVersion\nChange\n            v10 (7.6.0)\n        \n            Added support for additional relationship values.\n        \n            v10 (7.1.5)\n        \n            Added /<module>/:record/link POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlink_POST/index.html"}
{"id": "e6d81236ce7c-0", "text": "/OutboundEmailConfiguration/list GET\nOverview\n    Lists the current user's outbound email configurations for sending email.\nSummary\n    Used by the Emails module for selecting an outbound email configuration for sending an email.\nResponse\n[\n  {\n     \"id\": \"ecbf2a6c-261e-5fca-fbb6-512d093554b8\",\n     \"name\": \"George Lee \",\n     \"type\": \"user\",\n     \"default\": false\n  },\n  {\n     \"id\": \"af5f8dae-7169-b497-1d77-512d0937ed81\",\n     \"name\": \"ACME, Inc. \",\n     \"type\": \"system\",\n     \"default\": true\n  }\n]\nChange Log\nVersion\nChange\n            v11\n        \n            Last version in which /OutboundEmailConfiguration/list GET is available. Use\n            /Emails/enum/outbound_email_id GET instead.\n        \n            v10\n        \n            Added the /OutboundEmailConfiguration/list GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmailConfigurationlist_GET/index.html"}
{"id": "dccbef7fff8f-0", "text": "/globalsearch GET\nOverview\n    Global search\nSummary\n    This endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the\n    /search endpoint. This endpoint can be used with a long list of request arguments. Instead of using GET request\n    arguments, all described arguments can be used inside a JSON encoded request body using a the GET request. If your\n    client has no support for GET requests with a body, the POST method can be used as an alternative.\nRequest Arguments\nName\nType\nDescription\nRequired\n            q\n        \n            String\n        \n            The search expression. Multiple terms can be specified at once. All enabled fields will be searched in. The\n            results are ordered by relevance which is based on a multitude of settings based on token counts, hit\n            ratio, (weighted) boost values and type of field. Currently no operators are supported in the search\n            expression itself. By refining the search expression more relevant results will be returned as top results.\n            If no search expression is given results are returned based on last modified date.\n        \n            False\n        \n            module_list\n        \n            String\n        \n            Comma delimited list of modules to search. If omitted, all search enabled modules will be queried. Note that\n            when consuming the endpoint /:module/globalsearch that this parameter is ignored.\n            \n            Example: Accounts,Contacts\n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            highlights\n        \n            Boolean\n        \n            Wether or not to return highlighted results. Default is true.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/globalsearch_GET/index.html"}
{"id": "dccbef7fff8f-1", "text": "Wether or not to return highlighted results. Default is true.\n        \n            False\n        \n            sort\n        \n            Array\n        \n            Define the sort order of the results. By default the results are returned by relevance which is the\n            preferred approach. Using this argument any search enabled field can be used to sort on. Keep in mind the\n            not sorting by relevance may have a negative performance impact.\n            \n            Example: {\"date_modified\":\"desc\",\"name\":\"asc\"}\n            False\n        \nRequest\n{\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /globalsearch GET/POST endpoint.\n        \n            v10\n        \n            Added /:module/globalsearch GET/POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/globalsearch_GET/index.html"}
{"id": "2d845cf6c74e-0", "text": "/Reports/:record/chart GET\nOverview\n    An API to get chart data for a saved report.\nSummary\n    This endpoint will return chart data for a saved report.\nRequest Arguments\n    None.\nRequest Example\nGET /rest/v10/Reports/:id/chart\nResponse Arguments\nName\nType\nDescription\n            reportData\n        \n            Array\n        \n            Report def for the chart.\n        \n            chartData\n        \n            Array\n        \n            The chart data for a report.\n        \nResponse\n{\n    \"reportData\":\n    {\n        \"label\":\"Accounts by Industry\",\n        \"id\":\"a06b4212-3509-11e7-ab6e-f45c898a3ce7\",\n        ...\n    },\n    \"chartData\":\n    {\n        \"properties\":[...],\n        \"values\":[...],\n        ...\n    }\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Reportsrecordchart_GET/index.html"}
{"id": "d183601eb408-0", "text": "/<module>/:record/favorite PUT\nOverview\n    Updates a record of a specified type as a favorite for the current user.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            <record field>\n        \n            <record field type>\n        \n            Returns the fields for the selected record.\n        \nResponse\n{\n   \"id\":\"bdd59d85-687b-1739-b00a-512d09f6db9e\",\n   \"name\":\"Insight Marketing Inc\",\n   \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n   \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n   \"modified_user_id\":\"1\",\n   \"modified_by_name\":\"Administrator\",\n   \"created_by\":\"1\",\n   \"created_by_name\":\"Administrator\",\n   \"description\":\"\",\n   \"img\":\"\",\n   \"last_activity_date\":\"2013-02-26T19:12:00+00:00\",\n   \"deleted\":false,\n   \"assigned_user_id\":\"seed_max_id\",\n   \"assigned_user_name\":\"Max Jensen\",\n   \"team_name\":[\n      {\n         \"id\":\"East\",\n         \"name\":\"East\",\n         \"name_2\":\"\",\n         \"primary\":false\n      },\n      {\n         \"id\":1,\n         \"name\":\"Global\",\n         \"name_2\":\"\",\n         \"primary\":false\n      },\n      {\n         \"id\":\"West\",\n         \"name\":\"West\",\n         \"name_2\":\"\",\n         \"primary\":true\n      }\n   ],\n   \"linkedin\":\"\",\n   \"facebook\":\"\",\n   \"twitter\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_PUT/index.html"}
{"id": "d183601eb408-1", "text": "\"linkedin\":\"\",\n   \"facebook\":\"\",\n   \"twitter\":\"\",\n   \"googleplus\":\"\",\n   \"account_type\":\"Customer\",\n   \"industry\":\"Electronics\",\n   \"annual_revenue\":\"\",\n   \"phone_fax\":\"\",\n   \"billing_address_street\":\"345 Sugar Blvd.\",\n   \"billing_address_street_2\":\"\",\n   \"billing_address_street_3\":\"\",\n   \"billing_address_street_4\":\"\",\n   \"billing_address_city\":\"San Mateo\",\n   \"billing_address_state\":\"CA\",\n   \"billing_address_postalcode\":\"56019\",\n   \"billing_address_country\":\"USA\",\n   \"rating\":\"\",\n   \"phone_office\":\"(927) 136-9572\",\n   \"phone_alternate\":\"\",\n   \"website\":\"www.sectionvegan.de\",\n   \"ownership\":\"\",\n   \"employees\":\"\",\n   \"ticker_symbol\":\"\",\n   \"shipping_address_street\":\"345 Sugar Blvd.\",\n   \"shipping_address_street_2\":\"\",\n   \"shipping_address_street_3\":\"\",\n   \"shipping_address_street_4\":\"\",\n   \"shipping_address_city\":\"San Mateo\",\n   \"shipping_address_state\":\"CA\",\n   \"shipping_address_postalcode\":\"56019\",\n   \"shipping_address_country\":\"USA\",\n   \"email1\":\"kid.support.vegan@example.info\",\n   \"parent_id\":\"\",\n   \"sic_code\":\"\",\n   \"parent_name\":\"\",\n   \"email_opt_out\":false,\n   \"invalid_email\":false,\n   \"email\":[\n      {\n         \"email_address\":\"kid.support.vegan@example.info\",\n         \"opt_out\":\"0\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"1\"\n      },\n      {\n         \"email_address\":\"phone.kid@example.cn\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_PUT/index.html"}
{"id": "d183601eb408-2", "text": "},\n      {\n         \"email_address\":\"phone.kid@example.cn\",\n         \"opt_out\":\"0\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"0\"\n      }\n   ],\n   \"campaign_id\":\"\",\n   \"campaign_name\":\"\",\n   \"my_favorite\":true,\n   \"_acl\":{\n      \"fields\":{\n      }\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/favorite PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_PUT/index.html"}
{"id": "7e26f3e6a76f-0", "text": "/Genericsearch GET\nOverview\nGeneric search.\nSummary\nThis endpoint searches the content of the given modules using the provider specified by the \"generic_search\" configuration variable. If the variable is absent, the default provider is \"Elastic\".\nRequest Arguments\nName\nType\nDescription\nRequired\nq\nString\nThe search expression.\nTrue\nmodule_list\nString\nComma-delimited list of modules to search. If omitted, all search enabled modules will be queried. Example: KBDocuments,Bugs\nFalse\nmax_num\nInteger\nA maximum number of records to return. Default is 20.\nFalse\noffset\nInteger\nThe number of records to skip over before records are returned. Default is 0.\nFalse\nResponse Arguments\nName\nType\nDescription\nnext_offset\nInteger\nDisplays the next offset for retrieval of additional results. -1 will be returned when there are no more records.\ntotal\nInteger\nThe number of records found.\nrecords\nArray\nAn array of results containing matched records.\nResponse\n{\n    \"next_offset\": -1,\n    \"total\": 1,\n    \"records\": [\n        {\n            \"name\": \"Connecting to the Internet\",\n            \"description\": \"To connect your device to the Internet, use any application that accesses the Internet. You can connect using either Wi-Fi or Bluetooth.\",\n            \"url\": \"portal/index.html#KBContents/60142236-bad3-11e9-9d32-3c15c2d57622\" (for portal)\n            \"url\": \"#KBContents/60142236-bad3-11e9-9d32-3c15c2d57622\" (for base)\n        }\n    ]\n}\nChange Log\nVersion\nChange\nv11_9\nAdded /Genericsearch\u00c2\u00a0GET endpoint.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Genericsearch_GET/index.html"}
{"id": "7e26f3e6a76f-1", "text": "Version\nChange\nv11_9\nAdded /Genericsearch\u00c2\u00a0GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Genericsearch_GET/index.html"}
{"id": "8a9846991e78-0", "text": "/pmse_Inbox/reassignFlows/:record GET\nOverview\n    Retrieve information to reassign processes \nSummary\n    This endpoint gets information necessary to reassign a process \nRequest Arguments\nName\nType\nDescription\nRequired\nrecord\nstring\nThe id of the process trigger sequence\ntrue\nResponse Arguments\nName\nType\nDescription\nsuccess\nboolean\nResult of the routing operation\nnext_offset\ninteger\nNext offset for more results\nrecords\n<field>:<value>\nList of process attributes \nResponse\n{\n    \"success\":true,\n    \"next_offset\":-1,\n    \"records\":\n    [\n        {\n            \"cas_id\":\"2\",\n            \"cas_index\":\"3\",\n            \"cas_task_start_date\":null,\n            \"cas_delegate_date\":\"2016-06-01T16:18:59-07:00\",\n            \"cas_flow_status\":\"FORM\",\n            \"cas_user_id\":\"seed_sarah_id\",\n            \"cas_due_date\":\"\",\n            \"cas_sugar_module\":\"Accounts\",\n            \"bpmn_id\":\"7c62acc2-2842-11e6-9b9c-6c4008960436\",\n            \"act_name\":\"Activity # 1\",\n            \"act_assignment_method\":\"static\",\n            \"act_expected_time\":\"eyJ0aW1lIjpudWxsLCJ1bml0IjoiaG91ciJ9\",\n            \"cas_expected_time\":\"\",\n            \"assigned_user\":\"Sarah Smith\"\n        }\n    ]\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxreassignFlowsrecord_GET/index.html"}
{"id": "4238c8026138-0", "text": "/pmse_Project/project/:record GET\nOverview\n    Retrieves the schema data to be used by the Process Definition designer\nSummary\n    This endpoint will retrieve the JSON encoded schema data for the Process\n    Definition identified by the record input parameter.\nRequest Arguments\nName\nType\nDescription\nRequired\nrecord\nString\nThe Process Definition record ID\nTrue\nResponse Arguments\nName\nType\nDescription\nsuccess\nBoolean\nThe status of the response\nproject\nObject\nThe schema data for the Process Definition\nResponse\n{\n    \"success\":true,\n    \"project\":\n    {\n        \"id\":\"2119da13-f748-4741-3858-573caddda034\",\n        \"name\":\"PD_AC\",\n        \"date_entered\":\"2016-05-18 17:58:07\",\n        \"date_modified\":\"2016-05-18 18:41:45\",\n        \"modified_user_id\":\"1\",\n        \"created_by\":\"1\",\n        \"description\":null,\n        \"deleted\":\"0\",\n        \"prj_uid\":\"2119da13-f748-4741-3858-573caddda034\",\n        \"prj_target_namespace\":null,\n        \"prj_expression_language\":null,\n        \"prj_type_language\":null,\n        \"prj_exporter\":null,\n        \"prj_exporter_version\":null,\n        \"prj_author\":null,\n        \"prj_author_version\":null,\n        \"prj_original_source\":null,\n        \"prj_status\":\"INACTIVE\",\n        \"prj_module\":\"Accounts\",\n        \"team_id\":\"1\",\n        \"team_set_id\":\"1\",\n        \"team_set_selected_id\":\"\",\n        \"assigned_user_id\":\"1\",\n        \"au_first_name\":null,\n        \"au_last_name\":\"Administrator\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html"}
{"id": "4238c8026138-1", "text": "\"au_first_name\":null,\n        \"au_last_name\":\"Administrator\",\n        \"cbu_first_name\":null,\n        \"cbu_last_name\":\"Administrator\",\n        \"mbu_first_name\":null,\n        \"mbu_last_name\":\"Administrator\",\n        \"tn_name\":\"Global\",\n        \"tn_name_2\":\"\",\n        \"my_favorite\":null,\n        \"following\":\"0\",\n        \"pro_id\":\"9f8c4fcd-8d4c-949d-50b8-573caddf8c0c\",\n        \"diagram\":\n        [\n            {\n                \"id\":\"9ce21d87-f81a-5be2-86e8-573cad955d06\",\n                \"name\":\"PD_AC\",\n                \"date_entered\":\"2016-05-18 17:58:07\",\n                \"date_modified\":\"2016-05-18 17:58:07\",\n                \"modified_user_id\":\"1\",\n                \"created_by\":\"1\",\n                \"description\":null,\n                \"deleted\":\"0\",\n                \"dia_uid\":\"343198086573cad309cc1d6078585899\",\n                \"prj_id\":\"2119da13-f748-4741-3858-573caddda034\",\n                \"dia_is_closable\":\"0\",\n                \"assigned_user_id\":\"1\",\n                \"activities\":\n                [\n                    {\n                        \"id\":\"9ce21d87-f81a-5be2-86e8-573cad955d06\",\n                        \"name\":\"PD_AC\",\n                        \"date_entered\":\"2016-05-18 17:58:07\",\n                        \"date_modified\":\"2016-05-18 17:58:07\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html"}
{"id": "4238c8026138-2", "text": "\"date_modified\":\"2016-05-18 17:58:07\",\n                        \"modified_user_id\":\"1\",\n                        \"created_by\":\"1\",\n                        \"description\":null,\n                        \"deleted\":\"0\",\n                        \"dia_uid\":\"343198086573cad309cc1d6078585899\",\n                        \"prj_id\":\"2119da13-f748-4741-3858-573caddda034\",\n                        \"dia_is_closable\":\"0\",\n                        \"assigned_user_id\":\"1\",\n                        \"activities\":\n                        [\n                            {\n                                \"id\":\"566f0156-0ce3-75b4-da56-573cb73984aa\",\n                                \"name\":\"Action # 1\",\n                                \"date_entered\":\"2016-05-18 18:41:29\",\n                                \"date_modified\":\"2016-05-18 18:41:45\",\n                                \"created_by\":\"1\",\n                                \"description\":\"\",\n                                \"deleted\":\"0\",\n                                \"act_uid\":\"552527013573cb7565825f2050463919\",\n                                \"act_type\":\"TASK\",\n                                \"act_is_for_compensation\":\"0\",\n                                \"act_start_quantity\":\"1\",\n                                \"act_completion_quantity\":\"0\",\n                                \"act_task_type\":\"SCRIPTTASK\",\n                                \"act_implementation\":\"\",\n                                \"act_instantiate\":\"0\",\n                                \"act_script_type\":\"CHANGE_FIELD\",\n                                \"act_script\":\"\",\n                                \"act_loop_type\":\"NONE\",\n                                \"act_test_before\":\"0\",\n                                \"act_loop_maximum\":\"0\",\n                                \"act_loop_condition\":\"\",\n                                \"act_loop_cardinality\":\"0\",\n                                \"act_loop_behavior\":\"\",\n                                \"act_is_adhoc\":\"0\",\n                                \"act_is_collapsed\":\"0\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html"}
{"id": "4238c8026138-3", "text": "\"act_is_adhoc\":\"0\",\n                                \"act_is_collapsed\":\"0\",\n                                \"act_completion_condition\":\"\",\n                                \"act_ordering\":\"PARALLEL\",\n                                \"act_cancel_remaining_instances\":\"1\",\n                                \"act_protocol\":\"\",\n                                \"act_method\":\"\",\n                                \"act_is_global\":\"0\",\n                                \"act_referer\":\"\",\n                                \"act_default_flow\":\"0\",\n                                \"act_master_diagram\":\"\",\n                                \"bou_x\":\"245\",\n                                \"bou_y\":\"106\",\n                                \"bou_width\":\"35\",\n                                \"bou_height\":\"35\",\n                                \"bou_container\":\"bpmnDiagram\",\n                                \"act_name\":\"Action # 1\"\n                            }\n                        ],\n                        \"id\":\"566f0156-0ce3-75b4-da56-573cb73984aa\",\n                        \"name\":\"Action # 1\",\n                        \"date_entered\":\"2016-05-18 18:41:29\",\n                        \"date_modified\":\"2016-05-18 18:41:45\",\n                        \"created_by\":\"1\",\n                        \"description\":\"\",\n                        \"deleted\":\"0\",\n                        \"act_uid\":\"552527013573cb7565825f2050463919\",\n                        \"act_type\":\"TASK\",\n                        \"act_is_for_compensation\":\"0\",\n                        \"act_start_quantity\":\"1\",\n                        \"act_completion_quantity\":\"0\",\n                        \"act_task_type\":\"SCRIPTTASK\",\n                        \"act_implementation\":\"\",\n                        \"act_instantiate\":\"0\",\n                        \"act_script_type\":\"CHANGE_FIELD\",\n                        \"act_script\":\"\",\n                        \"act_loop_type\":\"NONE\",\n                        \"act_test_before\":\"0\",\n                        \"act_loop_maximum\":\"0\",\n                        \"act_loop_condition\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html"}
{"id": "4238c8026138-4", "text": "\"act_loop_maximum\":\"0\",\n                        \"act_loop_condition\":\"\",\n                        \"act_loop_cardinality\":\"0\",\n                        \"act_loop_behavior\":\"\",\n                        \"act_is_adhoc\":\"0\",\n                        \"act_is_collapsed\":\"0\",\n                        \"act_completion_condition\":\"\",\n                        \"act_ordering\":\"PARALLEL\",\n                        \"act_cancel_remaining_instances\":\"1\",\n                        \"act_protocol\":\"\",\n                        \"act_method\":\"\",\n                        \"act_is_global\":\"0\",\n                        \"act_referer\":\"\",\n                        \"act_default_flow\":\"0\",\n                        \"act_master_diagram\":\"\",\n                        \"bou_x\":\"245\",\n                        \"bou_y\":\"106\",\n                        \"bou_width\":\"35\",\n                        \"bou_height\":\"35\",\n                        \"bou_container\":\"bpmnDiagram\",\n                        \"act_name\":\"Action # 1\"\n                    }\n                ],\n                \"events\":\n                [\n                    {\n                        \"id\":\"80a37c82-8be8-c668-a547-573cb791b905\",\n                        \"name\":\"Start Event # 1\",\n                        \"date_entered\":\"2016-05-18 18:41:29\",\n                        \"date_modified\":\"2016-05-18 18:41:29\",\n                        \"created_by\":\"1\",\n                        \"description\":\"\",\n                        \"deleted\":\"0\",\n                        \"evn_uid\":\"632263607573cb74a582507093735454\",\n                        \"evn_type\":\"START\",\n                        \"evn_marker\":\"MESSAGE\",\n                        \"evn_is_interrupting\":\"1\",\n                        \"evn_attached_to\":\"\",\n                        \"evn_cancel_activity\":\"0\",\n                        \"evn_activity_ref\":\"\",\n                        \"evn_wait_for_completion\":\"1\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html"}
{"id": "4238c8026138-5", "text": "\"evn_activity_ref\":\"\",\n                        \"evn_wait_for_completion\":\"1\",\n                        \"evn_error_name\":\"\",\n                        \"evn_error_code\":\"\",\n                        \"evn_escalation_name\":\"\",\n                        \"evn_escalation_code\":\"\",\n                        \"evn_condition\":\"\",\n                        \"evn_message\":\"\",\n                        \"evn_operation_name\":\"\",\n                        \"evn_operation_implementation\":\"\",\n                        \"evn_time_date\":\"\",\n                        \"evn_time_cycle\":\"\",\n                        \"evn_time_duration\":\"\",\n                        \"evn_behavior\":\"CATCH\",\n                        \"bou_x\":\"132\",\n                        \"bou_y\":\"108\",\n                        \"bou_width\":\"33\",\n                        \"bou_height\":\"33\",\n                        \"bou_container\":\"bpmnDiagram\",\n                        \"evn_name\":\"Start Event # 1\"\n                    },\n                    {\n                        \"id\":\"82894d13-1af8-f039-2cd3-573cb755559e\",\n                        \"name\":\"End Event # 1\",\n                        \"date_entered\":\"2016-05-18 18:41:29\",\n                        \"date_modified\":\"2016-05-18 18:41:29\",\n                        \"created_by\":\"1\",\n                        \"description\":\"\",\n                        \"deleted\":\"0\",\n                        \"evn_uid\":\"282428179573cb7585826d6045140545\",\n                        \"evn_type\":\"END\",\n                        \"evn_marker\":\"EMPTY\",\n                        \"evn_is_interrupting\":\"1\",\n                        \"evn_attached_to\":\"\",\n                        \"evn_cancel_activity\":\"0\",\n                        \"evn_activity_ref\":\"\",\n                        \"evn_wait_for_completion\":\"1\",\n                        \"evn_error_name\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html"}
{"id": "4238c8026138-6", "text": "\"evn_wait_for_completion\":\"1\",\n                        \"evn_error_name\":\"\",\n                        \"evn_error_code\":\"\",\n                        \"evn_escalation_name\":\"\",\n                        \"evn_escalation_code\":\"\",\n                        \"evn_condition\":\"\",\n                        \"evn_message\":\"\",\n                        \"evn_operation_name\":\"\",\n                        \"evn_operation_implementation\":\"\",\n                        \"evn_time_date\":\"\",\n                        \"evn_time_cycle\":\"\",\n                        \"evn_time_duration\":\"\",\n                        \"evn_behavior\":\"THROW\",\n                        \"bou_x\":\"349\",\n                        \"bou_y\":\"107\",\n                        \"bou_width\":\"33\",\n                        \"bou_height\":\"33\",\n                        \"bou_container\":\"bpmnDiagram\",\n                        \"evn_name\":\"End Event # 1\"\n                    }\n                ],\n                \"gateways\":[],\n                \"artifacts\":[],\n                \"flows\":\n                [\n                    {\n                        \"id\":\"974e5216-9d76-5e30-7241-573cb73b7761\",\n                        \"name\":\"\",\n                        \"date_entered\":\"2016-05-18 18:41:36\",\n                        \"date_modified\":\"2016-05-18 18:41:36\",\n                        \"created_by\":\"1\",\n                        \"description\":\"\",\n                        \"deleted\":\"0\",\n                        \"flo_uid\":\"287649205573cb75b582a78086279138\",\n                        \"flo_type\":\"SEQUENCE\",\n                        \"flo_element_origin\":\"632263607573cb74a582507093735454\",\n                        \"flo_element_origin_type\":\"bpmnEvent\",\n                        \"flo_element_origin_port\":\"0\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html"}
{"id": "4238c8026138-7", "text": "\"flo_element_origin_port\":\"0\",\n                        \"flo_element_dest\":\"552527013573cb7565825f2050463919\",\n                        \"flo_element_dest_type\":\"bpmnActivity\",\n                        \"flo_element_dest_port\":\"0\",\n                        \"flo_is_inmediate\":\"\",\n                        \"flo_condition\":\"\",\n                        \"flo_eval_priority\":\"0\",\n                        \"flo_x1\":\"165\",\n                        \"flo_y1\":\"125\",\n                        \"flo_x2\":\"243\",\n                        \"flo_y2\":\"122\",\n                        \"flo_state\":\n                        [\n                            {\n                                \"x\":165,\n                                \"y\":125\n                            },\n                            {\n                                \"x\":204,\n                                \"y\":125\n                            },\n                            {\n                                \"x\":204,\n                                \"y\":122\n                            },\n                            {\n                                \"x\":243,\n                                \"y\":122\n                            }\n                        ],\n                        \"prj_id\":\"2119da13-f748-4741-3858-573caddda034\"\n                    },\n                    {\n                        \"id\":\"9fc25911-3e2d-89f1-8d37-573cb73639bd\",\n                        \"name\":\"\",\n                        \"date_entered\":\"2016-05-18 18:41:36\",\n                        \"date_modified\":\"2016-05-18 18:41:36\",\n                        \"created_by\":\"1\",\n                        \"description\":\"\",\n                        \"deleted\":\"0\",\n                        \"flo_uid\":\"121706749573cb75d582c86016080199\",\n                        \"flo_type\":\"SEQUENCE\",\n                        \"flo_element_origin\":\"552527013573cb7565825f2050463919\",\n                        \"flo_element_origin_type\":\"bpmnActivity\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html"}
{"id": "4238c8026138-8", "text": "\"flo_element_origin_type\":\"bpmnActivity\",\n                        \"flo_element_origin_port\":\"0\",\n                        \"flo_element_dest\":\"282428179573cb7585826d6045140545\",\n                        \"flo_element_dest_type\":\"bpmnEvent\",\n                        \"flo_element_dest_port\":\"0\",\n                        \"flo_is_inmediate\":\"\",\n                        \"flo_condition\":\"\",\n                        \"flo_eval_priority\":\"0\",\n                        \"flo_x1\":\"282\",\n                        \"flo_y1\":\"122\",\n                        \"flo_x2\":\"349\",\n                        \"flo_y2\":\"124\",\n                        \"flo_state\":\n                        [\n                            {\n                                \"x\":282,\n                                \"y\":122\n                            },\n                            {\n                                \"x\":315,\n                                \"y\":122\n                            },\n                            {\n                                \"x\":315,\n                                \"y\":124\n                            },\n                            {\n                                \"x\":349,\n                                \"y\":124\n                            }\n                        ],\n                        \"prj_id\":\"2119da13-f748-4741-3858-573caddda034\"\n                    }\n                ]\n            }\n        ],\n        \"process_definition\":\n        {\n            \"id\":\"9f8c4fcd-8d4c-949d-50b8-573caddf8c0c\",\n            \"name\":\"\",\n            \"date_entered\":\"2016-05-18 17:58:07\",\n            \"date_modified\":\"2016-05-18 17:58:07\",\n            \"created_by\":\"1\",\n            \"description\":null,\n            \"deleted\":\"0\",\n            \"pro_module\":\"Accounts\",\n            \"pro_status\":\"INACTIVE\",\n            \"pro_locked_variables\":[],\n            \"pro_terminate_variables\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html"}
{"id": "4238c8026138-9", "text": "\"pro_locked_variables\":[],\n            \"pro_terminate_variables\":\"\",\n            \"execution_mode\":\"SYNC\"\n        },\n        \"prj_name\":\"PD_AC\",\n        \"prj_description\":null,\n        \"script_tasks\":\n        {\n            \"add_related_record\":\n            {\n               \"1\":\n                {\n                    \"value\":\"members\",\n                    \"text\":\"Accounts (Members: members)\",\n                    \"module\":\"Accounts\",\n                    \"module_label\":\"Accounts\",\n                    \"module_name\":\"Accounts\",\n                    \"relationship\":\"member_accounts\"\n                },\n                \"2\":\n                {\n                    \"value\":\"bugs\",\n                    \"text\":\"Bugs (Bugs: bugs)\",\n                    \"module\":\"Bugs\",\n                    \"module_label\":\"Bugs\",\n                    \"module_name\":\"Bugs\",\n                    \"relationship\":\"accounts_bugs\"\n                },\n                \"3\":\n                {\n                    \"value\":\"calls\",\n                    \"text\":\"Calls (Calls: calls)\",\n                    \"module\":\"Calls\",\n                    \"module_label\":\"Calls\",\n                    \"module_name\":\"Calls\",\n                    \"relationship\":\"account_calls\"\n                },\n                \"4\":\n                {\n                    \"value\":\"cases\",\n                    \"text\":\"Cases (Cases: cases)\",\n                    \"module\":\"Cases\",\n                    \"module_label\":\"Cases\",\n                    \"module_name\":\"Cases\",\n                    \"relationship\":\"account_cases\"\n                },\n                \"5\":\n                {\n                    \"value\":\"contacts\",\n                    \"text\":\"Contacts (Contacts: contacts)\",\n                    \"module\":\"Contacts\",\n                    \"module_label\":\"Contacts\",\n                    \"module_name\":\"Contacts\",\n                    \"relationship\":\"accounts_contacts\"\n                },\n                \"6\":\n                {\n                    \"value\":\"contracts\",\n                    \"text\":\"Contracts (Contracts: contracts)\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html"}
{"id": "4238c8026138-10", "text": "\"value\":\"contracts\",\n                    \"text\":\"Contracts (Contracts: contracts)\",\n                    \"module\":\"Contracts\",\n                    \"module_label\":\"Contracts\",\n                    \"module_name\":\"Contracts\",\n                    \"relationship\":\"account_contracts\"\n                },\n                \"7\":\n                {\n                    \"value\":\"documents\",\n                    \"text\":\"Documents (Documents: documents)\",\n                    \"module\":\"Documents\",\n                    \"module_label\":\"Documents\",\n                    \"module_name\":\"Documents\",\n                    \"relationship\":\"documents_accounts\"\n                },\n                \"8\":\n                {\n                    \"value\":\"leads\",\n                    \"text\":\"Leads (Leads: leads)\",\n                    \"module\":\"Leads\",\n                    \"module_label\":\"Leads\",\n                    \"module_name\":\"Leads\",\n                    \"relationship\":\"account_leads\"\n                },\n                \"9\":\n                {\n                    \"value\":\"meetings\",\n                    \"text\":\"Meetings (Meetings: meetings)\",\n                    \"module\":\"Meetings\",\n                    \"module_label\":\"Meetings\",\n                    \"module_name\":\"Meetings\",\n                    \"relationship\":\"account_meetings\"\n                },\n                \"10\":\n                {\n                    \"value\":\"notes\",\n                    \"text\":\"Notes (Notes: notes)\",\n                    \"module\":\"Notes\",\n                    \"module_label\":\"Notes\",\n                    \"module_name\":\"Notes\",\n                    \"relationship\":\"account_notes\"\n                },\n                \"11\":\n                {\n                    \"value\":\"opportunities\",\n                    \"text\":\"Opportunities (Opportunity: opportunities)\",\n                    \"module\":\"Opportunities\",\n                    \"module_label\":\"Opportunities\",\n                    \"module_name\":\"Opportunities\",\n                    \"relationship\":\"accounts_opportunities\"\n                },\n                \"12\":\n                {\n                    \"value\":\"project\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html"}
{"id": "4238c8026138-11", "text": "},\n                \"12\":\n                {\n                    \"value\":\"project\",\n                    \"text\":\"Projects (Projects: project)\",\n                    \"module\":\"Projects\",\n                    \"module_label\":\"Projects\",\n                    \"module_name\":\"Project\",\n                    \"relationship\":\"projects_accounts\"\n                },\n                \"13\":\n                {\n                    \"value\":\"products\",\n                    \"text\":\"Quoted Line Items (Products: products)\",\n                    \"module\":\"Quoted Line Items\",\n                    \"module_label\":\"Quoted Line Items\",\n                    \"module_name\":\"Products\",\n                    \"relationship\":\"products_accounts\"\n                },\n                \"14\":\n                {\n                    \"value\":\"quotes_shipto\",\n                    \"text\":\"Quotes (Quotes Ship to: quotes_shipto)\",\n                    \"module\":\"Quotes\",\n                    \"module_label\":\"Quotes\",\n                    \"module_name\":\"Quotes\",\n                    \"relationship\":\"quotes_shipto_accounts\"\n                },\n                \"15\":\n                {\n                    \"value\":\"quotes\",\n                    \"text\":\"Quotes (Quotes: quotes)\",\n                    \"module\":\"Quotes\",\n                    \"module_label\":\"Quotes\",\n                    \"module_name\":\"Quotes\",\n                    \"relationship\":\"quotes_billto_accounts\"\n                },\n                \"16\":\n                {\n                    \"value\":\"tasks\",\n                    \"text\":\"Tasks (Tasks: tasks)\",\n                    \"module\":\"Tasks\",\n                    \"module_label\":\"Tasks\",\n                    \"module_name\":\"Tasks\",\n                    \"relationship\":\"account_tasks\"\n                }\n            }\n        }\n    }\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html"}
{"id": "5ea8786fc528-0", "text": "/pmse_Project/project/:record PUT\nOverview\n    Updates the schema data from the Process Definition designer\nSummary\n    This endpoint will update the Process Definition identified by the\n    record input parameter with data provided in the request\n    payload.\nRequest Arguments\nName\nType\nDescription\nRequired\nrecord\nString\nThe Process Definition record ID\nTrue\nRequest Payload\n{\n    \"data\":\n    {\n        \"activities\":{},\n        \"gateways\":\n        {\n            \"407410601573ce3125db315056173234\":\n            {\n                \"action\":\"REMOVE\",\n                \"gat_uid\":\"407410601573ce3125db315056173234\"\n            }\n        },\n        \"events\":{},\n        \"artifacts\":{},\n        \"flows\":{},\n        \"prj_uid\":\"2119da13-f748-4741-3858-573caddda034\"\n    },\n    \"id\":\"2119da13-f748-4741-3858-573caddda034\",\n    \"operation\":\"update\",\n    \"wrapper\":\"Project\"\n}\nResponse Arguments\nName\nType\nDescription\nsuccess\nBoolean\nThe status of the update operation\nResponse\n{\n    \"success\":true\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_PUT/index.html"}
{"id": "6cc2a67fb7ee-0", "text": "/Emails/count GET\nOverview\n    Lists filtered emails.\nSummary\n    Adds additional operators to Filter API that are\n    specific to Emails. A special macro, $current_user_id, is a convenience that allows for finding emails\n    involving the current user.\nFilter By Sender\n    This will return all emails sent by the current user, by the contact whose ID is\n    fa300a0e-0ad1-b322-9601-512d0983c19a, using the email address sam@example.com, which is referenced by\n    the ID b0701501-1fab-8ae7-3942-540da93f5017, or by the lead whose ID is\n    73b1087e-4bb6-11e7-acaa-3c15c2d582c6 using the email address wally@example.com, which is referenced by\n    the ID b651d834-4bb6-11e7-bfcf-3c15c2d582c6.\n{\n  \"filter\": [{\n    \"$from\": [{\n      \"parent_type\": \"Users\",\n      \"parent_id\": \"$current_user_id\"\n    }, {\n      \"parent_type\": \"Contacts\",\n      \"parent_id\": \"fa300a0e-0ad1-b322-9601-512d0983c19a\"\n    }, {\n      \"email_address_id\": \"b0701501-1fab-8ae7-3942-540da93f5017\"\n    }, {\n      \"parent_type\": \"Leads\",\n      \"parent_id\": \"73b1087e-4bb6-11e7-acaa-3c15c2d582c6\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailscount_GET/index.html"}
{"id": "6cc2a67fb7ee-1", "text": "\"email_address_id\": \"b651d834-4bb6-11e7-bfcf-3c15c2d582c6\"\n    }]\n  }]\n}\n    Equivalent to:\n{\n  \"filter\": [{\n    \"from_collection\": {\n      \"$in\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }, {\n        \"parent_type\": \"Contacts\",\n        \"parent_id\": \"fa300a0e-0ad1-b322-9601-512d0983c19a\"\n      }, {\n        \"email_address_id\": \"b0701501-1fab-8ae7-3942-540da93f5017\"\n      }, {\n        \"parent_type\": \"Leads\",\n        \"parent_id\": \"73b1087e-4bb6-11e7-acaa-3c15c2d582c6\",\n        \"email_address_id\": \"b651d834-4bb6-11e7-bfcf-3c15c2d582c6\"\n      }]\n    }\n  }]\n}\nFilter By Recipients\n    This would return all archived emails received by the current user.\n{\n  \"filter\": [{\n    \"$or\": [{\n      \"$to\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }],\n      \"$cc\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }],\n      \"$bcc\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }]\n    }]\n  }, {\n    \"state\": {\n      \"$in\": [", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailscount_GET/index.html"}
{"id": "6cc2a67fb7ee-2", "text": "}]\n  }, {\n    \"state\": {\n      \"$in\": [\n        \"Archived\"\n      ]\n    }\n  }]\n}\n    Equivalent to:\n{\n  \"filter\": [{\n    \"$or\": [{\n      \"to_collection\": {\n        \"$in\": [{\n          \"parent_type\": \"Users\",\n          \"parent_id\": \"$current_user_id\"\n        }]\n      },\n      \"cc_collection\": {\n        \"$in\": [{\n          \"parent_type\": \"Users\",\n          \"parent_id\": \"$current_user_id\"\n        }]\n      },\n      \"bcc_collection\": {\n        \"$in\": [{\n          \"parent_type\": \"Users\",\n          \"parent_id\": \"$current_user_id\"\n        }]\n      }\n    }]\n  }, {\n    \"state\": {\n      \"$in\": [\n        \"Archived\"\n      ]\n    }\n  }]\n}\nFilter By Sender and Recipients\n    This would return all archived emails sent by a contact to the current user.\n{\n  \"filter\": [{\n    \"$from\": [{\n      \"parent_type\": \"Contacts\",\n      \"parent_id\": \"fa300a0e-0ad1-b322-9601-512d0983c19a\"\n    }]\n  }, {\n    \"$or\": [{\n      \"$to\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }],\n      \"$cc\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }],\n      \"$bcc\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }]\n    }]\n  }, {\n    \"state\": {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailscount_GET/index.html"}
{"id": "6cc2a67fb7ee-3", "text": "}]\n    }]\n  }, {\n    \"state\": {\n      \"$in\": [\n        \"Archived\"\n      ]\n    }\n  }]\n}\n    Equivalent to:\n{\n  \"filter\": [{\n    \"from_collection\": {\n      \"$in\": [{\n        \"parent_type\": \"Contacts\",\n        \"parent_id\": \"fa300a0e-0ad1-b322-9601-512d0983c19a\"\n      }]\n    }\n  }, {\n    \"$or\": [{\n      \"to_collection\": {\n        \"$in\": [{\n          \"parent_type\": \"Users\",\n          \"parent_id\": \"$current_user_id\"\n        }]\n      },\n      \"cc_collection\": {\n        \"$in\": [{\n          \"parent_type\": \"Users\",\n          \"parent_id\": \"$current_user_id\"\n        }]\n      },\n      \"bcc_collection\": {\n        \"$in\": [{\n          \"parent_type\": \"Users\",\n          \"parent_id\": \"$current_user_id\"\n        }]\n      }\n    }]\n  }, {\n    \"state\": {\n      \"$in\": [\n        \"Archived\"\n      ]\n    }\n  }]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added the $from, $to, $cc, and $bcc operators to\n            /Emails/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailscount_GET/index.html"}
{"id": "821eda6ab2a7-0", "text": "/Forecasts/reportees/:user_id GET\nForecastsApi Reportees\nSummary:\n    This endpoint is used to return the json Data for an array of users and their state for the forecasts users tree filter\nQuery Parameters:\nParam\nDescription\nOptional\nuser_id\nShow for a specific user, defaults to current user if not defined\nOptional\nlevel\nLevel of child notes, defaults to 1, -1 for all levels\nOptional\nInput Example:\n{\n    'user_id':'seed_max_id'\n}\n    \nOutput Example:\n        {\n           \"attr\":{\n              \"id\":\"jstree_node_jim\",\n              \"rel\":\"root\"\n           },\n           \"children\":[\n              {\n                 \"attr\":{\n                    \"id\":\"jstree_node_myopps_jim\",\n                    \"rel\":\"my_opportunities\"\n                 },\n                 \"children\":[\n                 ],\n                 \"data\":\"Opportunities (Jim Brennan)\",\n                 \"metadata\":{\n                    \"first_name\":\"Jim\",\n                    \"full_name\":\"Jim Brennan\",\n                    \"id\":\"seed_jim_id\",\n                    \"last_name\":\"Brennan\",\n                    \"level\":\"1\",\n                    \"reports_to_id\":\"\",\n                    \"user_name\":\"jim\"\n                 },\n                 \"state\":\"\"\n              },\n              {\n                 \"attr\":{\n                    \"id\":\"jstree_node_will\",\n                    \"rel\":\"manager\"\n                 },\n                 \"children\":[\n                 ],\n                 \"data\":\"Will Westin\",\n                 \"metadata\":{\n                    \"first_name\":\"Will\",\n                    \"full_name\":\"Will Westin\",\n                    \"id\":\"seed_will_id\",\n                    \"last_name\":\"Westin\",\n                    \"level\":\"2\",\n                    \"reports_to_id\":\"seed_jim_id\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsreporteesuser_id_GET/index.html"}
{"id": "821eda6ab2a7-1", "text": "\"level\":\"2\",\n                    \"reports_to_id\":\"seed_jim_id\",\n                    \"user_name\":\"will\"\n                 },\n                 \"state\":\"closed\"\n              },\n              {\n                 \"attr\":{\n                    \"id\":\"jstree_node_sarah\",\n                    \"rel\":\"manager\"\n                 },\n                 \"children\":[\n                 ],\n                 \"data\":\"Sarah Smith\",\n                 \"metadata\":{\n                    \"first_name\":\"Sarah\",\n                    \"full_name\":\"Sarah Smith\",\n                    \"id\":\"seed_sarah_id\",\n                    \"last_name\":\"Smith\",\n                    \"level\":\"2\",\n                    \"reports_to_id\":\"seed_jim_id\",\n                    \"user_name\":\"sarah\"\n                 },\n                 \"state\":\"closed\"\n              }\n           ],\n           \"data\":\"Jim Brennan\",\n           \"metadata\":{\n              \"first_name\":\"Jim\",\n              \"full_name\":\"Jim Brennan\",\n              \"id\":\"seed_jim_id\",\n              \"last_name\":\"Brennan\",\n              \"level\":\"1\",\n              \"reports_to_id\":\"\",\n              \"user_name\":\"jim\"\n           },\n           \"state\":\"open\"\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsreporteesuser_id_GET/index.html"}
{"id": "909f1a007234-0", "text": "/<module>/:record/link/:link_name/filter GET\nOverview\n    Lists related filtered records.\nSummary\n    This endpoint will return a set of related records filtered by an expression. The filter can be applied to multiple\n    fields and have multiple and/or conditions in it. Care will need to be taken to make sure this filter has\n    appropriate indexes on the server side otherwise the runtime of the endpoint will be very long. Related fields can\n    be searched by specifying the field name as: \"link_name.remote_field\", so if you wished to search the Accounts\n    module by a related member account you would use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. The field date_modified will always be returned. This argument\n            can be combined with the view argument.\n            \n            Example: name,account_type,description\n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilter_GET/index.html"}
{"id": "909f1a007234-1", "text": "False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilter_GET/index.html"}
{"id": "909f1a007234-2", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilter_GET/index.html"}
{"id": "909f1a007234-3", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nRepsonse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilter_GET/index.html"}
{"id": "909f1a007234-4", "text": "\"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",\n         \"full_name\":\"Dale Spivey\",\n         \"title\":\"VP Operations\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(523) 825-4311\",\n         \"email\":[\n            {\n               \"email_address\":\"sugar.dev.sugar@example.co.jp\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            },\n            {\n               \"email_address\":\"the.support@example.biz\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            }\n         ],\n         \"phone_mobile\":\"(373) 861-0757\",\n         \"phone_work\":\"(212) 542-9596\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"sugar.dev.sugar@example.co.jp\",\n         \"email2\":\"the.support@example.biz\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"345 Sugar Blvd.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"87261\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilter_GET/index.html"}
{"id": "909f1a007234-5", "text": "\"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Campaign\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"DaleSpivey97\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\\/\",\n         \"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilter_GET/index.html"}
{"id": "909f1a007234-6", "text": "\"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Florence\",\n         \"last_name\":\"Haddock\",\n         \"full_name\":\"Florence Haddock\",\n         \"title\":\"Director Sales\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(729) 845-3137\",\n         \"email\":[\n            {\n               \"email_address\":\"dev.vegan@example.de\",\n               \"opt_out\":\"1\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            },\n            {\n               \"email_address\":\"section71@example.it\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            }\n         ],\n         \"phone_mobile\":\"(246) 233-1382\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilter_GET/index.html"}
{"id": "909f1a007234-7", "text": "],\n         \"phone_mobile\":\"(246) 233-1382\",\n         \"phone_work\":\"(565) 696-6981\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"section71@example.it\",\n         \"email2\":\"dev.vegan@example.de\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"111 Silicon Valley Road\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"79900\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Support Portal User Registration\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"FlorenceHaddock169\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$nWFhTbK6$JF9BCGSqL\\/NCrbhueX5ia0\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilter_GET/index.html"}
{"id": "909f1a007234-8", "text": "\"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/link/:link_name/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilter_GET/index.html"}
{"id": "c4a476a0b466-0", "text": "/Administration/idm/users GET\nOverview\n    Lists filtered user records.\nSummary\n    This endpoint will return a set of user records with raw password hashes filtered by an expression. The filter\n    can be applied to multiple fields and have multiple and/or conditions in it. Alternatively, you may use an existing\n    filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n            Note that JSON-encoded filters can be specified as query parameters\n            in one of two ways for GET requests:\n            \n                    By specifying individual filter arguments as distinct parameters.\n                    Example: filter[0][id]=1.\n                \n                    By specifying the whole filter as a single JSON-encoded string.\n                    Note that this syntax is currently not supported on certain modules.\n                    Example: filter=[{\"id\":\"1\"}].\n                \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationidmusers_GET/index.html"}
{"id": "c4a476a0b466-1", "text": "False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. Each field may be represented either by string, or by map\n            containing field name and additional field parameters (applicable to link and collection fields).\n            The fields id and date_modified will always be returned.\n            \n            Example: name,account_type,description,{\"name\":\"opportunities\",\"fields\":[\"id\",\"name\",\"sales_status\"],\"order_by\":\"date_closed:desc\"}\n            For more details on additional field parameters, see\n            Relate API and\n            Collection API.\n        \n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \n            q\n        \n            String\n        \n            A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.\n        \n            False\n        \n            deleted\n        \n            Boolean\n        \n            Boolean to show deleted records in the result set.\n        \n            False\n        \nFilter Expressions", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationidmusers_GET/index.html"}
{"id": "c4a476a0b466-2", "text": "False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationidmusers_GET/index.html"}
{"id": "c4a476a0b466-3", "text": "$lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationidmusers_GET/index.html"}
{"id": "c4a476a0b466-4", "text": "Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n    \"next_offset\": -1,\n    \"records\": [\n        {\n            \"id\": \"1\",\n            \"user_name\": \"admin\",\n            \"user_hash\": \"$2y$10$PXY1UPZHjcm.t6ZArbia0uVzjCNEDm0XcGu/whGGk2xaPzAEKrKLa\",\n            \"system_generated_password\": false,\n            \"pwd_last_changed\": \"\",\n            \"authenticate_id\": \"\",\n            \"sugar_login\": true,\n            \"picture\": \"7772d3b4-5779-11e8-835a-6a00025a7f70\",\n            \"first_name\": \"\",\n            \"last_name\": \"Administrator\",\n            \"full_name\": \"Administrator\",\n            \"name\": \"Administrator\",\n            \"is_admin\": true,\n            \"external_auth_only\": false,\n            \"receive_notifications\": true,\n            \"description\": \"\",\n            \"date_entered\": \"2018-05-14T16:19:36+03:00\",\n            \"date_modified\": \"2018-05-14T16:27:43+03:00\",\n            \"last_login\": \"2018-05-16T12:12:43+03:00\",\n            \"modified_user_id\": \"1\",\n            \"modified_by_name\": \"\",\n            \"created_by\": \"\",\n            \"created_by_name\": \"\",\n            \"created_by_link\": {\n                \"full_name\": \"\",\n                \"id\": \"\",\n                \"_acl\": {\n                    \"fields\": [],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationidmusers_GET/index.html"}
{"id": "c4a476a0b466-5", "text": "\"id\": \"\",\n                \"_acl\": {\n                    \"fields\": [],\n                    \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n                }\n            },\n            \"title\": \"Administrator\",\n            \"department\": \"\",\n            \"phone_home\": \"\",\n            \"phone_mobile\": \"\",\n            \"phone_work\": \"\",\n            \"phone_other\": \"\",\n            \"phone_fax\": \"\",\n            \"status\": \"Active\",\n            \"address_street\": \"\",\n            \"address_city\": \"\",\n            \"address_state\": \"\",\n            \"address_country\": \"\",\n            \"address_postalcode\": \"\",\n            \"UserType\": \"\",\n            \"default_team\": \"1\",\n            \"team_count\": \"\",\n            \"team_count_link\": {\n                \"team_count\": \"\",\n                \"id\": \"\",\n                \"_acl\": {\n                    \"fields\": [],\n                    \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n                }\n            },\n            \"team_name\": [\n                {\n                    \"id\": \"1\",\n                    \"name\": \"Global\",\n                    \"name_2\": \"\",\n                    \"primary\": false,\n                    \"selected\": false\n                }\n            ],\n            \"deleted\": false,\n            \"portal_only\": false,\n            \"show_on_employees\": true,\n            \"employee_status\": \"Active\",\n            \"messenger_id\": \"\",\n            \"messenger_type\": \"\",\n            \"reports_to_id\": \"\",\n            \"reports_to_name\": \"\",\n            \"reports_to_link\": {\n                \"name\": \"\",\n                \"id\": \"\",\n                \"_acl\": {\n                    \"fields\": [],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationidmusers_GET/index.html"}
{"id": "c4a476a0b466-6", "text": "\"id\": \"\",\n                \"_acl\": {\n                    \"fields\": [],\n                    \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n                }\n            },\n            \"email1\": \"\",\n            \"email\": [\n                {\n                    \"email_address\": \"admin@ex.com\",\n                    \"primary_address\": true,\n                    \"reply_to_address\": false,\n                    \"invalid_email\": false,\n                    \"opt_out\": false,\n                    \"email_address_id\": \"93634e90-577a-11e8-a2f0-6a00025a7f70\"\n                }\n            ],\n            \"email_link_type\": \"\",\n            \"is_group\": false,\n            \"c_accept_status_fields\": \"\",\n            \"calls\": {\n                \"id\": \"\"\n            },\n            \"m_accept_status_fields\": \"\",\n            \"meetings\": {\n                \"id\": \"\"\n            },\n            \"accept_status_id\": \"\",\n            \"accept_status_name\": \"\",\n            \"accept_status_calls\": \"\",\n            \"accept_status_meetings\": \"\",\n            \"preferred_language\": \"\",\n            \"acl_role_set_id\": \"\",\n            \"my_favorite\": false,\n            \"_acl\": {\n                \"delete\": \"no\",\n                \"fields\": {\n                    \"pwd_last_changed\": {\n                        \"write\": \"no\",\n                        \"create\": \"no\"\n                    },\n                    \"last_login\": {\n                        \"write\": \"no\",\n                        \"create\": \"no\"\n                    }\n                }\n            },\n            \"_module\": \"Users\"\n        }\n    ]\n}\nChange Log\nVersion\nChange\n            v11_2\n        \n            Added /Administration/idm/users GET endpoint.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationidmusers_GET/index.html"}
{"id": "c4a476a0b466-7", "text": "Added /Administration/idm/users GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationidmusers_GET/index.html"}
{"id": "cd5f66429d5d-0", "text": "/Users/:record DELETE\nDelete a User and return its ID\nSummary:\n    This endpoint is used to delete a User. Returns the ID of the deleted User.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecord_DELETE/index.html"}
{"id": "7f7f63fc8803-0", "text": "/pmse_Inbox/case/:id/:idflow GET\nOverview\n    Retrieve information of the process record \nSummary\n    This endpoint gets information for a process record \nRequest Arguments\nName\nType\nDescription\nRequired\nid\nstring\nThe id of the process requiring action\ntrue\nidflow\nstring\nThe id of the process trigger sequence\ntrue\nResponse Arguments\nName\nType\nDescription\ncase\nobject\nProcess record\nResponse\n{\n    \"case\":\n    {\n        \"flow\":\n        {\n            \"id\":\"b2d418ba-28ef-11e6-8ae6-6c4008960436\",\n            \"name\":\"\",\n            \"date_entered\":\"2016-06-02 18:27:42\",\n            \"date_modified\":\"2016-06-02 18:27:42\",\n            \"modified_user_id\":\"1\",\n            \"created_by\":\"1\",\n            \"description\":null,\n            \"deleted\":\"0\",\n            \"cas_id\":\"3\",\n            \"cas_index\":\"3\",\n            \"pro_id\":\"6e172e2c-2842-11e6-a4bb-6c4008960436\",\n            \"cas_previous\":\"2\",\n            \"cas_reassign_level\":\"0\",\n            \"bpmn_id\":\"7c62acc2-2842-11e6-9b9c-6c4008960436\",\n            \"bpmn_type\":\"bpmnActivity\",\n            \"cas_assignment_method\":\"static\",\n            \"cas_user_id\":\"1\",\n            \"cas_thread\":\"1\",\n            \"cas_flow_status\":\"FORM\",\n            \"cas_sugar_module\":\"Accounts\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxcaseididflow_GET/index.html"}
{"id": "7f7f63fc8803-1", "text": "\"cas_flow_status\":\"FORM\",\n            \"cas_sugar_module\":\"Accounts\",\n            \"cas_sugar_object_id\":\"b2103fd0-28ef-11e6-8916-6c4008960436\",\n            \"cas_sugar_action\":\"None\",\n            \"cas_adhoc_type\":\"\",\n            \"cas_adhoc_parent_id\":\"\",\n            \"cas_adhoc_actions\":\"[\\u0022link_cancel\\u0022,\\u0022approve\\u0022,\\u0022reject\\u0022,\\u0022edit\\u0022]\",\n            \"cas_task_start_date\":null,\n            \"cas_delegate_date\":\"2016-06-02 18:27:42\",\n            \"cas_start_date\":null,\n            \"cas_finish_date\":null,\n            \"cas_due_date\":null,\n            \"cas_queue_duration\":\"0\",\n            \"cas_duration\":\"0\",\n            \"cas_delay_duration\":\"0\",\n            \"cas_started\":\"0\",\n            \"cas_finished\":\"0\",\n            \"cas_delayed\":\"0\",\n            \"assigned_user_id\":\"1\",\n            \"au_first_name\":null,\n            \"au_last_name\":\"Administrator\",\n            \"cbu_first_name\":null,\n            \"cbu_last_name\":\"Administrator\",\n            \"mbu_first_name\":null,\n            \"mbu_last_name\":\"Administrator\",\n            \"my_favorite\":null\n        },\n        \"reclaim\":false,\n        \"buttons\":\n        [\n            {\n                \"type\":\"button\",\n                \"name\":\"cancel_button\",\n                \"label\":\"Cancel\",\n                \"css_class\":\"btn-invisible btn-link\",\n                \"showOn\":\"edit\",\n                \"events\":\n                {\n                    \"click\":\"button:cancel_button:click\"\n                }\n            },\n            {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxcaseididflow_GET/index.html"}
{"id": "7f7f63fc8803-2", "text": "}\n            },\n            {\n                \"type\":\"rowaction\",\n                \"event\":\"case:approve\",\n                \"name\":\"approve_button\",\n                \"label\":\"Approve\",\n                \"css_class\":\"btn btn-success\"\n            },\n            {\n                \"type\":\"rowaction\",\n                \"event\":\"case:reject\",\n                \"name\":\"reject_button\",\n                \"label\":\"Reject\",\n                \"css_class\":\"btn btn-danger\"\n            },\n            {\n                \"type\":\"actiondropdown\",\n                \"name\":\"main_dropdown\",\n                \"primary\":true,\n                \"showOn\":\"view\",\n                \"buttons\":\n                [\n                    {\n                        \"type\":\"rowaction\", \n                        \"event\":\"button:edit_button:click\",\n                        \"name\":\"edit_button\",\n                        \"label\":\"Edit\",\n                        \"acl_action\":\"edit\"\n                    },\n                    {\n                        \"type\":\"rowaction\",\n                        \"name\":\"history\",\n                        \"label\":\"History\",\n                        \"event\":\"case:history\"\n                    },\n                    {\n                        \"type\":\"rowaction\",\n                        \"name\":\"status\",\n                        \"label\":\"Status\",\n                        \"event\":\"case:status\"\n                    },\n                    {\n                        \"type\":\"rowaction\",\n                        \"name\":\"add-notes\",\n                        \"label\":\"Show Notes\",\n                        \"event\":\"case:add:notes\"\n                    }\n                ]\n            }\n        ],\n        \"readonly\":[],\n        \"required\":[],\n        \"title\":\n        {\n            \"time\":\n            {\n                \"expected_time_warning\":false,\n                \"expected_time_message\":false,\n                \"expected_time_view\":false,\n                \"expected_time\":\"\"\n            },\n            \"process\":\"PD1\",\n            \"rec_name\":\"ABC3\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxcaseididflow_GET/index.html"}
{"id": "7f7f63fc8803-3", "text": "},\n            \"process\":\"PD1\",\n            \"rec_name\":\"ABC3\",\n            \"activity\":\"Activity # 1\"\n        },\n        \"inboxId\":\"b2b6e20e-28ef-11e6-bba8-6c4008960436\",\n        \"flowId\":\"b2d418ba-28ef-11e6-8ae6-6c4008960436\"\n    }\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxcaseididflow_GET/index.html"}
{"id": "bd5a39ebbdf1-0", "text": "/me/preferences GET\nOverview\n    Returns all the current user's stored preferences.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            \u00c2\u00a0\n        \n            \u00c2\u00a0\n        \n            \u00c2\u00a0\n        \nResponse\n{\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /me/preferences GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mepreferences_GET/index.html"}
{"id": "b899118638ab-0", "text": "/theme POST\nOverview\nUpdates the variables.less (less file containing customizable vars in the theme folder) with the set of variables passed as arguments.\nRequest Arguments\nName\nType\nDescription\nRequired\nplatform\nString\nThe theme platform - /themes/clients/***PLATFORM***/themeName/. Accepted values are 'base' and 'portal'.\nTrue\nthemeName\nString\nThe theme name - /themes/clients/platform/***THEMENAME***/.\nTrue\n<theme variable>\nString\nThe variables of the theme\nFalse\nRequest\n{\n    platform:'portal',\n    themeName:'default',\n    primary:'default',\n    secondary:'#aaaaaa',\n    primaryBtn:'#bbbbbb',\n}\nResponse Arguments\nName\nType\nDescription\n            <css path>\n        \n            String\n        \n            Returns the path of the new bootstrap.css file.\n        \nResponse\n\"http:\\/\\/sugarcrm\\/cache\\/themes\\/clients\\/base\\/default\\/6a031485bf5239b9462e4aaba72a4646.css\"\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<theme> POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/theme_POST/index.html"}
{"id": "81553d2ad35d-0", "text": "/Meetings/:record/external GET\nRetrieves info about launching an external meeting\nSummary:\n    This endpoint is used to retrieve info about launching an external meeting. This includes whether the current user\n    has permission to host and/or join the meeting along with the host/join URLs.\nQuery Parameters:\nParam\nDescription\nOptional\nThis endpoint does not accept any parameters.\nInput Example:\nOutput Example:\n        {\n            \"is_host_option_allowed\": false,\n            \"host_url\": \"\",\n            \"is_join_option_allowed\": true,\n            \"join_url\": \"//link.to/external/meeting\"\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Meetingsrecordexternal_GET/index.html"}
{"id": "8fea0d986611-0", "text": "/Reports/:record/:type GET\nOverview\nAn API to run a saved report and export the result.\nSummary\nThis endpoint will export the result of a saved report in one of the following formats: pdf, base64, csv, and json ('rows and columns' reports only).\nRequest Arguments\nName\nType\nDescription\nRequired\nrecord\nString\nID of a saved report\nTrue\nexport_type\nString\nFormat of exported data. It can be one of the following formats: pdf, base64, csv, and json. CSV and JSON export types are only currently available for 'Rows and Columns' reports.\nTrue\nRequest Example\nGET /rest/v11/Reports/:id/json\nResponse Example\n[\n    {\n        \"Contact ID\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n        \"First Name\":\"Dale\",\n        \"Last Name\":\"Arvizu\",\n        \"Email Address\":\"vegan.sugar.support@example.co.uk\",\n        \"Account Name\":\"DD Furniture Inc\"\n    },\n    {\n        \"Contact ID\":\"71c773ce-980e-11eb-8f85-f45c898a3ce7\",\n        \"First Name\":\"Isis\",\n        \"Last Name\":\"Arvizu\",\n        \"Email Address\":\"im38@example.info\",\n        \"Account Name\":\"J.K.M. Corp (HA)\"\n    },\n]\n\u00c2\u00a0\nChange Log\nVersion\nChange\nv11.13\nAdded\u00c2\u00a0csv and json\u00c2\u00a0formats.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Reportsrecordtype_GET/index.html"}
{"id": "3aa3ed7581c3-0", "text": "/<module>/:record/link/related_activities GET\nOverview\nReturns related activity records for a specified record.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule_list\nString\nA list of modules from the valid modules [Tasks, Calls, Emails, Notes, Meetings] that need to be included.Example:Meetings,Calls,Emails,Notes\nFalse\norder_by\nString\nHow to sort the returned records, in a comma-delimited list with the direction appended to the column name after a colon. Example:\u00c2\u00a0name:DESC,account_type:DESC,date_modified:ASC\nFalse\nmax_num\nString\nA maximum number of records to return. Default is 20.\nFalse\noffset\nInteger\nThe number of records to skip over before records are returned. Default is 0.\nFalse\ndeleted\nBoolean\nBoolean to show deleted records in the result set. Default is false.\nFalse\nalias_fields\nArray\nA list of field aliases from the valid modules [Tasks, Calls, Emails, Notes, Meetings] that need to be fetched. These field aliases can also be used in 'order_by'. Example:\u00c2\u00a0{ 'record_date': { 'Calls': 'date_start', 'Emails': 'date_sent' } }\nFalse\nResponse Arguments\nName\nType\nDescription\nnext_offset\nInteger\nDisplays the next offset for retrieval of additional results. -1 will be returned when there are no more records.\nrecords\nArray\nAn array of results containing matched records.\nResponse\n{\nnext_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"2f9abe52-f03f-11e9-858c-3c15c2d57622\",\n         \"name\":\"test call\",\n         \"date_entered\":\"2019-10-16T11:02:57-07:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkrelated_activities_GET/index.html"}
{"id": "3aa3ed7581c3-1", "text": "\"date_modified\":\"2019-10-16T11:02:57-07:00\",\n         \"description\":\"\",\n         \"date_start\":\"2019-10-25T11:30:00-07:00\",\n         \"status\":\"Planned\",\n         \"contact_name\":\"\",\n         \"contacts\":{\n            \"name\":\"\",\n            \"id\":\"\",\n            \"_acl\":{\n               \"fields\":[\n               ],\n               \"_hash\":\"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n         },\n         \"contact_id\":\"\",\n         \"locked_fields\":[\n         ],\n         \"assigned_user_id\":\"1\",\n         \"assigned_user_name\":\"Administrator\",\n         \"assigned_user_link\":{\n            \"full_name\":\"Administrator\",\n            \"id\":\"1\",\n            \"_acl\":{\n               \"fields\":{\n                  \"pwd_last_changed\":{\n                     \"write\":\"no\",\n                     \"create\":\"no\"\n                  },\n                  \"last_login\":{\n                     \"write\":\"no\",\n                     \"create\":\"no\"\n                  }\n               },\n               \"delete\":\"no\",\n               \"_hash\":\"08b99a97c2e8d792f7a44d8882b5af6d\"\n            }\n         },\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Calls\",\n         \"moduleNameSingular\":\"Call\",\n         \"moduleName\":\"Calls\"\n      },\n   ]\n}\nChange Log\nVersion\nChange\nv11.7\nAdded /<module>/:record/link/related_activities GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkrelated_activities_GET/index.html"}
{"id": "b4fc6c75d11e-0", "text": "/TimePeriods GET\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n            Note that JSON-encoded filters can be specified as query parameters\n            in one of two ways for GET requests:\n            \n                    By specifying individual filter arguments as distinct parameters.\n                    Example: filter[0][id]=1.\n                \n                    By specifying the whole filter as a single JSON-encoded string.\n                    Note that this syntax is currently not supported on certain modules.\n                    Example: filter=[{\"id\":\"1\"}].\n                \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriods_GET/index.html"}
{"id": "b4fc6c75d11e-1", "text": "False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. Each field may be represented either by string, or by map\n            containing field name and additional field parameters (applicable to link and collection fields).\n            The fields id and date_modified will always be returned.\n            \n            Example: name,account_type,description,{\"name\":\"opportunities\",\"fields\":[\"id\",\"name\",\"sales_status\"],\"order_by\":\"date_closed:desc\"}\n            For more details on additional field parameters, see\n            Relate API and\n            Collection API.\n        \n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \n            q\n        \n            String\n        \n            A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.\n        \n            False\n        \n            deleted\n        \n            Boolean\n        \n            Boolean to show deleted records in the result set.\n        \n            False\n        \n            nulls_last\n        \n            Boolean", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriods_GET/index.html"}
{"id": "b4fc6c75d11e-2", "text": "False\n        \n            nulls_last\n        \n            Boolean\n        \n            Boolean to return records with null values in order_by fields last in the result set.\n        \n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\nExample\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriods_GET/index.html"}
{"id": "b4fc6c75d11e-3", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriods_GET/index.html"}
{"id": "b4fc6c75d11e-4", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\",\n               \"id\": \"b0701501-1fab-8ae7-3942-540da93f5017\",\n               \"name\": \"360 Vacations - 228 Units\",\n               \"date_modified\": \"2014-09-08T16:05:00+03:00\",\n               \"sales_status\": \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriods_GET/index.html"}
{"id": "b4fc6c75d11e-5", "text": "{\n               _module: \"Opportunities\"\n               date_modified: \"2014-09-08T16:05:00+03:00\"\n               id: \"9ce7c088-8ee4-7cd3-18f1-540da944d4c0\"\n               name: \"360 Vacations - 312 Units\"\n               sales_status: \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriods_GET/index.html"}
{"id": "9bd41b44fa96-0", "text": "/bulk POST\nOverview\n    Run API calls in bulk.\nSummary\n    This request will run a sequence of API requests within one query. The requests are executed sequentially and their results\n    are returned as one response. Some requests may return failure code, that does not interrupt the execution of the batch, \n    and the overall request will still be considered successful. \nRequest Arguments\nName\nType\nDescription\nRequired\n            requests\n        \n            Array\n        \n            The list of requests\n        \n            True\n        \nEach of the requests can have the following fields:\nName\nType\nDescription\nRequired\n            url\n        \n            String\n        \n            The request URL, starting with version.\n        \n            True\n        \n            data\n        \n            JSON String\n        \n            The data for the POST/PUT body. Must be a JSON-encoded string.\n        \n            False\n        \n            headers\n        \n            Array\n        \n            The request headers\n        \n            False\n        \n            method\n        \n            String\n        \n            The HTTP method (default is GET)\n        \n            False\n        \nRequest Example\n{\"requests\":\n[\n  {\n    \"url\": \"/v10/Accounts\", \"method\": \"POST\", \"data\": \"{\\\"name\\\": \\\"test123\\\"}\"\n  },\n  {\n    \"url\": \"/v10/Accounts\", \"method\": \"GET\"\n  }\n]\n}\nResponse\nThe response will contain an array of response objects, each of them will correspond to the individual request. The following fields are in the response objects:\nName\nType\nDescription\n            contents\n        \n            Array or String\n        \n            The response contents, can be JSON object or string depending on what the individual request is supposed to return. \n        \n            headers\n        \n            Array", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/bulk_POST/index.html"}
{"id": "9bd41b44fa96-1", "text": "headers\n        \n            Array\n        \n            The response headers \n        \n            status\n        \n            Integer\n        \n            HTTP status code of the response. Will be 2XX for successful requests and 4XX or 5XX for errors. \n        \nResponse Example\n[\n    {\n        \"contents\": {\n            \"my_favorite\": false,\n            \"following\": true,\n            \"id\": \"7d2e21a6-8a76-a74f-bb53-535620211304\",\n            \"name\": \"test123\",\n            \"date_entered\": \"2014-04-22T03:56:24-04:00\",\n            \"_module\": \"Accounts\"\n        },\n        \"headers\": [],\n        \"status\": 200\n    },\n    {\n        \"contents\": {\n            \"next_offset\": -1,\n            \"records\": [\n                {\n                    \"my_favorite\": false,\n                    \"following\": true,\n                    \"id\": \"7d2e21a6-8a76-a74f-bb53-535620211304\",\n                    \"name\": \"test123\",\n                    \"date_entered\": \"2014-04-22T03:56:24-04:00\",\n                    \"date_modified\": \"2014-04-22T03:56:24-04:00\",\n\t\t\t\t}\n            ]\n        },\n        \"headers\": [],\n        \"status\": null\n    }\n]\nChange Log\nVersion\nChange\n            v10\n        \n            Added /bulk POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/bulk_POST/index.html"}
{"id": "3c3cba9ffbfe-0", "text": "/Administration/search/fields GET\nOverview\n    [ADMIN] Search field configuration\nSummary\n    This endpoint lists the full text search configuration of all fields for the full text search enabled modules. This\n    endpoint is only available to administrators.\nRequest Arguments\nName\nType\nDescription\nRequired\n            module_list\n        \n            String\n        \n            Comma delimited list of modules to return. If omitted, all search enabled modules will be returned.\n            \n            Example: Accounts,Contacts\n            False\n        \n            search_only\n        \n            Boolean\n        \n            When set, only searchable fields are returned. Defaults to false.\n        \n            False\n        \n            order_by_boost\n        \n            Boolean\n        \n            When set, a flat list of searchable fields is returned ordered by boost value.\n        \n            False\n        \nResponse\n{\n    \"Accounts\":{\n        \"name\":{\n            \"name\":\"name\",\n            \"type\":\"name\",\n            \"searchable\":true,\n            \"boost\":1\n        },\n        \"date_modified\":{\n            \"name\":\"date_modified\",\n            \"type\":\"datetime\",\n            \"searchable\":false\n        }\n    }\n}\nResponse using order_by_boost\n{\n    \"Quotes.quote_num\":1.5,\n    \"Manufacturers.name\":1,\n    \"Bugs.name\":0.9,\n    \"ProjectTask.name\":0.5,\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Administration/search/fields GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationsearchfields_GET/index.html"}
{"id": "075bfc44be78-0", "text": "/Dashboards/:id/restore-metadata PUT\nOverview\nRestores the metadata for a module's dashboard to the default metadata.\nSummary\nThis endpoint is used to restore the default metadata for a module's dashboard.\nRequest Arguments\nName\nType\nDescription\nRequired\ndashboard_module\nstring\nThe module dashboard belongs to (e.g. Home, Cases, Accounts)\nTrue\ndashboard\nstring\nThe dashboard name (e.g. portal-home)\nTrue\nRequest\n{\n    \"dashboard_module\":\"Home\",\n    \"dashboard\":\"portal-home\"\n}\n\u00c2\u00a0\nResponse Example\n{\n    \"id\":\"123\",\n    \"name\":\"LBL_PORTAL_HOME\",\n    \"dashboard_module\": \"Home\",\n    \"view_name\": \"home\",\n    \"metadata\": {\n        \"css_class\": \"portal-home-dashboard\"\n        \"components\": {...},\n    },\n    ...\n}\nChange Log\nVersion\nChange\nv11.13\nAdded\u00c2\u00a0/Dashboards/<id>/restore-metadata\u00c2\u00a0PUT endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboardsidrestoremetadata_PUT/index.html"}
{"id": "002a47b075cc-0", "text": "/<module>/:record/children GET\nOverview\n    Retrieves all children of selected record.\nRequest Arguments\nName\nType\nDescription\nRequired\n                module\n            \n                String\n            \n                The name of sugar module that contains a nested set data and implements the NestedSetInterface.\n            \n                True\n            \n                :record\n            \n                String\n            \n                The ID of record\n            \n                True\n            \nResponse Arguments\n    This endpoint does not return any response arguments.\nResponse\n[{\n    \"id\": \"045c1de6-327b-11e4-818b-5404a67f3363\",\n    \"name\": \"Financial\",\n    \"date_entered\": null,\n    \"date_modified\": null,\n    \"modified_user_id\": null,\n    \"created_by\": null,\n    \"description\": null,\n    \"deleted\": \"0\",\n    \"source_id\": null,\n    \"source_type\": null,\n    \"source_meta\": null,\n    \"root\": \"935d3e07-327a-11e4-818b-5404a67f3363\",\n    \"lft\": \"11\",\n    \"rgt\": \"14\",\n    \"level\": \"2\"\n}, {\n    \"id\": \"0f65a6c7-327b-11e4-818b-5404a67f3363\",\n    \"name\": \"Agreements\",\n    \"date_entered\": null,\n    \"date_modified\": null,\n    \"modified_user_id\": null,\n    \"created_by\": null,\n    \"description\": null,\n    \"deleted\": \"0\",\n    \"source_id\": null,\n    \"source_type\": null,\n    \"source_meta\": null,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordchildren_GET/index.html"}
{"id": "002a47b075cc-1", "text": "\"source_type\": null,\n    \"source_meta\": null,\n    \"root\": \"935d3e07-327a-11e4-818b-5404a67f3363\",\n    \"lft\": \"15\",\n    \"rgt\": \"16\",\n    \"level\": \"2\"\n}, {\n    \"id\": \"14d30bf3-327b-11e4-818b-5404a67f3363\",\n    \"name\": \"Clients\",\n    \"date_entered\": null,\n    \"date_modified\": null,\n    \"modified_user_id\": null,\n    \"created_by\": null,\n    \"description\": null,\n    \"deleted\": \"0\",\n    \"source_id\": null,\n    \"source_type\": null,\n    \"source_meta\": null,\n    \"root\": \"935d3e07-327a-11e4-818b-5404a67f3363\",\n    \"lft\": \"17\",\n    \"rgt\": \"18\",\n    \"level\": \"2\"\n}]\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/children GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordchildren_GET/index.html"}
{"id": "c8d2f450f93c-0", "text": "/connectors GET\nOverview\n    Gets general info about connectors.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResult Arguments\nResponse\n{\n    \"connectors\": {\n        \"ext_rest_twitter\": {\n            \"testing_enabled\": true,\n            \"test_passed\": false,\n            \"eapm_bean\": false,\n            \"field_mapping\": {\n                \"beans\": {\n                    \"Accounts\": {\n                        \"name\": \"name\",\n                        \"id\": \"id\"\n                    },\n                    \"Contacts\": {\n                        \"name\": \"full_name\",\n                        \"id\": \"id\"\n                    },\n                    \"Leads\": {\n                        \"name\": \"account_name\",\n                        \"id\": \"id\"\n                    },\n                    \"Prospects\": {\n                        \"name\": \"account_name\",\n                        \"id\": \"id\"\n                    }\n                }\n            },\n            \"id\": \"ext_rest_twitter\",\n            \"name\": \"Twitter\"\n        },\n        \"ext_eapm_google\": {\n            \"testing_enabled\": false,\n            \"test_passed\": false,\n            \"eapm_bean\": false,\n            \"field_mapping\": [],\n            \"id\": \"ext_eapm_google\",\n            \"name\": \"Google\"\n        },\n        \"ext_eapm_gotomeeting\": {\n            \"testing_enabled\": false,\n            \"test_passed\": false,\n            \"eapm_bean\": false,\n            \"field_mapping\": [],\n            \"id\": \"ext_eapm_gotomeeting\",\n            \"name\": \"GoToMeeting\"\n        },\n        \"ext_eapm_ibmsmartcloud\": {\n            \"testing_enabled\": false,\n            \"test_passed\": false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectors_GET/index.html"}
{"id": "c8d2f450f93c-1", "text": "\"testing_enabled\": false,\n            \"test_passed\": false,\n            \"eapm_bean\": false,\n            \"field_mapping\": [],\n            \"id\": \"ext_eapm_ibmsmartcloud\",\n            \"name\": \"IBM SmartCloud\"\n        },\n        \"ext_eapm_webex\": {\n            \"testing_enabled\": false,\n            \"test_passed\": false,\n            \"eapm_bean\": false,\n            \"field_mapping\": [],\n            \"id\": \"ext_eapm_webex\",\n            \"name\": \"WebEx\"\n        },\n        \"ext_eapm_lotuslive\": {\n            \"testing_enabled\": false,\n            \"test_passed\": false,\n            \"eapm_bean\": false,\n            \"field_mapping\": [],\n            \"id\": \"ext_eapm_lotuslive\",\n            \"name\": \"LotusLive\"\n        },\n        \"ext_rest_dnb\": {\n            \"testing_enabled\": false,\n            \"test_passed\": false,\n            \"eapm_bean\": false,\n            \"field_mapping\": {\n                \"beans\": {\n                    \"Accounts\": {\n                        \"name\": \"name\",\n                        \"id\": \"id\"\n                    }\n                }\n            },\n            \"id\": \"ext_rest_dnb\",\n            \"name\": \"DNB\"\n        },\n        \"_hash\": \"\\u0000d4751e1632fd5d1d2c9069a1f176e6f\"\n    },\n    \"_hash\": \"2cd9132603ead4f79715c69ee98e64f1\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<connectors> GET endpoint.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectors_GET/index.html"}
{"id": "c8d2f450f93c-2", "text": "v10\n        \n            Added /<connectors> GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectors_GET/index.html"}
{"id": "f529c114656e-0", "text": "/Administration/aws GET\nOverview\n[ADMIN] Gets Amazon Web Services configs from Sugar Serve.\nSummary\nThis endpoint gets configuration values for Amazon Web Services. This endpoint is only available to administrators of Sugar Serve.\nRequest Arguments\nThis endpoint does not accept any arguments.\nResponse\n{\n    \"aws_connect_instance_name\": \"my-aws-instance\",\n    \"aws_connect_region\": \"us-east-2\"\n}\nChange Log\nVersion\nChange\nv11_10\nAdded /Administration/aws\u00c2\u00a0GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationaws_GET/index.html"}
{"id": "980b3f60cc61-0", "text": "/Dashboards GET\nOverview\n    List current user's filtered Home dashboards.\nSummary\n    This endpoint will return a set of Home dashboards filtered by an expression. The filter can be applied to multiple\n    fields and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its\n    id. If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long.\nNotice\nThe behavior of this endpoint has changed in v11. For a description of behavior in v11, refer to\n    GET /<module>. If you continue to use v10 of the API,\n    your REST calls should behave as before. But, it is advisable to upgrade to v11. Slight differences exist in\n    the GET method of v10 vs v11.Migrating to v11:\n    Recommended Replacement:\nGET /Dashboards\n    The Home module is no longer the default dashboard_module. To get the Home module\n    dashboard, include the following filter parameter.v11: \nGET /Dashboards?filter[0][dashboard_module]=Home\n    name, id. etc. are no longer specified as default fields. To retain the default fields, usev11: \nGET /Dashboards?filter[0][dashboard_module]=Home&fields=id,name,view_name\nRequest Arguments\nName\nType\nDescription\nRequired\nfilter\nString\nSee Filter API.\nFalse\nfilter_id\nString\n            Identifier for a preexisting filter. See \n            the Filter API for details.\n        \nFalse\nmax_num\nInteger\n            Max number of records that can be returned. Default is 20, unless overruled by your Sugar configuration.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboards_GET/index.html"}
{"id": "980b3f60cc61-1", "text": "False\noffset\nInteger\nThe number of records to skip over before records are returned. Default is 0.\nFalse\nfields\nString\n            Comma delimited list of fields to return. Each field may be represented either by string, or by map\n            containing field name and additional field parameters (applicable to link and collection fields).\n            The fields id and date_modified will always be returned.\n            For more details on additional field parameters, see\n            Relate API and\n            Collection API.\n        \nFalse\norder_by\nString\nSee Filter API.\nFalse\ndeleted\nBoolean\nBoolean to show deleted records in the result set.\nFalse\nResponse Arguments\nName\nType\nDescription\nnext_offset\nInteger\n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \nrecords\nArray\nAn array of results containing matched records.\nResponse\n{\n  \"next_offset\": -1,\n  \"records\": [\n    {\n      \"id\": \"c630c772-faca-2051-6a42-56fab2e73e42\",\n      \"name\": \"New Home Dashboard\",\n      \"date_modified\": \"2016-03-29T09:49:06-07:00\",\n      \"view_name\": \"\",\n      \"_acl\": {\n        \"fields\": {}\n      },\n      \"view\": \"\",\n      \"_module\": \"Dashboards\"\n    },\n    {\n      \"id\": \"15677f2c-f00d-c59a-6fbe-56fab1f33732\",\n      \"name\": \"Home Dashboard2\",\n      \"date_modified\": \"2016-03-29T09:47:25-07:00\",\n      \"view_name\": \"\",\n      \"_acl\": {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboards_GET/index.html"}
{"id": "980b3f60cc61-2", "text": "\"view_name\": \"\",\n      \"_acl\": {\n        \"fields\": {}\n      },\n      \"view\": \"\",\n      \"_module\": \"Dashboards\"\n    },\n    {\n      \"id\": \"d509b3da-29f6-7b23-7cce-56fab1a6335b\",\n      \"name\": \"Accounts Dashboard\",\n      \"date_modified\": \"2016-03-29T09:46:00-07:00\",\n      \"view_name\": \"records\",\n      \"_acl\": {\n        \"fields\": {}\n      },\n      \"view\": \"records\",\n      \"_module\": \"Dashboards\"\n    },\n    {\n      \"id\": \"cc4982cd-0bdf-bad4-d079-56fab4bdddf1\",\n      \"name\": \"Activity Stream Dashboard\",\n      \"date_modified\": \"2016-03-29T09:57:58-07:00\",\n      \"view_name\": \"activities\",\n      \"_acl\": {\n        \"fields\": {}\n      },\n      \"view\": \"activities\",\n      \"_module\": \"Dashboards\"\n    }\n  ]\n}\nChange Log\nVersion\nChange\nv11\n            Behavior has changed. Please see GET /Dashboards\n            for the designated replacement.\n        \nv10\nAdded /Dashboards GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboards_GET/index.html"}
{"id": "6dcd3d280ea5-0", "text": "/Emails/:record/link/:link_name/:remote_id POST\nOverview\n    Creates a relationship to a pre-existing email.\nSummary\n    Cannot link existing Notes records as attachments (link: attachments) and existing EmailParticipants records\n    as a sender (link: from) or recipients(links: to, cc, bcc). All other operations\n    described in Relate Record API are supported.\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Emails/:record/link/:link_name/:remote_id POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecordlinklink_nameremote_id_POST/index.html"}
{"id": "40f07dc83c06-0", "text": "/ProductTemplates/tree POST\nProductTemplate API\nSummary:\n    This endpoint is designed to return a paged recordset of one level of product templates and product categories in\n    a N-level deep tree representing the relationship between categories and templates.  The results are loosely\n    filtered (wildcard before and after).\nQuery Parameters:\nParam\nDescription\nOptional\nfilter\nThe filter used to search Product Template and Product Category names.  %filter% \ntrue\nroot\nThe ID of the root node you wish to retrieve.  Defaults to null (the root level)\ntrue\noffset\nSpecifies the numeric value of the offset you wish to retrieve\ntrue\nmax_num\nSpecifies the numeric value of the max number of records you wish to receive. Default is 20.\ntrue\nResponse Parameters:\nParam\nDescription\nid\nThe id of the item (Product Category/Template) \nData\nThe name of the item\nstate\nSpecifies the open or closed state of the element. (used for categories)\nindex\nSpecifies the index of this element in the current level.\nResponse:\n        { \n            \"records\":[\n                {\n                    \"id\":\"023d316a-d9d0-11e7-9f54-02425392a518\",\n                    \"type\":\"category\",\n                    \"data\":\"Christen Widgets\",\n                    \"state\":\"closed\",\n                    \"index\":0\n                },\n                {\n                    \"id\":\"01828a4a-d9d0-11e7-8989-02425392a518\",\n                    \"type\":\"category\",\n                    \"data\":\"Desktops\",\n                    \"state\":\"closed\",\n                    \"index\":1\n                }\n            ],\n            \"next_offset\":2\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ProductTemplatestree_POST/index.html"}
{"id": "10b34bdee14a-0", "text": "/Users/:record/link/:link_name/:remote_id POST\nOverview\n    Creates a relationship to a pre-existing record.\nQuery String Parameters\n    This endpoint does not accept any arguments.\nResponse Arguments\nName\nType\nDescription\n            record\n        \n            Array\n        \n            The record linked to the related record.\n        \n            related_record\n        \n            Array\n        \n            The record that was associated.\n        \nResponse\n{\n   \"record\":{\n      \"id\":\"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n      \"name\":\"Slender Broadband Inc - 1000 units\",\n      \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n      \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n      \"modified_user_id\":\"1\",\n      \"modified_by_name\":\"Administrator\",\n      \"created_by\":\"1\",\n      \"created_by_name\":\"Administrator\",\n      \"description\":\"\",\n      \"img\":\"\",\n      \"last_activity_date\":\"2013-02-28T18:21:00+00:00\",\n      \"deleted\":false,\n      \"assigned_user_id\":\"seed_max_id\",\n      \"assigned_user_name\":\"Max Jensen\",\n      \"team_name\":[\n         {\n            \"id\":\"East\",\n            \"name\":\"East\",\n            \"name_2\":\"\",\n            \"primary\":false\n         },\n         {\n            \"id\":\"West\",\n            \"name\":\"West\",\n            \"name_2\":\"\",\n            \"primary\":true\n         }\n      ],\n      \"opportunity_type\":\"\",\n      \"account_name\":\"Slender Broadband Inc\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_POST/index.html"}
{"id": "10b34bdee14a-1", "text": "\"opportunity_type\":\"\",\n      \"account_name\":\"Slender Broadband Inc\",\n      \"account_id\":\"181461c6-dc81-1115-1fe0-512d092e8f15\",\n      \"campaign_id\":\"\",\n      \"campaign_name\":\"\",\n      \"lead_source\":\"Campaign\",\n      \"amount\":\"25000\",\n      \"base_rate\":\"1\",\n      \"amount_usdollar\":\"25000\",\n      \"currency_id\":\"-99\",\n      \"currency_name\":\"\",\n      \"currency_symbol\":\"\",\n      \"date_closed\":\"2013-02-27\",\n      \"date_closed_timestamp\":\"1361992480\",\n      \"next_step\":\"\",\n      \"sales_stage\":\"Needs Analysis\",\n      \"sales_status\":\"New\",\n      \"probability\":\"90\",\n      \"best_case\":\"25000\",\n      \"worst_case\":\"25000\",\n      \"commit_stage\":\"include\",\n      \"my_favorite\":false,\n      \"_acl\":{\n         \"fields\":{\n         }\n      }\n   },\n   \"related_record\":{\n      \"id\":\"e689173e-c953-1e14-c215-512d0927e7a2\",\n      \"name\":\"Gus Dales\",\n      \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n      \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n      \"modified_user_id\":\"1\",\n      \"modified_by_name\":\"Administrator\",\n      \"created_by\":\"1\",\n      \"created_by_name\":\"Administrator\",\n      \"description\":\"\",\n      \"img\":\"\",\n      \"deleted\":false,\n      \"assigned_user_id\":\"seed_sally_id\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_POST/index.html"}
{"id": "10b34bdee14a-2", "text": "\"deleted\":false,\n      \"assigned_user_id\":\"seed_sally_id\",\n      \"assigned_user_name\":\"Sally Bronsen\",\n      \"team_name\":[\n         {\n            \"id\":\"West\",\n            \"name\":\"West\",\n            \"name_2\":\"\",\n            \"primary\":true\n         }\n      ],\n      \"salutation\":\"\",\n      \"first_name\":\"Gus\",\n      \"last_name\":\"Dales\",\n      \"full_name\":\"Gus Dales\",\n      \"title\":\"Director Operations\",\n      \"linkedin\":\"\",\n      \"facebook\":\"\",\n      \"twitter\":\"\",\n      \"googleplus\":\"\",\n      \"department\":\"\",\n      \"do_not_call\":false,\n      \"phone_home\":\"(661) 120-2292\",\n      \"email\":[\n         {\n            \"email_address\":\"section.sugar.section@example.it\",\n            \"opt_out\":\"1\",\n            \"invalid_email\":\"0\",\n            \"primary_address\":\"0\"\n         },\n         {\n            \"email_address\":\"support.qa.kid@example.co.uk\",\n            \"opt_out\":\"0\",\n            \"invalid_email\":\"0\",\n            \"primary_address\":\"1\"\n         }\n      ],\n      \"phone_mobile\":\"(294) 447-9707\",\n      \"phone_work\":\"(036) 840-3216\",\n      \"phone_other\":\"\",\n      \"phone_fax\":\"\",\n      \"email1\":\"support.qa.kid@example.co.uk\",\n      \"email2\":\"section.sugar.section@example.it\",\n      \"invalid_email\":false,\n      \"email_opt_out\":false,\n      \"primary_address_street\":\"48920 San Carlos Ave\",\n      \"primary_address_street_2\":\"\",\n      \"primary_address_street_3\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_POST/index.html"}
{"id": "10b34bdee14a-3", "text": "\"primary_address_street_2\":\"\",\n      \"primary_address_street_3\":\"\",\n      \"primary_address_city\":\"Persistance\",\n      \"primary_address_state\":\"CA\",\n      \"primary_address_postalcode\":\"54556\",\n      \"primary_address_country\":\"USA\",\n      \"alt_address_street\":\"\",\n      \"alt_address_street_2\":\"\",\n      \"alt_address_street_3\":\"\",\n      \"alt_address_city\":\"\",\n      \"alt_address_state\":\"\",\n      \"alt_address_postalcode\":\"\",\n      \"alt_address_country\":\"\",\n      \"assistant\":\"\",\n      \"assistant_phone\":\"\",\n      \"picture\":\"\",\n      \"email_and_name1\":\"\",\n      \"lead_source\":\"Support Portal User Registration\",\n      \"account_name\":\"Arts & Crafts Inc\",\n      \"account_id\":\"d43243c6-9b8e-2973-aee2-512d09bc34b4\",\n      \"opportunity_role_fields\":\"\",\n      \"opportunity_role_id\":\"\",\n      \"opportunity_role\":\"Technical Advisor\",\n      \"reports_to_id\":\"\",\n      \"report_to_name\":\"\",\n      \"portal_name\":\"GusDales145\",\n      \"portal_active\":true,\n      \"portal_password\":\"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0\",\n      \"portal_password1\":\"\",\n      \"portal_app\":\"\",\n      \"preferred_language\":\"en_us\",\n      \"campaign_id\":\"\",\n      \"campaign_name\":\"\",\n      \"c_accept_status_fields\":\"\",\n      \"m_accept_status_fields\":\"\",\n      \"accept_status_id\":\"\",\n      \"accept_status_name\":\"\",\n      \"sync_contact\":\"\",\n      \"my_favorite\":false,\n      \"_acl\":{\n         \"fields\":{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_POST/index.html"}
{"id": "10b34bdee14a-4", "text": "\"my_favorite\":false,\n      \"_acl\":{\n         \"fields\":{\n         }\n      }\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/link/:link_name/:remote_id POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_POST/index.html"}
{"id": "8c642322a399-0", "text": "/Leads/:record/freebusy GET\n    Get a lead's FreeBusy schedule\nSummary:\n    This endpoint returns a list of time slots for which the specified person is busy.\nRequest\n        GET /Leads/:id/freebusy\n    \nResponse\n    {\n      \"id\": \"foo\"\n      \"module\": \"Users\",\n      \"freebusy\": [\n                    {\n                      \"start\": \"2014-08-24T08:45:00-04:00\",\n                      \"end\": \"2014-08-24T09:15:00-04:00\"\n                    },\n                    {\n                      \"start\": \"2014-08-30T05:45:00-04:00\",\n                      \"end\": \"2014-08-30T06:15:00-04:00\"\n                    },\n                    {\n                      \"start\": \"2014-09-12T15:45:00-04:00\",\n                      \"end\": \"2014-09-12T16:15:00-04:00\"\n                    }\n                  ]\n    }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Leadsrecordfreebusy_GET/index.html"}
{"id": "5372575bd2c7-0", "text": "/collection/:collection_name GET\nOverview\n    Lists records from multiple modules at a time.\nSummary\n    This endpoint will return a set of records fetched from multiple modules defined by :collection_name.\n    The records will be filtered, sorted and truncated to max_num as a single collection.\n    Collections may use a field mapping. For instance, the due_date of Tasks may be referred to as date_end.\n    In this case the alias (date_end) should be used in filter and order_by expressions instead of real field name.\n    Note that response data still contains the original fields for the module.\nRequest Arguments\nName\nType\nDescription\nRequired\nfields\nString\n            See Filter API. If the collection definition uses aliases, then aliases should be used instead of real field names.\n        \nFalse\nmax_num\nInteger\n            See Filter API.\n        \nFalse\nfilter\nString\n            See Filter API. If collection definition uses aliases, then aliases should be used instead of real field names.\n        \nFalse\norder_by\nString\n            See Filter API. If collection definition uses aliases, then aliases should be used instead of real field names.\n        \nFalse\noffset\nMap\n            Individual offset for each module which the collection consists of.\n            -1 (or any negative value) denotes that the module should be skipped.\n            If module offset is not specified, it defaults to 0.\n        \nFalse\nResponse Arguments\nName\nType\nDescription\nnext_offset\nMap\n            The next offset to retrieve records. -1 will be returned for the given module when there are no more records.\n        \nrecords\nArray\nThe record result set.\nResponse\n{\n   \"next_offset\": {\n      \"Calls\": 1,\n      \"Meetings\": -1,\n      \"Tasks\": -2,\n   },\n   \"records\": [\n      {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/collectioncollection_name_GET/index.html"}
{"id": "5372575bd2c7-1", "text": "\"Tasks\": -2,\n   },\n   \"records\": [\n      {\n         \"_module\": \"Calls\",\n         \"id\": \"8703fbf3-0ffa-c288-8d2c-512f943ecdc3\",\n         \"name\": \"Discuss review process\",\n         \"date_end\": \"2014-02-26T19:12:00+00:00\"\n      },\n      {\n         \"_module\": \"Tasks\",\n         \"id\": \"e1c495cb-af17-1b37-dd66-512f934fe155\",\n         \"name\": \"Introduce all players\",\n         \"due_date\": \"2014-02-26T19:12:00+00:00\"\n      },\n      {\n         \"_module\": \"Tasks\",\n         \"id\": \"456b7848-9959-5a64-cd34-512d0938addd\",\n         \"name\": \"Follow-up on proposal\",\n         \"due_date\": \"2014-02-26T19:12:00+00:00\"\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /collection/:collection_name GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/collectioncollection_name_GET/index.html"}
{"id": "a5563950a776-0", "text": "/Forecasts/:timeperiod_id/quotas/direct/:user_id GET\nForecastsQuotasApi - Get\nSummary:\n    This endpoint is used to return quota information for a specific user ID, in a specific timeperiod and by a specifc type..\nQuery Parameters:\nParam\nDescription\nOptional\ntimeperiod_id\nShow for a specific time period\nRequired\nquota_type\n\"rollup\" or \"direct\" quota\nRequired\nuser_id\nShow for a specific user\nRequired\nInput Example:\nOutput Example:\n{\n    \"currency_id\":\"-99\",\n    \"amount\":\"75.000000\",\n    \"date_modified\":\"2013-09-17 21:23:32\",\n    \"formatted_amount\":\"$75.00\",\n    \"is_top_level_manager\":true\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_idquotasdirectuser_id_GET/index.html"}
{"id": "6dd54de9eddc-0", "text": "/<module>/temp/file/:field/:temp_id GET\nOverview\n    Reads a temporary image and deletes it.\nRequest Arguments\n    This endpoint does not accept any arguments.\nResponse Arguments\nName\nType\nDescription\n            <image file>\n        \n            String;\n        \n            Returns the image content with the content headers.\n        \nResponse\nresult: HTTP/1.1 200 OK\nDate: Fri, 01 Mar 2013 05:36:24 GMT\nServer: Apache/2.2.22 (Unix) DAV/2 PHP/5.3.17\nX-Powered-By: PHP/5.3.17\nExpires: Sun, 31 Mar 2013 05:36:24 GMT\nCache-Control: max-age=1, post-check=0, pre-check=0\nPragma: public\nX-Content-Type-Options: nosniff\nContent-Length: 2072\nETag: d41d8cd98f00b204e9800998ecf8427e\nConnection: close\nContent-Type: image/png\n\u00e2\u0080\u00b0PNG", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html"}
{"id": "6dd54de9eddc-1", "text": "Connection: close\nContent-Type: image/png\n\u00e2\u0080\u00b0PNG\nIHDRIIqs\u00c3\u009c\u00c3\u009fIDATx\u00c5\u0093\u00c3\u00ad\u00c5\u0093}hU\u00c3\u00a7\u00c3\u0087?\u00c2\u00bf\u00e2\u0080\u00ba\u00c3\u00abi\u00c3\u0090l\u00e2\u0080\u00b9\u00c3\u0091\u00c2\u00b9\u00c3\u0090\u00c3\u00ab\u00e2\u0080\u009a\u00c2\u00a4\u00c2\u00a9\u00e2\u0084\u00a2\u00c5\u00a1S'\u00c3\u00a2D\u00e2\u0080\u009a\u00c3\u0089\u00c3\u00884+\u00cb\u0086\u00c3\u0096v\u00c2\u00b8\u00c2\u008d\u00c2\u00b1\u00c2\u008dM\u00c3\u00b6['vl\u00c2\u00b0\u00c2\u00b9w\u00c3\u00aa\u00c3\u009d\u00c2\u0090\u00e2\u0080\u0093m\u00c5\u0092M\u00c5\u00a0\u00c3\u0094\u00e2\u0080\u0094\u00c2\u00a6jBWDD$\u00c3\u009d\u00e2\u0080\u009a\u00cb\u0086dR\u00c2\u00b2L$\u00cb\u0086\u00cb\u0086/!^s\u00c3\u00af9\u00c3\u00a7\u00c3\u00b9\u00c3\u00ad\u00c2\u008f\u00c3\u00a7^st7\u00c3\u0097cr\u00c3\u009f\u00c3\u009a\u00c5\u00be\\\u00c3\u00ae%\u00c3\u009c\u00c5\u0093\u00c3\u00bb\u00c2\u00be\u00c3\u00a7y\u00c2\u00b9y~\u00c2\u0081\u00cb\u009c\u00cb\u009c\u00cb\u009c\u00cb\u009c\u00c3\u00aaA*\u00c3\u009d\u00e2\u0082\u00ac\u007f\u00c2\u00adx\"\u00c3\u00b7r!\u00c2\u00b0p\u00e2\u0082\u00acp\nH\u00c2\u00ac\u00c3\u00bfwE\u00c3\u009a\u00e2\u0080\u0093\u00c2\u00a3b'Brj\u00c2\u00816`\u00c2\u00b0h\u00c2\u00ae\u00c3\u00bf\u00c5\u00bd\u00c3\u00a7\u00c2\u0081i\u00c2\u00a8\u00c5\u0093\u00c2\u00ac\u00c2\u00b2J\n\u00e2\u0080\u00b0IMX)\u00c5\u00b8\u00c3\u008b>?", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html"}
{"id": "6dd54de9eddc-2", "text": "\u00e2\u0080\u00b0IMX)\u00c5\u00b8\u00c3\u008b>?\n$Co\u00c3\u00b7\u00c2\u0081\t\u00c3\u00a0\u00c3\u0090\u00c5\u00b8}\u00c5\u00be\"WXY$\u00c3\u009dwK\u00c2\u00b5cS\u00c3\u0093\t\u00c2\u00ac\u00c3\u0082&\u00c3\u00a9A\u00c2\u00a4\u00e2\u0082\u00ac\u00c3\u0098d\u00c3\u0083\u00c2\u00a6\u00c2\u00abl\u00c2\u00b7bI%e\u00c3\u00a5$\u00e2\u0082\u00ac\u00c3\u00a5\u00c3\u0080F X4f\u007f\u00c3\u00be\u00c2\u00b0\u00c3\u00a0\np\u00e2\u0080\u00ba\u00c2\u00ae\"\u00c3\u0080%\u00c3\u0080\"RV\u00c3\u0091%\u00e2\u0080\u00a6RS\u00c2\u00ac\u00c3\u0086\u00c5\u00a0\u00c3\u00a9Z\u00e2\u0080\u00b0\u00e2\u0080\u0093\u00c5\u00a1\u00c2\u00a8L\u00c2\u00a3\u00c3\u008c\u00c2\u00a4\u00c3\u00ab0\u00c3\u0085OW\u00c3\u0091$\u00e2\u0080\u00a6R\u00c3\u0093l\u00c3\u0082\u00c3\u008aY\u00e2\u0080\u00a1\u00c2\u009d\u00c2\u00b1\u00c3\u00a6'\u00c5\u00a1\u00c2\u00a8\u00c3\u00a0*p+\u00c3\u00ab`\u00c5\u0092\"\u00c2\u00a6k^'B\u00c2\u00a9\u00c3\u00b9(v\u00c2\u00ac\u00c3\u00a9\u00c2\u00ba\u00c2\u0081\u00e2\u0080\u00a275Q\u00e2\u0084\u00a2\u00c3\u009e\u00c3\u0083\u00c2\u00a6\u00c2\u00ab\u00e2\u0080\u00ba\u00c2\u00aeI\u00cb\u009c_\u00c2\u00ba\u00c3\u00a6$)+'\u00e2\u0080\u00b0MM'\u00c3\u0090\u00c2\u00b8\">5Q1\u00c3\u0098u\u00c3\u0096\u00c3\u00a0\u00c3\u00af\u00c3\u00806]\u00c3\u00be\\dE\u00e2\u0080\u0093JM=v\u00c2\u00ac\u00c3\u00a9\u00c2\u00b6`S\u00c3\u00a36]C\u00c3\u0080Q`\u00c2\u00b8\t\u00c3\u0091\u00c3\u0093\u00c3\u00b5@I\u00c2\u00a1\u00c3\u0094\u00c2\u00b4`\u00c2\u00a5\u00c3\u00a4R\u00c3\u0093@u\u00c2\u00a4&*\u00c2\u00bbH\u00c3\u0086\u00c5\u00bd]\u00c6\u0092DLWAI#\u00c2\u008f\u00c2\u00b7$\u00c3\u00b9\u00c2\u00ba", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html"}
{"id": "6dd54de9eddc-3", "text": "\u00c3\u009fX\u00c3\u0081\u00c2\u00bd\u00c2\u00be\u00c3\u00b7+`\u00c3\u0095\u00e2\u0080\u0094\u00c2\u0081W\u007f\u00c3\u008d\u007f/\u00c3\u008e\u00c3\u00ba\u00c3\u00a6\u00e2\u0080\u009aIX P\u00c2\u00b5\u00c5\u00b8X\u00c2\u00aeJR\u00e2\u0080\u00b9\u00c3\u009b\u00c3\u0098\u00c3\u008a \u00c3\u00aa\u00c3\u008dO\u00c3\u00a2{I\u00c3\u0094|\u00c3\u00bb\u00c2\u00acIr\u00c3\u009d \u00c5\u0093W\u00c2\u00aeM5|\u00c3\u008ch\u00c2\u00a7'\u00c3\u00b4X\u00c2\u008fJ#BB] \u00c3\u009a\u00c2\u00b0\u00c2\u008d5\u00c2\u00a8\u00c3\u009a\u00c3\u0085\u00c2\u00a8\u00c3\u00af\u00c3\u00b7\u00c3\u00a9\u00c3\u0087\u00e2\u0080\u0094\u00c3\u00a9\u00c2\u00a1\u00c3\u009f_\u00e2\u0080\u0094\u00c5\u0092\u00c5\u00b8\u00c3\u0081\u00c3\u0096\u00c2\u00baO\u00c3\u00a5\u00c3\u00bd\u00c3\u0095\u00c2\u00bc}t\u00c3\u009d\u00c2\u00b0)\u00c3\u009b\u00c5\u00a0\u00c3\u00b2t \u00c3\u00bc'\u00e2\u0082\u00ac\u00c3\u0081\u00c3\u009d\u00c2\u00b7\u00c3\u0093\u00c3\u00a3\u00c3\u009bS\u00e2\u0084\u00a2\u00c3\u00a5i\u00c3\u00a8", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html"}
{"id": "6dd54de9eddc-4", "text": "'6EkA\u00c2\u00aaV\u00e2\u0080\u0093\u00c2\u00aa\"vsc\u00c5\u00bd\u00c3\u00ba\u00c3\u00ac\u00c3\u008eq}vg3\u00c2\u00be\u00c3\u009fE4\tAd\u00c3\u0088+\u00c2\u00aa\u00c2\u0090\u00c2\u00a4\u00c3\u0095\u00c3\u0080\u00e2\u0082\u00ac\u00c2\u00b5j\u00c2\u00bd\tUNg\u00c3\u0090\u00c2\u00a3\u00c2\u00b5\u00c3\u008a\u00e2\u0084\u00a27n'\u00e2\u0080\u0093u=\u00c3\u00a85\u00c3\u0088z\u00c3\u0084nP\u00c2\u00ab\"]\u00c2\u00b6>\u00c2\u00aa\u00c3\u0080i'\u00c2\u00ac\u00c3\u0099@&\u00c3\u009d\u00c6\u0092\u00c3\u00aa:\u00c2\u00b1\u00e2\u0080\u00bal\u00c2\u00b0K\u00e2\u0080\u00a6/\u00c2\u00a3\u00c3\u00b9$\u00e2\u0080\u009e\u00c2\u0081e'\u00c3\u009d\u00c2\u00b5\u00e2\u0080\u00b9\u00c3\u00a8\u00c5\u00bdG\"\u00c3\u008f\u00c2\u00ab0\u00c2\u00bawI\u00c3\u009dq\u00c3\u00bd\u00c2\u00bbng\u00c3\u00b6\u00c3\u00b6\u00c2\u00a6\u00c3\u0092M\u00c2\u00b5\u00c3\u00a9'vU\u00c3\u00a6L\u00e2\u0080\u00a2K\u00cb\u009c\u00c2\u00a2\u00c5\u00a1\u00c3\u008e\u00cb\u009c~s\\\u00c2\u00bf\u00c3\u00bc\u00c3\u009c\u00e2\u0080\u009e\u00c3\u00ae\u00c3\u00b8B+~\u00c3\u00b05\t\u00c2\u00bcn\u00c2\u00afUT\u00c3\u00a4\u00c5\u00be\u00e2\u0080\u00935a'\u00c2\u00a5\u00c3\u0091|\u00c3\u0097.$\u00c3\u0089d!j\u00c2\u0081\u00c3\u0095IhW\u00c3\u0098sd\u00c3\u00a1\u00e2\u0080\u009aS\u00c2\u00af-\\p\"\u00c2\u00a9~\u00c3\u00a9f\u00c3\u00aa\u00c2\u00b5O\u00c3\u0086\u00c3\u00b5\u00e2\u0080\u00a6\u00c3\u009eY4i\u00c3\u00b63J,\u00c3\u008b\u00c3\u0095K '\u00c3\u00b1\u00c3\u00bc~m\u00c3\u00be\u00c3\u00a4\u00cb\u0086y\u00c3\u00b9\u00c2\u00a5\u00e2\u0080\u009e\u00c3\u0094\u00c3\u0094l\u00c3\u0080K\u00c3\u00bfP2\u00e2\u0084\u00a2", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html"}
{"id": "6dd54de9eddc-5", "text": "\u00c2\u00a8.\u00e2\u0080\u00ba\u00c3\u00a9\u00c3\u0086\u00c3\u00bf\u00c2\u00b5&O_g\u00cb\u009c\u00c3\u008ft\u00c5\u00bexTDv8\u00c2\u00aa\u00c3\u009b.~\u00c2\u00afa\u00c3\u0091q\u00c3\u00baz\u00c3\u00aed\u00c2\u00be\u00c3\u00bb\u00c3\u009cT\u00c2\u00ba\u00c3\u0091\u00c6\u0092\u00c3\u008e@\u00c3\u0098\u00c2\u00acV\u00c2\u00a4\u00c3\u00aen\u00c3\u00a7\u00c3\u00b1\u00c2\u00a19lrt\n!\u00c3\u00ba@\u00c3\u008d\u00c2\u00bes\u00e2\u0080\u00a2\u00c3\u008fnl\u00c3\u0081\u00c3\u00b3\u00c3\u00b6J\u00c3\u00a0ux+\u00c3\u0085\u00c3\u008ed\u00c3\u00b9\u00c3\u0084D\u00c2\u00a6(kq\u00e2\u0082\u00ac\u00c2\u00b6\u00c2\u00acr\"=\u00c2\u00b5\u00c3\u008e\u00c3\u00a9\u00c3\u00beZ\u00c2\u00a7/\u00c2\u00a9\u00c3\u00ba\u00c3\u0096/n\u00c2\u00a57\u00c3\u00b9\u00c3\u0086\n\u00c3\u0090\u00c5\u00be@d\u00c2\u00b0|^\u00c3\u00a9R\u00c3\u00b5\u00c2\u00811Q=E\u00c3\u00b4\u00c3\u00ab\u00c3\u008a\u00c3\u00a6as\u00c3\u00a07u'Ll\u00c3\u0084\u00c3\u008b\u00c3\u00b4\u00c2\u0090N\u00c2\u00af\u00c2\u00b4\u00c3\u008d.o\u00c3\u00a6!'GQ\u00e2\u0080\u00a0\t\u00e2\u0080\u009ee\u00c3\u009b\u00c3\u0095n\u00e2\u0080\u009e\u00c2\u00b1}\u00e2\u0080\u00b9", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html"}
{"id": "6dd54de9eddc-6", "text": "z\u00c3\u00b0\u00c3\u0086g\u00c3\u0092\u00c3\u009e\u00c2\u00beoMN7\u00c3\u0098\u00c3\u0080\u00c3\u0093\u00c3\u0099\u00e2\u0084\u00a2\u00c2\u00b1>\u00c2\u00a7j\u00c3\u0096\u00c2\u00ae\u00c3\u00a4f\u00c3\u0095\u00e2\u0080\u00ba\u00c3\u0080y\u00e2\u0080\u009a\u00c3\u00a0\u00cb\u0086&j\u00e2\u0080\u00a0\u00c3\u00b4\u00c3\u0087/^\u00c3\u00a7\u00c2\u00a95mx\u00c3\u009e\u00c3\u00b3b\u00c2\u00bc-dh\u00c2\u00be\u00e2\u0080\u00ba(\u00c5\u00a0\u00c5\u0093%[=g\u00c3\u0093\u00c3\u0095*J\u00e2\u0080\u00b9\u00c6\u0092>s\u00c3\u0096I\u00c5\u00be\u00c3\u009d\u00c2\u00b5\u00c3\u00b4#}5\u00c2\u00aa?\u00c2\u00bf\u00e2\u0080\u00a2z\u00c3\u00bdq\u00c3\u009f\u00c2\u00b4\u00c3\u00bbHo l\u00c5\u00a1'\u00c3\u00a1n\u00c2\u00a9\u00e2\u0080\u009e}\u00c2\u00811\u00c5\u0092\u00c2\u00be\u00c6\u0092\u00c3\u00af\u00c3\u0095\u00c3\u0096'\u00c3\u008e\u00e2\u0084\u00a2\u00c2\u00bfjas65.\u00c2\u00aa", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html"}
{"id": "6dd54de9eddc-7", "text": "2\u00c3\u00b3\u00c2\u00a1%\u00c3\u00a9K\u00c3\u0089\u00c2\u00b7*$Y*\u00c3\u0090\u00c3\u00ad\u00c2\u00a8nA{a\u00c3\u00b1\u00c2\u00a2\u00c3\u0081\u00c3\u00b4\u00c2\u00afN\u00c3\u00bb?z~\u00c3\u00b2N\u00c2\u00bd\u00c3\u0082V]F\u00c2\u00a4I\u00c2\u00b2\u007f-t\u00c5\u0093", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html"}
{"id": "6dd54de9eddc-8", "text": "8\u00c2\u00a1\u00c3\u0089\u00c3\u00a4\u00c3\u009b\u00c3\u00ba\u00c3\u008b\u00c3\u00bd7\u00c3\u00b9Tk\u00e2\u0084\u00a2\u00c3\u00b4>\u00c3\u00b1\u00c3\u0092[\u00c2\u0081\u00c2\u00a2j\u00c3\u009b^\"1aJ.)\u00c3\u009c\u00e2\u0080\u00a6\u00c2\u00bb\u00c3\u00a9\u00e2\u0080\u009a\u00e2\u0080\u0093GT\u00c2\u00bfx\u00c3\u0081\u00c2\u00a99\u00c2\u00bb{i\u00c3\u009d\u00e2\u0080\u00b0\u00c2\u00a42\u00c3\u00b8\u00c3\u0093[\u00c2\u00a9?7\u00c3\u00b9f\u00c2\u00a1/R+\u00c5\u00be?\u00c3\u008d\"-S\u00c3\u00a6\u00c3\u0097?k\"'\u00c3\u00a8\u00c3\u0086\u00c3\u00b7\u00c2\u00baHO\u00c2\u00af\u00c3\u0095\u00c3\u00ba\u00c3\u0090\u00c3\u0085J\u00c3\u009d\u00c3\u00b4\u00c2\u00bbTd\u00c2\u00b3\u00c2\u00aa\u00c2\u0090'z\u00c2\u0081N\u00c3\u009d\u00c2\u00ac\u00c3\u00b0\u00c2\u008d/\u00c3\u009a\u007fC\u00c3\u00a4\u00c3\u0090Wv\u00c3\u00ae4]\u00c3\u009d]IRw\u00c3\u00b6\u00c3\u00b8\u00c3\u009f_\u00e2\u0080\u00ba\u00c3\u00af\u00c2\u00b6\u00c2\u00b3\u00c5\u0092b\u00c3\u0082T\u00c3\u00a4\u00c2\u00ab\u00c5\u00bd{\u00c2\u00bb*IiI\u00c3\u0080\u00c3\u00bec6\u00c2\u00a5o\u00c3\u009c@n\u00c2\u00a7\u00c2\u00b6\u00cb\u00861?\u00c3\u0095D'\u00cb\u0086TLT\u00c3\u0097\u00c3\u00b7AM\u00c2\u00aa\u00c2\u00ba\u00c3\u009bq\u00c5\u0093:`\"\u00c2\u008d\u00e2\u0080\u00a2\u00c2\u00a6\u00c5\u00a1$\u00c2\u00ac\u00e2\u0080\u009a`v\u00e2\u0080\u00b9P5T\u00e2\u0080\u00a2$\u00c2\u00b5\u00c2\u008f\u00c2\u00aajTa\u00c6\u0092\u00c2\u00aa'XRbI\u00cb\u0086%E \u00e2\u0080\u0093\u00c2\u0081XRbI\u00cb\u0086%E \u00e2\u0080\u0093\u00c2\u0081XRbI\u00cb\u0086%E \u00e2\u0080\u0093\u00c2\u0081XRbI\u00cb\u0086%E", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html"}
{"id": "6dd54de9eddc-9", "text": "\u00e2\u0080\u0093\u00c2\u0081XRbI\u00cb\u0086%E \u00e2\u0080\u0093\u00c2\u0081XRbI($\u00c3\u00a9\u00c3\u0083&p\u00c3\u0096\u00c3\u00be\u00c3\u00a1S\u00c3\u00a0\u00c3\u008c\u00c3\u008e\u00c5\u00b8lM]>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html"}
{"id": "6dd54de9eddc-10", "text": "I\u00c3\u0085\u00c5\u00bes\u00c3\u00be0\u00c3\u00b0\u00c2\u00b6T,/\u00e2\u0080\u00a6$]b\u00e2\u0080\u00b9[>\u00c3\u0088\\^\u00c2\u00a1@?\u00c3\u00b3J~7\u00c3\u00b7\u00c3\u00b2o\u00c3\u0080X\u00c3\u008b\u00e2\u0084\u00a2\"7\u00c2\u00ae\u00c3\u0092Lct\u00c3\u00b6oB\u00c3\u00be\"\u00c2\u00b7P IYQ>\u00c3\u00b0Gl\u00c3\u0089\u00c3\u009e\u00c3\u00ac\u00c3\u0085\u00c2\u00ae\u00c2\u00b5\u00c2\u00a9\u00c3\u00a5%WT\u00c3\u00b8&\u00c3\u00b0Ml\u00c3\u00a7\u00c5\u00b8\u007f6A\u00c3\u00b0\u00e2\u0082\u00acS%YQ\u00c3\u0086u;.\u00c2\u0081\u00c3\u0083\u00c3\u008c\u00c3\u00bauc\u00c2\u00ab\"*Q\u00c2\u00b2\u00c3\u00b5\u00c2\u00b0Lc\u00c3\u009b\u00c3\u00bf\u00c2\u00b6ji\u00e2\u0080\u009el\u00e2\u0080\u00b0W!99\"\u00c2\u00bd\t\u00c3\u009d~\"\u00c2\u00ae\u00c3\u009bq[\u00c3\u009ey[2\u00c3\u009a\u00e2\u0080\u00b9-\u00c3\u0088\u00e2\u0084\u00a2k\u00c3\u0089h\u00c2\u00a9\u00e2\u0080\u0094\u00c2\u00a2\u00c3\u00b6aKQ/&\u00c5\u00a0\u00cb\u009c0}>)w\u00c2\u00ban\u00c3\u0087v\u00c3\u00b6\u00c3\u00bb+\u00c3\u00b7\u00c2\u00b7`'+\u00c3\u0085vf\u00c3\u0082\u00c5\u00bd\u00c2\u0090-j~X99\u00c3\u00a6|\u00cb\u0086+\"\u00c2\u00ae)\u00c3\u0097\u00c3\u00ad8\u00c2\u008d=U\u00c3\u00bf;f\n'7b\u00c3\u008b\u00e2\u0080\u0094#][\u007f'\u00c3\u00bb\u00c3\u008a\u00c3\u00a3\u00c3\u00a7*&LQN\u00c2\u00ba\u00e2\u0080\u00a6\u00c3\u0086\u00c2\u00aeK\u00c3\u0080!\u00c3\u00ac\u00c2\u00ac\u00c3\u0098\u00c5\u00bd\u00c2\u00ad\u00c3\u00b9\u00c3\u008f)\u00c3\u0097\u00c3\u008dz\u00c2\u0081\u00c2\u00b9\"K\u00c3\u008d\u00c3\u00b6\u00e2\u0080\u0093\u00c2\u00ba\u00c3\u0080\nChange Log\nVersion\nChange\n            v10", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html"}
{"id": "6dd54de9eddc-11", "text": "Change Log\nVersion\nChange\n            v10\n        \n            Added /<module>/enum/:field GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html"}
{"id": "a255764de8c9-0", "text": "/<module>/:record DELETE\nOverview\n    Delete a record of a specified type.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            id\n        \n            String\n        \n            Returns the ID of the deleted record.\n        \nResponse\n{\n    \"id\": \"11cf0d0a-40af-8cb1-9da0-5057a5f511f9\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record DELETE endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_DELETE/index.html"}
{"id": "c507c1b6cad5-0", "text": "/Forecasts/:timeperiod_id/:user_id/chart/:display_manager GET\nRetrieve a Forecasting Information In SugarChart Format\nSummary:\n    This endpoint is used to return the json Data for SugarCharts to use to display the needed chart.\nQuery Parameters:\nParam\nDescription\nOptional\ntimeperiod_id\nShow for a specific time period\n\u00c2\u00a0\nuser_id\nShow for a specific user\n\u00c2\u00a0\ndisplay_manager\nPipeline or Committed are valid values.\n\u00c2\u00a0\ndataset\nWhich Forecast dataset to show, valid values are likely, best, worst. Defaults to likely if one is not specified\nOptional\ngroup_by\nShow Which fields the y-axis shows on the chart.  Can be any field in the opportunity module, defaults to Sales Stage\nOptional\nranges\nPipeline or Committed are valid values.\nOptional\nInput Example:\n{\n    'user_id':'seed_max_id,\n    'timeperiod_id':'36f7085a-5889-ea75-84c8-50f42bd1a5ba',\n    'display_manager':'false',\n    'group_by': 'forecast',\n    'dataset': 'likely',\n    'ranges': 'include',\n}\n    \nOutput Example:\n        { \"color\" : [ \"#8c2b2b\",\n              \"#468c2b\",\n              \"#2b5d8c\",\n              \"#cd5200\",\n              \"#e6bf00\",\n              \"#7f3acd\",\n              \"#00a9b8\",\n              \"#572323\",\n              \"#004d00\",\n              \"#000087\",\n              \"#e48d30\",\n              \"#9fba09\",\n              \"#560066\",\n              \"#009f92\",\n              \"#b36262\",\n              \"#38795c\",\n              \"#3D3D99\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_iduser_idchartdisplay_manager_GET/index.html"}
{"id": "c507c1b6cad5-1", "text": "\"#38795c\",\n              \"#3D3D99\",\n              \"#99623d\",\n              \"#998a3d\",\n              \"#994e78\",\n              \"#3d6899\",\n              \"#CC0000\",\n              \"#00CC00\",\n              \"#0000CC\",\n              \"#cc5200\",\n              \"#ccaa00\",\n              \"#6600cc\",\n              \"#005fcc\"\n            ],\n          \"label\" : [ \"Include\" ],\n          \"properties\" : [ { \"gauge_target_list\" : \"Array\",\n                \"goal_marker_color\" : [ \"#000000\",\n                    \"#7D12B2\"\n                  ],\n                \"goal_marker_label\" : [ \"Quota\",\n                    \"Likely Case\"\n                  ],\n                \"goal_marker_type\" : [ \"group\",\n                    \"pareto\"\n                  ],\n                \"label_name\" : \"Include in Forecast\",\n                \"labels\" : \"value\",\n                \"legend\" : \"on\",\n                \"print\" : \"on\",\n                \"subtitle\" : \"\",\n                \"thousands\" : \"\",\n                \"title\" : null,\n                \"type\" : \"bar chart\",\n                \"value_name\" : \"Likely Case\"\n              } ],\n          \"values\" : [ { \"goalmarkervalue\" : [ \"111000.00\",\n                    \"36000.00\"\n                  ],\n                \"goalmarkervaluelabel\" : [ \"$111,000.00\",\n                    \"$36,000.00\"\n                  ],\n                \"gvalue\" : 36000,\n                \"gvaluelabel\" : \"$36,000.00\",\n                \"label\" : \"January 2013\",\n                \"links\" : [ \"\" ],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_iduser_idchartdisplay_manager_GET/index.html"}
{"id": "c507c1b6cad5-2", "text": "\"links\" : [ \"\" ],\n                \"valuelabels\" : [ \"$36,000.00\" ],\n                \"values\" : [ 36000 ]\n              },\n              { \"goalmarkervalue\" : [ \"111000.00\",\n                    \"61500.00\"\n                  ],\n                \"goalmarkervaluelabel\" : [ \"$111,000.00\",\n                    \"$61,500.00\"\n                  ],\n                \"gvalue\" : 25500,\n                \"gvaluelabel\" : \"$25,500.00\",\n                \"label\" : \"February 2013\",\n                \"links\" : [ \"\" ],\n                \"valuelabels\" : [ \"$25,500.00\" ],\n                \"values\" : [ 25500 ]\n              },\n              { \"goalmarkervalue\" : [ \"111000.00\",\n                    \"61500.00\"\n                  ],\n                \"goalmarkervaluelabel\" : [ \"$111,000.00\",\n                    \"$61,500.00\"\n                  ],\n                \"gvalue\" : 0,\n                \"gvaluelabel\" : \"$0.00\",\n                \"label\" : \"March 2013\",\n                \"links\" : [ \"\" ],\n                \"valuelabels\" : [ \"$0.00\" ],\n                \"values\" : [ 0 ]\n              }\n            ]\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_iduser_idchartdisplay_manager_GET/index.html"}
{"id": "b693b1ae5974-0", "text": "/me/preference/:preference_name GET\nOverview\n    Returns a specific preference for the current user.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            \u00c2\u00a0\n        \n            \u00c2\u00a0\n        \n            \u00c2\u00a0\n        \nResponse\n{\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /me/preference/:preference_name GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mepreferencepreference_name_GET/index.html"}
{"id": "f115723328f2-0", "text": "/<module>/:record/link/history GET\nOverview\n    Lists history filtered records.\nSummary\n    This endpoint will return a set of history modules (meetings, calls, notes, tasks, emails) records filtered by an expression.\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \n            deleted\n        \n            Boolean\n        \n            Boolean to show deleted records in the result set.\n        \n            False\n        \n            module_list\n        \n            String\n        \n            A list of modules from the valid modules [Tasks, Calls, Emails, Notes, Meetings] that need to be included\n        \n            False\n        \n            alias_fields\n        \n            Array\n        \n            A list of field aliases from the valid modules [Tasks, Calls, Emails, Notes, Meetings] that need to be fetched. These field aliases can also be used in 'order_by'.\n            \n            Example:\n            \n            {\n              'record_date': \n              {\n                'Calls': 'date_start',\n                'Emails': 'date_sent'\n              }\n            }\n            \n            False", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkhistory_GET/index.html"}
{"id": "f115723328f2-1", "text": "}\n            }\n            \n            False\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkhistory_GET/index.html"}
{"id": "873c8179d216-0", "text": "/ForecastManagerWorksheets/:timeperiod_id/:user_id GET\nReturns a collection of ForecastManagerWorksheet models\nSummary:\nThis end point is used to return the ManagerWorksheets for a user at a given timeperiod.  If no timeperiod is provide it\n    will use the default timeperiod, likewise if no user is provided, it will default to the logged in user.\nUrl Parameters:\nParam\nDescription\nOptional\ntimeperiod_id\nShow for a specific time period, defaults to the current time period if one is not passed\nOptional\nuser_id\nShow for a specific user, defaults to current user if not defined\nOptional\nPossible Errors\nError\nDescription\n412 - Invalid Parameter\nWhen the passed in timeperiod and/or user can not be found\n403 - Not Authorized\nIf you are not an administrator, but you are trying to view another managers forecast manager worksheet, you will receive a 403 Not Authorized Error\nUrl Example:\n        /rest/v10/ForecastManagerWorksheets/:timeperiod_id/:user_id\n    \nOutput Example:\n    {  \n        \"next_offset\":-1,\n        \"records\":[  \n        {  \n            \"id\":\"401594f5-5b46-fb66-1627-55771fe8723e\",\n            \"name\":\"Sally Bronsen\",\n            \"date_modified\":\"2015-06-09T13:13:26-04:00\",\n            \"created_by\":\"1\",\n            \"quota\":\"1932.444445\",\n            \"best_case\":\"29848.000000\",\n            \"best_case_adjusted\":\"37310.000000\",\n            \"likely_case\":\"28694.444445\",\n            \"likely_case_adjusted\":\"35868.055556\",\n            \"worst_case\":\"27540.888889\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_iduser_id_GET/index.html"}
{"id": "873c8179d216-1", "text": "\"worst_case\":\"27540.888889\",\n            \"worst_case_adjusted\":\"34426.111111\",\n            \"timeperiod_id\":\"adb78e81-3fbd-b4e0-287f-55771fd04a06\",\n            \"draft\":true,\n            \"is_manager\":false,\n            \"user_id\":\"seed_sally_id\",\n            \"opp_count\":10,\n            \"pipeline_opp_count\":3,\n            \"pipeline_amount\":\"2415.555556\",\n            \"closed_amount\":\"26278.888889\",\n            \"manager_saved\":true,\n            \"show_history_log\":0,\n            \"following\":false,\n            \"assigned_user_id\":\"seed_sarah_id\",\n            \"assigned_user_name\":\"Sarah Smith\",\n            \"team_name\":[  \n                {  \n                    \"id\":\"1\",\n                    \"name\":\"Global\",\n                    \"name_2\":\"\",\n                    \"primary\":true\n                }\n            ],\n            \"currency_id\":\"-99\",\n            \"base_rate\":\"1.000000\",\n            \"_acl\":{  \n                \"fields\":{  \n                }\n            },\n            \"_module\":\"ForecastManagerWorksheets\"\n        },\n        {  \n            \"id\":\"28226f12-a3c9-bd84-041e-55771f064c4e\",\n            \"name\":\"Max Jensen\",\n            \"date_modified\":\"2015-06-09T13:13:26-04:00\",\n            \"created_by\":\"1\",\n            \"quota\":\"3141.333332\",\n            \"best_case\":\"15848.222223\",\n            \"best_case_adjusted\":\"13206.851853\",\n            \"likely_case\":\"14928.222222\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_iduser_id_GET/index.html"}
{"id": "873c8179d216-2", "text": "\"likely_case\":\"14928.222222\",\n            \"likely_case_adjusted\":\"12440.185185\",\n            \"worst_case\":\"14008.222223\",\n            \"worst_case_adjusted\":\"11673.518519\",\n            \"timeperiod_id\":\"adb78e81-3fbd-b4e0-287f-55771fd04a06\",\n            \"draft\":true,\n            \"is_manager\":false,\n            \"user_id\":\"seed_max_id\",\n            \"opp_count\":12,\n            \"pipeline_opp_count\":3,\n            \"pipeline_amount\":\"2617.777777\",\n            \"closed_amount\":\"12310.444445\",\n            \"manager_saved\":true,\n            \"show_history_log\":0,\n            \"following\":false,\n            \"assigned_user_id\":\"seed_sarah_id\",\n            \"assigned_user_name\":\"Sarah Smith\",\n            \"team_name\":[  \n                {  \n                    \"id\":\"1\",\n                    \"name\":\"Global\",\n                    \"name_2\":\"\",\n                    \"primary\":true\n                }\n            ],\n            \"currency_id\":\"-99\",\n            \"base_rate\":\"1.000000\",\n            \"_acl\":{  \n                \"fields\":{  \n                }\n            },\n            \"_module\":\"ForecastManagerWorksheets\"\n        },\n        {  \n            \"id\":\"1aca66af-f069-bba4-28a1-55771fe27506\",\n            \"name\":\"\",\n            \"date_modified\":\"2015-06-09T13:13:26-04:00\",\n            \"created_by\":\"1\",\n            \"quota\":\"10142.333333\",\n            \"best_case\":\"37625.000000\",\n            \"best_case_adjusted\":\"37625.000000\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_iduser_id_GET/index.html"}
{"id": "873c8179d216-3", "text": "\"best_case_adjusted\":\"37625.000000\",\n            \"likely_case\":\"34241.333333\",\n            \"likely_case_adjusted\":\"34241.333333\",\n            \"worst_case\":\"30857.666667\",\n            \"worst_case_adjusted\":\"30857.666667\",\n            \"timeperiod_id\":\"adb78e81-3fbd-b4e0-287f-55771fd04a06\",\n            \"draft\":true,\n            \"is_manager\":true,\n            \"user_id\":\"seed_sarah_id\",\n            \"opp_count\":13,\n            \"pipeline_opp_count\":6,\n            \"pipeline_amount\":\"10142.333333\",\n            \"closed_amount\":\"24099.000000\",\n            \"manager_saved\":true,\n            \"show_history_log\":0,\n            \"following\":false,\n            \"assigned_user_id\":\"seed_sarah_id\",\n            \"assigned_user_name\":\"Sarah Smith\",\n            \"team_name\":[  \n                {  \n                    \"id\":\"1\",\n                    \"name\":\"Global\",\n                    \"name_2\":\"\",\n                    \"primary\":true\n                }\n            ],\n            \"currency_id\":\"-99\",\n            \"base_rate\":\"1.000000\",\n            \"_acl\":{  \n                \"fields\":{  \n                }\n            },\n            \"_module\":\"ForecastManagerWorksheets\"\n        }\n        ]\n    }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_iduser_id_GET/index.html"}
{"id": "2af2ffe736b6-0", "text": "/pmse_Project/ActivityDefinition/:record PUT\nOverview\n    Updates the definition data for an activity\nSummary\n    This endpoint will update the Process Definition activity identified by the\n    record input parameter with the data provided in the request\n    payload.\nRequest Arguments\nName\nType\nDescription\nRequired\nrecord\nString\nThe value for the act_uid field in the pmse_bpmn_activity record\nTrue\nRequest Payload\n{\n    \"data\":\n    {\n        \"act_field_module\":\"Accounts\",\n        \"act_fields\":\"[{\\\"name\\\":\\\"Assigned to\\\",\\\"field\\\":\\\"assigned_user_id\\\",\\\"value\\\":\\\"owner\\\",\\\"type\\\":\\\"user\\\",\\\"label\\\":\\\"Record owner\\\"}]\"\n    }\n}\nResponse Arguments\nName\nType\nDescription\nsuccess\nBoolean\nThe status of the update operation\nResponse\n{\n    \"success\":true\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_PUT/index.html"}
{"id": "0516e35bd89a-0", "text": "/<module>/:record/link/:link_name/:remote_id POST\nOverview\n    Creates a relationship to a pre-existing record.\nQuery String Parameters\n    This endpoint does not accept any arguments.\nResponse Arguments\nName\nType\nDescription\n            record\n        \n            Array\n        \n            The record linked to the related record.\n        \n            related_record\n        \n            Array\n        \n            The record that was associated.\n        \nResponse\n{\n   \"record\":{\n      \"id\":\"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n      \"name\":\"Slender Broadband Inc - 1000 units\",\n      \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n      \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n      \"modified_user_id\":\"1\",\n      \"modified_by_name\":\"Administrator\",\n      \"created_by\":\"1\",\n      \"created_by_name\":\"Administrator\",\n      \"description\":\"\",\n      \"img\":\"\",\n      \"last_activity_date\":\"2013-02-28T18:21:00+00:00\",\n      \"deleted\":false,\n      \"assigned_user_id\":\"seed_max_id\",\n      \"assigned_user_name\":\"Max Jensen\",\n      \"team_name\":[\n         {\n            \"id\":\"East\",\n            \"name\":\"East\",\n            \"name_2\":\"\",\n            \"primary\":false\n         },\n         {\n            \"id\":\"West\",\n            \"name\":\"West\",\n            \"name_2\":\"\",\n            \"primary\":true\n         }\n      ],\n      \"opportunity_type\":\"\",\n      \"account_name\":\"Slender Broadband Inc\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_POST/index.html"}
{"id": "0516e35bd89a-1", "text": "\"opportunity_type\":\"\",\n      \"account_name\":\"Slender Broadband Inc\",\n      \"account_id\":\"181461c6-dc81-1115-1fe0-512d092e8f15\",\n      \"campaign_id\":\"\",\n      \"campaign_name\":\"\",\n      \"lead_source\":\"Campaign\",\n      \"amount\":\"25000\",\n      \"base_rate\":\"1\",\n      \"amount_usdollar\":\"25000\",\n      \"currency_id\":\"-99\",\n      \"currency_name\":\"\",\n      \"currency_symbol\":\"\",\n      \"date_closed\":\"2013-02-27\",\n      \"date_closed_timestamp\":\"1361992480\",\n      \"next_step\":\"\",\n      \"sales_stage\":\"Needs Analysis\",\n      \"sales_status\":\"New\",\n      \"probability\":\"90\",\n      \"best_case\":\"25000\",\n      \"worst_case\":\"25000\",\n      \"commit_stage\":\"include\",\n      \"my_favorite\":false,\n      \"_acl\":{\n         \"fields\":{\n         }\n      }\n   },\n   \"related_record\":{\n      \"id\":\"e689173e-c953-1e14-c215-512d0927e7a2\",\n      \"name\":\"Gus Dales\",\n      \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n      \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n      \"modified_user_id\":\"1\",\n      \"modified_by_name\":\"Administrator\",\n      \"created_by\":\"1\",\n      \"created_by_name\":\"Administrator\",\n      \"description\":\"\",\n      \"img\":\"\",\n      \"deleted\":false,\n      \"assigned_user_id\":\"seed_sally_id\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_POST/index.html"}
{"id": "0516e35bd89a-2", "text": "\"deleted\":false,\n      \"assigned_user_id\":\"seed_sally_id\",\n      \"assigned_user_name\":\"Sally Bronsen\",\n      \"team_name\":[\n         {\n            \"id\":\"West\",\n            \"name\":\"West\",\n            \"name_2\":\"\",\n            \"primary\":true\n         }\n      ],\n      \"salutation\":\"\",\n      \"first_name\":\"Gus\",\n      \"last_name\":\"Dales\",\n      \"full_name\":\"Gus Dales\",\n      \"title\":\"Director Operations\",\n      \"linkedin\":\"\",\n      \"facebook\":\"\",\n      \"twitter\":\"\",\n      \"googleplus\":\"\",\n      \"department\":\"\",\n      \"do_not_call\":false,\n      \"phone_home\":\"(661) 120-2292\",\n      \"email\":[\n         {\n            \"email_address\":\"section.sugar.section@example.it\",\n            \"opt_out\":\"1\",\n            \"invalid_email\":\"0\",\n            \"primary_address\":\"0\"\n         },\n         {\n            \"email_address\":\"support.qa.kid@example.co.uk\",\n            \"opt_out\":\"0\",\n            \"invalid_email\":\"0\",\n            \"primary_address\":\"1\"\n         }\n      ],\n      \"phone_mobile\":\"(294) 447-9707\",\n      \"phone_work\":\"(036) 840-3216\",\n      \"phone_other\":\"\",\n      \"phone_fax\":\"\",\n      \"email1\":\"support.qa.kid@example.co.uk\",\n      \"email2\":\"section.sugar.section@example.it\",\n      \"invalid_email\":false,\n      \"email_opt_out\":false,\n      \"primary_address_street\":\"48920 San Carlos Ave\",\n      \"primary_address_street_2\":\"\",\n      \"primary_address_street_3\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_POST/index.html"}
{"id": "0516e35bd89a-3", "text": "\"primary_address_street_2\":\"\",\n      \"primary_address_street_3\":\"\",\n      \"primary_address_city\":\"Persistance\",\n      \"primary_address_state\":\"CA\",\n      \"primary_address_postalcode\":\"54556\",\n      \"primary_address_country\":\"USA\",\n      \"alt_address_street\":\"\",\n      \"alt_address_street_2\":\"\",\n      \"alt_address_street_3\":\"\",\n      \"alt_address_city\":\"\",\n      \"alt_address_state\":\"\",\n      \"alt_address_postalcode\":\"\",\n      \"alt_address_country\":\"\",\n      \"assistant\":\"\",\n      \"assistant_phone\":\"\",\n      \"picture\":\"\",\n      \"email_and_name1\":\"\",\n      \"lead_source\":\"Support Portal User Registration\",\n      \"account_name\":\"Arts & Crafts Inc\",\n      \"account_id\":\"d43243c6-9b8e-2973-aee2-512d09bc34b4\",\n      \"opportunity_role_fields\":\"\",\n      \"opportunity_role_id\":\"\",\n      \"opportunity_role\":\"Technical Advisor\",\n      \"reports_to_id\":\"\",\n      \"report_to_name\":\"\",\n      \"portal_name\":\"GusDales145\",\n      \"portal_active\":true,\n      \"portal_password\":\"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0\",\n      \"portal_password1\":\"\",\n      \"portal_app\":\"\",\n      \"preferred_language\":\"en_us\",\n      \"campaign_id\":\"\",\n      \"campaign_name\":\"\",\n      \"c_accept_status_fields\":\"\",\n      \"m_accept_status_fields\":\"\",\n      \"accept_status_id\":\"\",\n      \"accept_status_name\":\"\",\n      \"sync_contact\":\"\",\n      \"my_favorite\":false,\n      \"_acl\":{\n         \"fields\":{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_POST/index.html"}
{"id": "0516e35bd89a-4", "text": "\"my_favorite\":false,\n      \"_acl\":{\n         \"fields\":{\n         }\n      }\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/link/:link_name/:remote_id POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_POST/index.html"}
{"id": "33ff8b1641fa-0", "text": "/Emails/:record/link/:link_name/:remote_id DELETE\nOverview\n    Deletes an existing relationship between an email and another record.\nSummary\n    The sender (link: from) cannot be removed. Replace the sender with a different sender instead. All other\n    operations described in Relate Record API are\n    supported.\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Emails/:record/link/:link_name/:remote_id DELETE endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecordlinklink_nameremote_id_DELETE/index.html"}
{"id": "0135897b6d16-0", "text": "/oauth2/bwc/login POST\nATTENTION: FOR INTERNAL USAGE ONLY\nThis endpoint is subject to change.\nOverview\n    Retrieves a cookie from the OAuth token.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/oauth2bwclogin_POST/index.html"}
{"id": "050278528951-0", "text": "/Emails/filter GET\nOverview\n    Lists filtered emails.\nSummary\n    Adds additional operators to Filter API that are\n    specific to Emails. A special macro, $current_user_id, is a convenience that allows for finding emails\n    involving the current user.\nFilter By Sender\n    This will return all emails sent by the current user, by the contact whose ID is\n    fa300a0e-0ad1-b322-9601-512d0983c19a, using the email address sam@example.com, which is referenced by\n    the ID b0701501-1fab-8ae7-3942-540da93f5017, or by the lead whose ID is\n    73b1087e-4bb6-11e7-acaa-3c15c2d582c6 using the email address wally@example.com, which is referenced by\n    the ID b651d834-4bb6-11e7-bfcf-3c15c2d582c6.\n{\n  \"filter\": [{\n    \"$from\": [{\n      \"parent_type\": \"Users\",\n      \"parent_id\": \"$current_user_id\"\n    }, {\n      \"parent_type\": \"Contacts\",\n      \"parent_id\": \"fa300a0e-0ad1-b322-9601-512d0983c19a\"\n    }, {\n      \"email_address_id\": \"b0701501-1fab-8ae7-3942-540da93f5017\"\n    }, {\n      \"parent_type\": \"Leads\",\n      \"parent_id\": \"73b1087e-4bb6-11e7-acaa-3c15c2d582c6\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_GET/index.html"}
{"id": "050278528951-1", "text": "\"email_address_id\": \"b651d834-4bb6-11e7-bfcf-3c15c2d582c6\"\n    }]\n  }]\n}\n    Equivalent to:\n{\n  \"filter\": [{\n    \"from_collection\": {\n      \"$in\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }, {\n        \"parent_type\": \"Contacts\",\n        \"parent_id\": \"fa300a0e-0ad1-b322-9601-512d0983c19a\"\n      }, {\n        \"email_address_id\": \"b0701501-1fab-8ae7-3942-540da93f5017\"\n      }, {\n        \"parent_type\": \"Leads\",\n        \"parent_id\": \"73b1087e-4bb6-11e7-acaa-3c15c2d582c6\",\n        \"email_address_id\": \"b651d834-4bb6-11e7-bfcf-3c15c2d582c6\"\n      }]\n    }\n  }]\n}\nFilter By Recipients\n    This would return all archived emails received by the current user.\n{\n  \"filter\": [{\n    \"$or\": [{\n      \"$to\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }],\n      \"$cc\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }],\n      \"$bcc\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }]\n    }]\n  }, {\n    \"state\": {\n      \"$in\": [", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_GET/index.html"}
{"id": "050278528951-2", "text": "}]\n  }, {\n    \"state\": {\n      \"$in\": [\n        \"Archived\"\n      ]\n    }\n  }]\n}\n    Equivalent to:\n{\n  \"filter\": [{\n    \"$or\": [{\n      \"to_collection\": {\n        \"$in\": [{\n          \"parent_type\": \"Users\",\n          \"parent_id\": \"$current_user_id\"\n        }]\n      },\n      \"cc_collection\": {\n        \"$in\": [{\n          \"parent_type\": \"Users\",\n          \"parent_id\": \"$current_user_id\"\n        }]\n      },\n      \"bcc_collection\": {\n        \"$in\": [{\n          \"parent_type\": \"Users\",\n          \"parent_id\": \"$current_user_id\"\n        }]\n      }\n    }]\n  }, {\n    \"state\": {\n      \"$in\": [\n        \"Archived\"\n      ]\n    }\n  }]\n}\nFilter By Sender and Recipients\n    This would return all archived emails sent by a contact to the current user.\n{\n  \"filter\": [{\n    \"$from\": [{\n      \"parent_type\": \"Contacts\",\n      \"parent_id\": \"fa300a0e-0ad1-b322-9601-512d0983c19a\"\n    }]\n  }, {\n    \"$or\": [{\n      \"$to\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }],\n      \"$cc\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }],\n      \"$bcc\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }]\n    }]\n  }, {\n    \"state\": {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_GET/index.html"}
{"id": "050278528951-3", "text": "}]\n    }]\n  }, {\n    \"state\": {\n      \"$in\": [\n        \"Archived\"\n      ]\n    }\n  }]\n}\n    Equivalent to:\n{\n  \"filter\": [{\n    \"from_collection\": {\n      \"$in\": [{\n        \"parent_type\": \"Contacts\",\n        \"parent_id\": \"fa300a0e-0ad1-b322-9601-512d0983c19a\"\n      }]\n    }\n  }, {\n    \"$or\": [{\n      \"to_collection\": {\n        \"$in\": [{\n          \"parent_type\": \"Users\",\n          \"parent_id\": \"$current_user_id\"\n        }]\n      },\n      \"cc_collection\": {\n        \"$in\": [{\n          \"parent_type\": \"Users\",\n          \"parent_id\": \"$current_user_id\"\n        }]\n      },\n      \"bcc_collection\": {\n        \"$in\": [{\n          \"parent_type\": \"Users\",\n          \"parent_id\": \"$current_user_id\"\n        }]\n      }\n    }]\n  }, {\n    \"state\": {\n      \"$in\": [\n        \"Archived\"\n      ]\n    }\n  }]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added the $from, $to, $cc, and $bcc operators to\n            /Emails/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_GET/index.html"}
{"id": "41a7488b9eac-0", "text": "/Mail/attachment POST\nOverview\n    Upload an email attachment\nQuery String Parameters\n    This endpoint does not accept any query string parameters.\nInput Parameters\nName\nType\nDescription\nRequired\n            email_attachment\n        \n            String\n        \n            The file to upload.\n        \n            True\n        \nInput Example\n{\"email_attachment\":\"@\\/path\\/to\\/ExampleDocument.txt\"}\nResult\nName\nType\nDescription\n            <email record field>\n        \n            <email record field type>\n        \n            Returns the fields for the newly created email record.\n        \nOutput Example\n{\n    \"guid\": \"61b19f41-0ac9-0f2f-d9c5-51eecaf89396\",\n    \"name\": \"ExampleDocument.txt\",\n    \"nameForDisplay\": \"ExampleDocument.txt\"\n}\nChange Log\nVersion\nChange\n            v11\n        \n            Last version in which /Mail/attachment POST is available. Use\n            /Notes/temp/file/filename POST in conjunction with\n            /Emails/:record/link/attachments POST instead.\n        \n            v10\n        \n            Added /Mail/attachment POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailattachment_POST/index.html"}
{"id": "5fe86de4cfd3-0", "text": "/Calendar/invitee_search GET\nOverview\n    Temporary API - Do Not Use! This endpoint will be removed in an upcoming release. Use /search endpoint instead.\n    Searches for people to invite to an event (meeting or call).\nRequest Arguments\nName\nType\nDescription\nRequired\n            q\n        \n            String\n        \n            The search text to match records on.\n        \n            True\n        \n            module_list\n        \n            String\n        \n            Comma delimited list of modules to search.\n        \n            True\n        \n            search_fields\n        \n            String\n        \n            Comma delimited list of fields to search.\n        \n            True\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. Search fields will automatically be added to return list.\n        \n            True\n        \nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Currently only returns -1 as paging is not supported yet.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n    \"next_offset\": -1,\n    \"records\": [\n        {\n            \"id\": \"17283aad-8d15-c545-fc5a-5422fe3d8ef8\",\n            \"date_modified\": \"2014-09-24T13:25:28-04:00\",\n            \"email\": [\n                {\n                    \"email_address\": \"hr.phone.support@example.cn\",\n                    \"invalid_email\": false,\n                    \"opt_out\": true,\n                    \"primary_address\": false,\n                    \"reply_to_address\": false\n                },\n                {\n                    \"email_address\": \"section.section.phone@example.edu\",\n                    \"invalid_email\": false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Calendarinvitee_search_GET/index.html"}
{"id": "5fe86de4cfd3-1", "text": "\"invalid_email\": false,\n                    \"opt_out\": false,\n                    \"primary_address\": true,\n                    \"reply_to_address\": true\n                }\n            ],\n            \"full_name\": \"Renaldo Cuffee\",\n            \"account_name\": \"EEE Endowments LTD\",\n            \"_acl\": {\n                \"fields\": {}\n            },\n            \"_module\": \"Contacts\",\n            \"_search\": {\n                \"highlighted\": {\n                    \"account_name\": {\n                        \"text\": \"EEE Endowments LTD\",\n                        \"module\": \"Contacts\",\n                        \"label\": \"LBL_ACCOUNT_NAME\"\n                    }\n                }\n            }\n        },\n        {\n            \"id\": \"19c0fa4a-a6c0-940f-7ad6-5422fe62a00a\",\n            \"date_modified\": \"2014-09-24T13:25:28-04:00\",\n            \"email\": [\n                {\n                    \"email_address\": \"qa.beans@example.com\",\n                    \"invalid_email\": false,\n                    \"opt_out\": true,\n                    \"primary_address\": false,\n                    \"reply_to_address\": false\n                },\n                {\n                    \"email_address\": \"the.phone.sales@example.de\",\n                    \"invalid_email\": false,\n                    \"opt_out\": false,\n                    \"primary_address\": true,\n                    \"reply_to_address\": true\n                }\n            ],\n            \"full_name\": \"Noble Canto\",\n            \"account_name\": \"EEE Endowments LTD\",\n            \"_acl\": {\n                \"fields\": {}\n            },\n            \"_module\": \"Contacts\",\n            \"_search\": {\n                \"highlighted\": {\n                    \"account_name\": {\n                        \"text\": \"EEE Endowments LTD\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Calendarinvitee_search_GET/index.html"}
{"id": "5fe86de4cfd3-2", "text": "\"account_name\": {\n                        \"text\": \"EEE Endowments LTD\",\n                        \"module\": \"Contacts\",\n                        \"label\": \"LBL_ACCOUNT_NAME\"\n                    }\n                }\n            }\n        }\n    ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/send_invites GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Calendarinvitee_search_GET/index.html"}
{"id": "50a0c05d0215-0", "text": "/pmse_Inbox/historyLog/:filter GET\nOverview\n    Gets the history log for a process \nSummary\n    This endpoint gets the history log for a process \nRequest Arguments\nName\nType\nDescription\nRequired\nfilter\nstring\nThe id of the process trigger sequence (cas_id)\ntrue\nResponse Arguments\nName\nType\nDescription\nsuccess\nboolean\nResult of the operation\nresult\n<field>:<value>\nHistory records\nResponse\n{\n    \"success\":true,\n    \"result\":\n    [\n        {\n            \"image\":\"index.php?entryPoint=download\\u0026id=0b2dc2f0-2377-11e6-9d2a-6c4008960436\\u0026type=SugarFieldImage\\u0026isTempFile=1\",\n            \"user\":\"Administrator\",\n            \"current_user\":\"Administrator\",\n            \"due_date\":\"2016-06-03T16:18:59-07:00\",\n            \"end_date\":\"2016-06-01T16:18:59-07:00\",\n            \"current_date\":\"2016-06-02T10:53:14-07:00\",\n            \"delegate_date\":\"2016-06-01T16:18:59-07:00\",\n            \"start_date\":\"2016-06-01T16:18:59-07:00\",\n            \"completed\":true,\n            \"cas_user_id\":\"1\",\n            \"data_info\":\"has created Process #2  on the Account record  with the event \\u0027Start Event # 1\\u0027.\"\n        },\n    ]\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxhistoryLogfilter_GET/index.html"}
{"id": "5152a9305b3e-0", "text": "/oauth2/token POST\nOverview\nRetrieves the token portion of the OAuth 2.0 specification.\nRequest Arguments\nName\nType\nDescription\nRequired\ngrant_type\nString\nType of request. Available grant types are \"password\" and \"refresh_token\".\nTrue\nclient_id\nString\nUsed to identify the client. A client_id of \"sugar\" will automatically create an OAuth Key in the system that is used for \"password\" authentication. A client_id of \"support_portal\" will create an OAuth Key that will allow for portal authentication. Additional client_id's can be created by the administrator in Admin > OAuth Keys to allow for additional grant types. If the client secret is populated, it will be validated against the client id.\nTrue\nclient_secret;\nString\nThe clients secret key.\nTrue\nusername\nString\nThe username of the user authenticating to the system.\nTrue\npassword\nString\nThe plaintext password the user authenticating to the system.\nTrue\nplatform\nString\nThe platform type. Available types are \"base\", \"mobile\", and \"portal\".\nTrue\nRequest for Password Grant Types\n{\n   \"grant_type\":\"password\",\n   \"client_id\":\"sugar\",\n   \"client_secret\":\"\",\n   \"username\":\"admin\",\n   \"password\":\"password\",\n   \"platform\":\"base\"\n}\nRequest for Refresh Token Grant Types\n{\n    \"grant_type\":\"refresh_token\",\n    \"refresh_token\":\"c1be5132-655b-1ca3-fb44-512e36709871\",\n    \"client_id\":\"sugar\",\n    \"client_secret\":\"\",\n    \"platform\":\"base\"\n}\nResponse Arguments\nName\nType\nDescription\naccess_token\nString\nThe access token needed to authenticate for other methods.\nexpires_in\nInteger\nThe length of time until access_token expires in seconds.\ntoken_type", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/oauth2token_POST/index.html"}
{"id": "5152a9305b3e-1", "text": "expires_in\nInteger\nThe length of time until access_token expires in seconds.\ntoken_type\nString\nThe token type. Currently only \"bearer\" is supported.\nnull|\n\u00c2\u00a0\nThe Oauth scope. Normally returned as null.\nrefresh_token\nString\nThe token needed to extend the access_token expiration timeout.\nrefresh_expires_in\nInteger\nThe length of time until refresh_token expires in seconds.\ndownload_token\nString\nThe token used to download images and files.\nResponse\n{\n   \"access_token\":\"802b64c0-5eac-8431-a541-5342d38ac527\",\n   \"expires_in\":3600,\n   \"token_type\":\"bearer\",\n   \"scope\":null,\n   \"refresh_token\":\"85053198-24b1-4521-b1a1-5342d382e0b7\",\n   \"refresh_expires_in\":1209600,\n   \"download_token\":\"8c9b5461-0d95-8d87-6084-5342d357b39e\"\n}\nChange Log\nVersion\nChange\nv10\nAdded /oauth2/token POST endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/oauth2token_POST/index.html"}
{"id": "fef4fb939099-0", "text": "/<module>/file/vcard_import POST\nOverview\n    Imports a person record from a vcard.\nRequest Arguments\nName\nType\nDescription\nRequired\n            format\n        \n            String\n        \n            The data format. Currently accepts 'sugar-html-json'.\n        \n            True\n        \n            module\n        \n            String\n        \n            The name of the module to import the vcard to.\n        \n            True\n        \n            file\n        \n            String\n        \n            The vcard contents.\n        \n            True\n        \nRequest\n{\n   \"format\":\"sugar-html-json\",\n   \"module\":\"Contacts\"\n   \"file\":\"@\\/path\\/to\\/ExampleContact.vcf\"\n}\nResponse Arguments\nName\nType\nDescription\n            file\n        \n            String\n        \n            The id of the imported vcard.\n        \nResponse\n{\n   \"file\":\"2c9e5c09-6824-0d14-f5cb-5130321ac3cf\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/file/vcard_import POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilevcard_import_POST/index.html"}
{"id": "592347db2f1a-0", "text": "/<module> GET\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n            Note that JSON-encoded filters can be specified as query parameters\n            in one of two ways for GET requests:\n            \n                    By specifying individual filter arguments as distinct parameters.\n                    Example: filter[0][id]=1.\n                \n                    By specifying the whole filter as a single JSON-encoded string.\n                    Note that this syntax is currently not supported on certain modules.\n                    Example: filter=[{\"id\":\"1\"}].\n                \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html"}
{"id": "592347db2f1a-1", "text": "False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. Each field may be represented either by string, or by map\n            containing field name and additional field parameters (applicable to link and collection fields).\n            The fields id and date_modified will always be returned.\n            \n            Example: name,account_type,description,{\"name\":\"opportunities\",\"fields\":[\"id\",\"name\",\"sales_status\"],\"order_by\":\"date_closed:desc\"}\n            For more details on additional field parameters, see\n            Relate API and\n            Collection API.\n        \n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \n            q\n        \n            String\n        \n            A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.\n        \n            False\n        \n            deleted\n        \n            Boolean\n        \n            Boolean to show deleted records in the result set.\n        \n            False\n        \n            nulls_last\n        \n            Boolean", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html"}
{"id": "592347db2f1a-2", "text": "False\n        \n            nulls_last\n        \n            Boolean\n        \n            Boolean to return records with null values in order_by fields last in the result set.\n        \n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\nExample\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html"}
{"id": "592347db2f1a-3", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html"}
{"id": "592347db2f1a-4", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\",\n               \"id\": \"b0701501-1fab-8ae7-3942-540da93f5017\",\n               \"name\": \"360 Vacations - 228 Units\",\n               \"date_modified\": \"2014-09-08T16:05:00+03:00\",\n               \"sales_status\": \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html"}
{"id": "592347db2f1a-5", "text": "{\n               _module: \"Opportunities\"\n               date_modified: \"2014-09-08T16:05:00+03:00\"\n               id: \"9ce7c088-8ee4-7cd3-18f1-540da944d4c0\"\n               name: \"360 Vacations - 312 Units\"\n               sales_status: \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html"}
{"id": "8f8e170defab-0", "text": "/integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value PATCH\nOverview\nSets a sync key value for a record.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule\nString\nThe module the record belongs to\nTrue\nrecord_id\nString\nThe ID of the record whose sync key will be set\nTrue\nsync_key_field_name\nString\nThe name of the field that contains sync_key_field_value (the default field is named\u00c2\u00a0sync_key but can be renamed via code customization)\nTrue\nsync_key_field_value\nString\nA unique ID for the record identifying it in an external system\nTrue\nRequest\n/integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value\nResponse\n{\"success\": true}\nChange Log\nVersion\nChange\nv11_10\nAdded /integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value\u00c2\u00a0PATCH endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulerecord_idsync_key_field_namesync_key_field_value_PATCH/index.html"}
{"id": "791ac2baf9c6-0", "text": "/<module>/audit/export GET\nOverview\nReturns a list of data changes for a specific module.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule\nString\nThe name of the module.\nTrue\nQuery Parameters\nName\nType\nDescription\nRequired\nmax_num\nInteger\nA maximum number of Audit records to return. The default is 100 records.\nFalse\noffset\nInteger\nThe number of records to skip over before records are returned. The default is 0.\nFalse\nResponse Arguments\nName\nType\nDescription\nnext_offset\nInteger\nDisplays the next offset for retrieval of additional results. -1 will be returned when there are no more records.\nrecords\nArray\nAn array of results containing matched records.\nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"b569e480-237a-5921-4382-512ff555fee7\",\n         \"parent_id\":\"ef1b40aa-5815-4f8d-e909-512d09617ac8\",\n         \"date_created\":\"03\\/01\\/2013 12:26am\",\n         \"created_by\":\"admin\",\n         \"field_name\":\"Team ID:\",\n         \"data_type\":\"team_list\",\n         \"before_value_string\":\"East\",\n         \"after_value_string\":\"Will\"\n      },\n      {\n         \"id\":\"bc0bee72-8398-a0a6-d731-512ff5bfebc7\",\n         \"parent_id\":\"ef1b40aa-5815-4f8d-e909-512d09617ac8\",\n         \"date_created\":\"03\\/01\\/2013 12:26am\",\n         \"created_by\":\"admin\",\n         \"field_name\":\"Teams\",\n         \"data_type\":\"id\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleauditexport_GET/index.html"}
{"id": "791ac2baf9c6-1", "text": "\"field_name\":\"Teams\",\n         \"data_type\":\"id\",\n         \"before_value_string\":\"East, Global, West\",\n         \"after_value_string\":\"Jim, Will\"\n      }\n   ]\n}\nChange Log\nVersion\nChange\nv11_11\nAdded /<module>/audit/export GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleauditexport_GET/index.html"}
{"id": "b99c60f182fc-0", "text": "/Opportunities/config POST\nOverview\n    Opportunity Config Save\nSummary\n    This saves the config changes to the Opportunity Module, when the opps_view_by attribute changes, it will perform the nessicary migrations for the Metadata and the actual Data.\nRequest Arguments\nName\nType\nDescription\nRequired\n            <config field>\n        \n            <config field type>\n        \n            The list of config fields to update.\n        \n            False\n        \nRequest\n{\n    \"MyConfigOption\":\"MyConfigValue\"\n}\nResponse Arguments\nName\nType\nDescription\n            <config field>\n        \n            <config field type>\n        \n            The list of config fields will be returned.\n        \nResponse\n{\n   \"MyConfigOption\":\"MyConfigValue\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Opportunities/config POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Opportunitiesconfig_POST/index.html"}
{"id": "46d7f13607bd-0", "text": "/Administration/elasticsearch/replicas/status GET\nOverview\n    [ADMIN] Elasticsearch index replica status\nSummary\n    This endpoint returns the number of replicas for every index managed by SugarCRM. This endpoint is only\n    available to administrators.\nResponse\n{\n  \"aabbcc_contactsleads\": \"4\",\n  \"aabbcc_accountsonly\": \"2\",\n  \"aabbcc_shared\": \"1\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Administration/elasticsearch/replicas/status GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchreplicasstatus_GET/index.html"}
{"id": "ea9f394c46dd-0", "text": "/pmse_Inbox GET\nOverview\n    Returns a list of Processes by user using filters\nSummary\n    This endpoint gets a list of processes by user using filters\nRequest Arguments\nName\nType\nDescription\nRequired\norder_by\nstring\nHow to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon.\nfalse\nq\nstring\nA search expression, will search on this module. Cannot be used at the same time as a filter expression or id.\nfalse\nfilter\nstring\nThe filter expression\nfalse\nfilter_id\nstring\nIdentifier for a preexisting filter. If filter is also set, the two filters are joined with an AND\nfalse\nmax_num\ninteger\nA maximum number of records to return. Default is 20.\nfalse\noffset\ninteger\nThe number of records to skip over before records are returned. Default is 0.\nfalse\nfields\nstring\nComma delimited list of fields to return\nfalse\ndeleted\nboolean\nBoolean to show deleted records in the result set.\nfalse\nResponse Arguments\nName\nType\nDescription\nrecords\n<field>:<value>\nProcess records\nnext_offset\ninteger\nNext offset for results\nResponse\n{\n    \"next_offset\":-1,\n    \"records\":\n    [\n        {\n            \"id\":\"839ccd22-2925-11e6-83f3-6c4008960436\",\n            \"date_modified\":\"2016-06-02T17:52:55-07:00\",\n            \"created_by\":\"1\",\n            \"cas_finish_date\":\"\",\n            \"assigned_user_id\":\"1\",\n            \"assigned_user_name\":\"Administrator\",\n            \"assigned_user_link\":\n            {\n                \"full_name\":\"Administrator\",\n                \"id\":\"1\",\n                \"_acl\":\n                {\n                    \"fields\":", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inbox_GET/index.html"}
{"id": "ea9f394c46dd-1", "text": "\"id\":\"1\",\n                \"_acl\":\n                {\n                    \"fields\":\n                    {\n                        \"pwd_last_changed\":\n                        {\n                            \"write\":\"no\",\n                            \"create\":\"no\"\n                        },\n                        \"last_login\":\n                        {\n                            \"write\":\"no\",\n                            \"create\":\"no\"\n                        }\n                    },\n                    \"delete\":\"no\",\n                    \"_hash\":\"08b99a97c2e8d792f7a44d8882b5af6d\"\n                }\n            },\n            \"_acl\":\n            {\n                \"fields\":{}\n            },\n            \"_module\":\"pmse_Project\\/pmse_BpmFlow\",\n            \"_locked_fields\":[],\n            \"cas_id\":\"4\",\n            \"act_assignment_method\":\"static\",\n            \"cas_title\":\"PQR1\",\n            \"pro_title\":\"PD1\",\n            \"date_entered\":\"2016-06-02T17:52:55-07:00\",\n            \"name\":\"PQR1\",\n            \"cas_create_date\":\"2016-06-02T17:52:55-07:00\",\n            \"flow_id\":\"839ccd22-2925-11e6-83f3-6c4008960436\",\n            \"id2\":\"8380e512-2925-11e6-9600-6c4008960436\",\n            \"task_name\":\"Activity # 1\",\n            \"cas_assignment_method\":\"static\",\n            \"cas_sugar_module\":\"Accounts\",\n            \"cas_sugar_object_id\":\"82d5c470-2925-11e6-a269-6c4008960436\",\n            \"prj_id\":\"6e025038-2842-11e6-b4f7-6c4008960436\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inbox_GET/index.html"}
{"id": "ea9f394c46dd-2", "text": "\"in_time\":true,\n            \"cas_user_id\":\"1\",\n            \"prj_created_by\":\"1\",\n            \"cas_user_id_full_name\":\"Administrator\",\n            \"prj_user_id_full_name\":\"Administrator\"\n        },\n    ]\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inbox_GET/index.html"}
{"id": "b543e74905af-0", "text": "/<module>/:record/link/:link_name/filter/count GET\nOverview\n    Lists related filtered records.\nSummary\n    This endpoint will return a set of related records filtered by an expression. The filter can be applied to multiple\n    fields and have multiple and/or conditions in it. Care will need to be taken to make sure this filter has\n    appropriate indexes on the server side otherwise the runtime of the endpoint will be very long. Related fields can\n    be searched by specifying the field name as: \"link_name.remote_field\", so if you wished to search the Accounts\n    module by a related member account you would use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. The field date_modified will always be returned. This argument\n            can be combined with the view argument.\n            \n            Example: name,account_type,description\n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefiltercount_GET/index.html"}
{"id": "b543e74905af-1", "text": "False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefiltercount_GET/index.html"}
{"id": "b543e74905af-2", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefiltercount_GET/index.html"}
{"id": "b543e74905af-3", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nRepsonse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefiltercount_GET/index.html"}
{"id": "b543e74905af-4", "text": "\"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",\n         \"full_name\":\"Dale Spivey\",\n         \"title\":\"VP Operations\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(523) 825-4311\",\n         \"email\":[\n            {\n               \"email_address\":\"sugar.dev.sugar@example.co.jp\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            },\n            {\n               \"email_address\":\"the.support@example.biz\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            }\n         ],\n         \"phone_mobile\":\"(373) 861-0757\",\n         \"phone_work\":\"(212) 542-9596\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"sugar.dev.sugar@example.co.jp\",\n         \"email2\":\"the.support@example.biz\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"345 Sugar Blvd.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"87261\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefiltercount_GET/index.html"}
{"id": "b543e74905af-5", "text": "\"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Campaign\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"DaleSpivey97\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\\/\",\n         \"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefiltercount_GET/index.html"}
{"id": "b543e74905af-6", "text": "\"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Florence\",\n         \"last_name\":\"Haddock\",\n         \"full_name\":\"Florence Haddock\",\n         \"title\":\"Director Sales\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(729) 845-3137\",\n         \"email\":[\n            {\n               \"email_address\":\"dev.vegan@example.de\",\n               \"opt_out\":\"1\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            },\n            {\n               \"email_address\":\"section71@example.it\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            }\n         ],\n         \"phone_mobile\":\"(246) 233-1382\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefiltercount_GET/index.html"}
{"id": "b543e74905af-7", "text": "],\n         \"phone_mobile\":\"(246) 233-1382\",\n         \"phone_work\":\"(565) 696-6981\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"section71@example.it\",\n         \"email2\":\"dev.vegan@example.de\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"111 Silicon Valley Road\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"79900\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Support Portal User Registration\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"FlorenceHaddock169\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$nWFhTbK6$JF9BCGSqL\\/NCrbhueX5ia0\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefiltercount_GET/index.html"}
{"id": "b543e74905af-8", "text": "\"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/link/:link_name/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefiltercount_GET/index.html"}
{"id": "c034cc506073-0", "text": "/<module>/:record/movelast/:target PUT\nOverview\n    Move existing node as last child of target node.\nRequest Arguments\nName\nType\nDescription\nRequired\n                module\n            \n                String\n            \n                The name of sugar module that contains a nested set data and implements the NestedSetInterface.\n            \n                True\n            \n                target\n            \n                String\n            \n                The ID of record that will be used as target to move node as last child\n            \n                True\n            \nResponse Arguments\n    This endpoint does not return any response arguments.\nResponse\nThis endpoint return a record GUID that was moved\n\"1b7b868d-7357-2e29-7513-54169bdc444d\"\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/movelast/:target PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordmovelasttarget_PUT/index.html"}
{"id": "d1566d1b0ade-0", "text": "/pmse_Project/:record/dproject GET\nOverview\n    Exports a .bpm file with a Process Definition\nSummary\n    This endpoint will retrieve a .bpm file containing JSON encoded data of a\n    Process Definition identified by the record input parameter.\nRequest Arguments\nName\nType\nDescription\nRequired\nrecord\nString\nThe Process Definition record ID\nTrue\nResponse Arguments\nName\nType\nDescription\nN/A\nResponse\nNote: The response is a MIME type application/bpm file attachment without any response parameters.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectrecorddproject_GET/index.html"}
{"id": "1f01d0584b35-0", "text": "/Reports/:record/record_count GET\nOverview\n    An API to get total number of filtered records from a saved report.\nSummary\n    This endpoint will return total number of records from a saved report filtered by an expression.\nRequest Arguments\nName\nType\nDescription\nRequired\n            group_filters\n        \n            String\n        \n            The group filter expression. Filter expressions are explained below.\n            Note that JSON-encoded filters can be specified as query parameters\n            in one of two ways for GET requests:\n            \n                    By specifying individual filter arguments as distinct parameters.\n                    Example: group_filters[0][name]=value.\n                \n                    By specifying the whole filter as a single JSON-encoded string.\n                    Example: group_filters=[{\"name\":\"value\"}].\n                \n            Example: group_filters[0][industry]=Engineering.\n        \n            False\n        \n            use_saved_filters\n        \n            Boolean\n        \n            Flag to indicate whether or not to apply saved runtime filters if exists. The default value is false.\n            Example: use_saved_filters=true.\n        \n            False\n        \nRequest Example\nGET /rest/v10/Reports/:id/record_count?group_filters[0][industry]=Engineering\nResponse Arguments\nName\nType\nDescription\n            record_count\n        \n            Integer\n        \n            Total number of filtered records.\n        \nResponse\n{\n   \"record_count\": 5\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Reportsrecordrecord_count_GET/index.html"}
{"id": "f9d19226146f-0", "text": "/me/preference/:preference_name DELETE\nOverview\n    Deletes a specific preference for the current user.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            \u00c2\u00a0\n        \n            \u00c2\u00a0\n        \n            \u00c2\u00a0\n        \nResponse\n{\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /me/preference/:preference_name DELETE endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mepreferencepreference_name_DELETE/index.html"}
{"id": "6441e96a960c-0", "text": "/Administration/elasticsearch/queue GET\nOverview\n    [ADMIN] Elasticsearch queue statistics\nSummary\n    This endpoint returns the queue statistics for the Elasticsearch backend. This endpoint is only available to\n    administrators.\nResponse\n{\n    \"total\":2238,\n    \"queued\":{\n        \"Cases\":\"250\",\n        \"KBDocuments\":\"5\",\n        \"Notes\":\"50\",\n        \"Quotes\":\"2\",\n        \"Accounts\":\"51\",\n        \"Contacts\":\"201\",\n        \"Leads\":\"201\",\n        \"Opportunities\":\"150\",\n        \"RevenueLineItems\":\"578\",\n        \"Bugs\":\"50\",\n        \"Contracts\":\"2\",\n        \"Manufacturers\":\"2\",\n        \"ProductCategories\":\"43\",\n        \"Tasks\":\"200\",\n        \"Calls\":\"50\",\n        \"Emails\":\"200\",\n        \"Meetings\":\"200\",\n        \"Products\":\"3\"\n    }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Administration/elasticsearch/queue GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchqueue_GET/index.html"}
{"id": "eeb735279e4d-0", "text": "/Forecasts GET\nOverview\n    Updates a record of a specified type as a favorite for the current user.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            <record field>\n        \n            <record field type>\n        \n            Returns the fields for the selected record.\n        \nResponse\n{\n   \"id\":\"bdd59d85-687b-1739-b00a-512d09f6db9e\",\n   \"name\":\"Insight Marketing Inc\",\n   \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n   \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n   \"modified_user_id\":\"1\",\n   \"modified_by_name\":\"Administrator\",\n   \"created_by\":\"1\",\n   \"created_by_name\":\"Administrator\",\n   \"description\":\"\",\n   \"img\":\"\",\n   \"last_activity_date\":\"2013-02-26T19:12:00+00:00\",\n   \"deleted\":false,\n   \"assigned_user_id\":\"seed_max_id\",\n   \"assigned_user_name\":\"Max Jensen\",\n   \"team_name\":[\n      {\n         \"id\":\"East\",\n         \"name\":\"East\",\n         \"name_2\":\"\",\n         \"primary\":false\n      },\n      {\n         \"id\":1,\n         \"name\":\"Global\",\n         \"name_2\":\"\",\n         \"primary\":false\n      },\n      {\n         \"id\":\"West\",\n         \"name\":\"West\",\n         \"name_2\":\"\",\n         \"primary\":true\n      }\n   ],\n   \"linkedin\":\"\",\n   \"facebook\":\"\",\n   \"twitter\":\"\",\n   \"googleplus\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecasts_GET/index.html"}
{"id": "eeb735279e4d-1", "text": "\"facebook\":\"\",\n   \"twitter\":\"\",\n   \"googleplus\":\"\",\n   \"account_type\":\"Customer\",\n   \"industry\":\"Electronics\",\n   \"annual_revenue\":\"\",\n   \"phone_fax\":\"\",\n   \"billing_address_street\":\"345 Sugar Blvd.\",\n   \"billing_address_street_2\":\"\",\n   \"billing_address_street_3\":\"\",\n   \"billing_address_street_4\":\"\",\n   \"billing_address_city\":\"San Mateo\",\n   \"billing_address_state\":\"CA\",\n   \"billing_address_postalcode\":\"56019\",\n   \"billing_address_country\":\"USA\",\n   \"rating\":\"\",\n   \"phone_office\":\"(927) 136-9572\",\n   \"phone_alternate\":\"\",\n   \"website\":\"www.sectionvegan.de\",\n   \"ownership\":\"\",\n   \"employees\":\"\",\n   \"ticker_symbol\":\"\",\n   \"shipping_address_street\":\"345 Sugar Blvd.\",\n   \"shipping_address_street_2\":\"\",\n   \"shipping_address_street_3\":\"\",\n   \"shipping_address_street_4\":\"\",\n   \"shipping_address_city\":\"San Mateo\",\n   \"shipping_address_state\":\"CA\",\n   \"shipping_address_postalcode\":\"56019\",\n   \"shipping_address_country\":\"USA\",\n   \"email1\":\"kid.support.vegan@example.info\",\n   \"parent_id\":\"\",\n   \"sic_code\":\"\",\n   \"parent_name\":\"\",\n   \"email_opt_out\":false,\n   \"invalid_email\":false,\n   \"email\":[\n      {\n         \"email_address\":\"kid.support.vegan@example.info\",\n         \"opt_out\":\"0\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"1\"\n      },\n      {\n         \"email_address\":\"phone.kid@example.cn\",\n         \"opt_out\":\"0\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecasts_GET/index.html"}
{"id": "eeb735279e4d-2", "text": "\"email_address\":\"phone.kid@example.cn\",\n         \"opt_out\":\"0\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"0\"\n      }\n   ],\n   \"campaign_id\":\"\",\n   \"campaign_name\":\"\",\n   \"my_favorite\":true,\n   \"_acl\":{\n      \"fields\":{\n      }\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/favorite PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecasts_GET/index.html"}
{"id": "168d14b2ff1f-0", "text": "/recent GET\nOverview\n    Returns all of the current users recently viewed records.\nRequest Arguments\nName\nType\nDescription\nRequired\n            module_list\n        \n            String\n        \n            Comma delimited list of modules to return recently viewed records.\n            \n            Example: Accounts,Contacts\n            True\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. The field date_modified will always be returned.\n            \n            Example: id,name\n            False\n        \n            date\n        \n            String\n        \n            The date expression. Filter recently viewed records from this date.\n        \n            False\n        \n            limit\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \nRequest\nhttp://{site_url}/rest/v10/recent?module_list=Accounts%2CContacts\nNote: GET endpoint parameters are passed in the form of a query string.\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            String\n        \n            The next offset to start fetching additional records.\n        \n            records\n        \n            Array\n        \n            An array of recently viewed records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"e4213959-35cd-119b-5cd6-5342e8be16f6\",\n         \"name\":\"Leila Purifoy\",\n         \"date_entered\":\"2014-04-07T13:58:50-04:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html"}
{"id": "168d14b2ff1f-1", "text": "\"date_modified\":\"2014-04-07T13:58:50-04:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_will_id\",\n         \"assigned_user_name\":\"Will Westin\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":true\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":false\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"support62@example.biz\",\n               \"invalid_email\":false,\n               \"opt_out\":true,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"sales39@example.com\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":true\n            }\n         ],\n         \"email1\":\"sales39@example.com\",\n         \"email2\":\"support62@example.biz\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"salutation\":\"\",\n         \"first_name\":\"Leila\",\n         \"last_name\":\"Purifoy\",\n         \"full_name\":\"Leila Purifoy\",\n         \"title\":\"President\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html"}
{"id": "168d14b2ff1f-2", "text": "\"title\":\"President\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(841) 469-8223\",\n         \"phone_mobile\":\"(286) 010-9553\",\n         \"phone_work\":\"(369) 075-2809\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"primary_address_street\":\"345 Sugar Blvd.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Santa Monica\",\n         \"primary_address_state\":\"NY\",\n         \"primary_address_postalcode\":\"52255\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Trade Show\",\n         \"account_name\":\"Sea Region Inc\",\n         \"account_id\":\"b1cd3a55-7e84-e53b-954e-5342e85b63f1\",\n         \"dnb_principal_id\":\"\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"birthdate\":\"\",\n         \"portal_name\":\"LeilaPurifoy5\",\n         \"portal_active\":true,\n         \"portal_password\":true,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html"}
{"id": "168d14b2ff1f-3", "text": "\"portal_active\":true,\n         \"portal_password\":true,\n         \"portal_password1\":null,\n         \"portal_app\":\"\",\n         \"preferred_language\":\"\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"accept_status_calls\":\"\",\n         \"accept_status_meetings\":\"\",\n         \"sync_contact\":false,\n         \"mkto_sync\":false,\n         \"mkto_id\":null,\n         \"mkto_lead_score\":null,\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Contacts\",\n         \"_last_viewed_date\":\"2014-04-07T14:43:46-04:00\"\n      },\n      {\n         \"my_favorite\":false,\n         \"following\":false,\n         \"id\":\"e8f7eb6d-2647-7e57-df30-5342e83c622d\",\n         \"name\":\"Draft Diversified Energy Inc\",\n         \"date_entered\":\"2014-04-07T13:58:50-04:00\",\n         \"date_modified\":\"2014-04-07T13:58:50-04:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"doc_owner\":\"\",\n         \"description\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_max_id\",\n         \"assigned_user_name\":\"Max Jensen\",\n         \"team_count\":\"\",\n         \"team_name\":[\n            {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html"}
{"id": "168d14b2ff1f-4", "text": "\"team_count\":\"\",\n         \"team_name\":[\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"email\":[\n            {\n               \"email_address\":\"dev.kid.kid@example.de\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":true,\n               \"reply_to_address\":false\n            },\n            {\n               \"email_address\":\"info.sales@example.co.uk\",\n               \"invalid_email\":false,\n               \"opt_out\":false,\n               \"primary_address\":false,\n               \"reply_to_address\":false\n            }\n         ],\n         \"email1\":\"dev.kid.kid@example.de\",\n         \"email2\":\"info.sales@example.co.uk\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"email_addresses_non_primary\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"account_type\":\"Customer\",\n         \"industry\":\"Education\",\n         \"annual_revenue\":\"\",\n         \"phone_fax\":\"\",\n         \"billing_address_street\":\"111 Silicon Valley Road\",\n         \"billing_address_street_2\":\"\",\n         \"billing_address_street_3\":\"\",\n         \"billing_address_street_4\":\"\",\n         \"billing_address_city\":\"Los Angeles\",\n         \"billing_address_state\":\"CA\",\n         \"billing_address_postalcode\":\"26022\",\n         \"billing_address_country\":\"USA\",\n         \"rating\":\"\",\n         \"phone_office\":\"(790) 406-0049\",\n         \"phone_alternate\":\"\",\n         \"website\":\"www.phonesugar.de\",\n         \"ownership\":\"\",\n         \"employees\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html"}
{"id": "168d14b2ff1f-5", "text": "\"ownership\":\"\",\n         \"employees\":\"\",\n         \"ticker_symbol\":\"\",\n         \"shipping_address_street\":\"111 Silicon Valley Road\",\n         \"shipping_address_street_2\":\"\",\n         \"shipping_address_street_3\":\"\",\n         \"shipping_address_street_4\":\"\",\n         \"shipping_address_city\":\"Los Angeles\",\n         \"shipping_address_state\":\"CA\",\n         \"shipping_address_postalcode\":\"26022\",\n         \"shipping_address_country\":\"USA\",\n         \"parent_id\":\"\",\n         \"sic_code\":\"\",\n         \"duns_num\":\"\",\n         \"parent_name\":\"\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Accounts\",\n         \"_last_viewed_date\":\"2014-04-07T14:43:36-04:00\"\n      }\n   ]\n}\nChange Log\nVersion\nAPI\nChange\n            7.2.0\n        \n            v10\n        \n            Added /recent GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html"}
{"id": "cf53f4e31c36-0", "text": "/pmse_Inbox/engine_route PUT\nOverview\n    Evaluates the response of the user form Show Process [Approve, Reject, Route] \nSummary\n    This endpoint handles Approve, Reject and Route actions for a process record.\nRequest Arguments\nName\nType\nDescription\nRequired\nfrm_action\nstring\nThe action to take when it comes to routing the record.\ntrue\nResponse Arguments\nName\nType\nDescription\nsuccess\nboolean\nResult of the routing operation\nResponse\n{\n    \"success\":true,\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxengine_route_PUT/index.html"}
{"id": "3b19c625b9a8-0", "text": "/pmse_Project/EventDefinition/:record GET\nOverview\n    Retrieves the definition data for an event\nSummary\n    This endpoint will retrieve the JSON encoded definition data for the Process\n    Definition event identified by the record input parameter.\nRequest Arguments\nName\nType\nDescription\nRequired\nrecord\nString\nThe value for the evn_uid field in the pmse_bpmn_event record\nTrue\nRequest\nNote: Additional input parameters can be provided in the form\nof a URL query string.\n    /rest/v11/pmse_Project/EventDefinition/632263607573cb74a582507093735454?related=modules\nResponse Arguments\nName\nType\nDescription\n<field>\n<value>\nField value in the pmse_bpmn_activity record\nResponse\n{\n    \"id\":\"80a37c82-8be8-c668-a547-573cb791b905\",\n    \"name\":\"\",\n    \"date_entered\":\"2016-05-18 18:41:29\",\n    \"date_modified\":\"2016-05-18 18:41:42\",\n    \"created_by\":\"1\",\n    \"description\":null,\n    \"deleted\":\"0\",\n    \"evn_status\":\"ACTIVE\",\n    \"evn_type\":\"START\",\n    \"evn_module\":\"Accounts\",\n    \"evn_criteria\":\"\",\n    \"evn_params\":\"new\",\n    \"evn_script\":\"\",\n    \"execution_mode\":\"DEFAULT\",\n    \"au_first_name\":null,\n    \"au_last_name\":null,\n    \"cbu_first_name\":null,\n    \"cbu_last_name\":\"Administrator\",\n    \"mbu_first_name\":null,\n    \"mbu_last_name\":\"Administrator\",\n    \"my_favorite\":null,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_GET/index.html"}
{"id": "3b19c625b9a8-1", "text": "\"mbu_last_name\":\"Administrator\",\n    \"my_favorite\":null,\n    \"evn_uid\":\"632263607573cb74a582507093735454\",\n    \"related\":\n    {\n        \"modules\":\n        [\n            {\n                \"value\":\"Accounts\",\n                \"text\":\"Accounts\"\n            },\n            {\n                \"value\":\"Bugs\",\n                \"text\":\"Bugs\"\n            },\n            {\n                \"value\":\"Calls\",\n                \"text\":\"Calls\"\n            },\n            {\n                \"value\":\"Campaigns\",\n                \"text\":\"Campaigns\"\n            },\n            {\n                \"value\":\"Cases\",\n                \"text\":\"Cases\"\n            },\n            {\n                \"value\":\"Contacts\",\n                \"text\":\"Contacts\"\n            },\n            {\n                \"value\":\"Contracts\",\n                \"text\":\"Contracts\"\n            },\n            {\n                \"value\":\"Documents\",\n                \"text\":\"Documents\"\n            },\n            {\n                \"value\":\"KBContents\",\n                \"text\":\"Knowledge Base\"\n            },\n            {\n                \"value\":\"Leads\",\n                \"text\":\"Leads\"\n            },\n            {\n                \"value\":\"Meetings\",\n                \"text\":\"Meetings\"\n            },\n            {\n                \"value\":\"Notes\",\n                \"text\":\"Notes\"\n            },\n            {\n                \"value\":\"Opportunities\",\n                \"text\":\"Opportunities\"\n            },\n            {\n                \"value\":\"ProductTemplates\",\n                \"text\":\"Product Catalog\"\n            },\n            {\n                \"value\":\"ProjectTask\",\n                \"text\":\"Project Tasks\"\n            },\n            {\n                \"value\":\"Project\",\n                \"text\":\"Projects\"\n            },\n            {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_GET/index.html"}
{"id": "3b19c625b9a8-2", "text": "\"value\":\"Project\",\n                \"text\":\"Projects\"\n            },\n            {\n                \"value\":\"Products\",\n                \"text\":\"Quoted Line Items\"\n            },\n            {\n                \"value\":\"Quotes\",\n                \"text\":\"Quotes\"\n            },\n            {\n                \"value\":\"RevenueLineItems\",\n                \"text\":\"Revenue Line Items\"\n            },\n            {\n                \"value\":\"Prospects\",\n                \"text\":\"Targets\"\n            },\n            {\n                \"value\":\"Tasks\",\n                \"text\":\"Tasks\"\n            }\n        ]\n    }\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_GET/index.html"}
{"id": "4adc7adaaf62-0", "text": "/<module>/:record/link/:link_name GET\nOverview\n    Lists related filtered records.\nSummary\n    This endpoint will return a set of related records filtered by an expression. The filter can be applied to multiple\n    fields and have multiple and/or conditions in it. Care will need to be taken to make sure this filter has\n    appropriate indexes on the server side otherwise the runtime of the endpoint will be very long. Related fields can\n    be searched by specifying the field name as: \"link_name.remote_field\", so if you wished to search the Accounts\n    module by a related member account you would use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. The field date_modified will always be returned. This argument\n            can be combined with the view argument.\n            \n            Example: name,account_type,description\n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html"}
{"id": "4adc7adaaf62-1", "text": "False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html"}
{"id": "4adc7adaaf62-2", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html"}
{"id": "4adc7adaaf62-3", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nRepsonse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html"}
{"id": "4adc7adaaf62-4", "text": "\"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",\n         \"full_name\":\"Dale Spivey\",\n         \"title\":\"VP Operations\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(523) 825-4311\",\n         \"email\":[\n            {\n               \"email_address\":\"sugar.dev.sugar@example.co.jp\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            },\n            {\n               \"email_address\":\"the.support@example.biz\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            }\n         ],\n         \"phone_mobile\":\"(373) 861-0757\",\n         \"phone_work\":\"(212) 542-9596\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"sugar.dev.sugar@example.co.jp\",\n         \"email2\":\"the.support@example.biz\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"345 Sugar Blvd.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"87261\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html"}
{"id": "4adc7adaaf62-5", "text": "\"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Campaign\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"DaleSpivey97\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\\/\",\n         \"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html"}
{"id": "4adc7adaaf62-6", "text": "\"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Florence\",\n         \"last_name\":\"Haddock\",\n         \"full_name\":\"Florence Haddock\",\n         \"title\":\"Director Sales\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(729) 845-3137\",\n         \"email\":[\n            {\n               \"email_address\":\"dev.vegan@example.de\",\n               \"opt_out\":\"1\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            },\n            {\n               \"email_address\":\"section71@example.it\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            }\n         ],\n         \"phone_mobile\":\"(246) 233-1382\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html"}
{"id": "4adc7adaaf62-7", "text": "],\n         \"phone_mobile\":\"(246) 233-1382\",\n         \"phone_work\":\"(565) 696-6981\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"section71@example.it\",\n         \"email2\":\"dev.vegan@example.de\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"111 Silicon Valley Road\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"79900\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Support Portal User Registration\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"FlorenceHaddock169\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$nWFhTbK6$JF9BCGSqL\\/NCrbhueX5ia0\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html"}
{"id": "4adc7adaaf62-8", "text": "\"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/link/:link_name/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_GET/index.html"}
{"id": "b0a8111c28ce-0", "text": "/OutboundEmail POST\nOverview\n    Create a new OutboundEmail configuration to use to send emails over SMTP.\nSummary\n    Each configuration that is created is validated first by attempting to connect to the server.\nRequest Arguments\nName\nType\nDescription\nRequired\n                name\n            \n                String\n            \n                The display name of the configuration.\n            \n                True\n            \n                mail_sendtype\n            \n                String\n            \n                Only SMTP is supported. This field is defaulted to smtp.\n            \n                False\n            \n                mail_smtptype\n            \n                String\n            \n                The email provider through which emails are sent. This is merely a convenience which allows for\n                prepopulating data in the UI. Possible values are: google, exchange, outlook, other. other is the\n                default.\n            \n                False\n            \n                mail_smtpserver\n            \n                String\n            \n                The address of the SMTP server.\n            \n                True\n            \n                mail_smtpport\n            \n                Integer\n            \n                The port on which to connect to the SMTP server. The default is 465, which assumes you are using\n                SSL.\n            \n                False\n            \n                mail_smtpuser\n            \n                String\n            \n                The username for authenticating with the SMTP server. It is only required if mail_smtpauth_req is\n                true.\n            \n                False\n            \n                mail_smtppass\n            \n                String\n            \n                The password for authenticating with the SMTP server. It is only required if mail_smtpauth_req is\n                true.\n            \n                False\n            \n                mail_smtpauth_req\n            \n                Boolean\n            \n                Indicates whether or not the SMTP server requires authentication. The default is false.\n            \n                False\n            \n                mail_smtpssl", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmail_POST/index.html"}
{"id": "b0a8111c28ce-1", "text": "False\n            \n                mail_smtpssl\n            \n                String\n            \n                The encryption protocol used for connecting to the SMTP server. \"0\" represents no encryption.\n                \"1\" represents SSL. \"2\" represents TLS. The default is SSL.\n            \n                False\n            \nRequest\n{\n  \"name\": \"My Exchange Account\",\n  \"mail_smtptype\": \"exchange\",\n  \"mail_smtpserver\": \"smtp.example.com\",\n  \"mail_smtpport\": 465,\n  \"mail_smtpuser\": \"foo@example.com\",\n  \"mail_smtppass\": \"P@55w0rd\",\n  \"mail_smtpauth_req\": true,\n  \"mail_smtpssl\": \"1\"\n}\nResponse Arguments\nName\nType\nDescription\n                name\n            \n                String\n            \n                The display name of the configuration.\n            \n                type\n            \n                String\n            \n                Only user configuration may be created using this endpoint, so user will always be\n                returned. system and system-override configurations are always created by the application.\n            \n                user_id\n            \n                String\n            \n                The current user's ID. The current user may only create configurations for himself or herself.\n            \n                mail_sendtype\n            \n                String\n            \n                Only SMTP is supported, so smtp will always be returned.\n            \n                mail_smtptype\n            \n                String\n            \n                The email provider through which emails are sent. Possible values are: google, exchange, outlook, other.\n            \n                mail_smtpserver\n            \n                String\n            \n                The address of the SMTP server.\n            \n                mail_smtpport\n            \n                Integer\n            \n                The port on which to connect to the SMTP server.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmail_POST/index.html"}
{"id": "b0a8111c28ce-2", "text": "Integer\n            \n                The port on which to connect to the SMTP server.\n            \n                mail_smtpuser\n            \n                String\n            \n                The username for authenticating with the SMTP server.\n            \n                mail_smtppass\n            \n                Boolean\n            \n                Indicates whether or not a password exists. true is returned for this field when a password does\n                exist. This field is not included in the response when a password does not exist.\n            \n                mail_smtpauth_req\n            \n                Boolean\n            \n                Indicates whether or not the SMTP server requires authentication.\n            \n                mail_smtpssl\n            \n                String\n            \n                The encryption protocol used for connecting to the SMTP server.\n            \nResponse\n{\n  \"id\": \"e04ce998-960e-11e6-8628-3c15c2d582c6\",\n  \"name\": \"My Exchange Account\",\n  \"type\": \"user\",\n  \"user_id\": \"e91b1fa7-1bd8-3c71-be96-512e643f9ca4\",\n  \"mail_sendtype\": \"smtp\",\n  \"mail_smtptype\": \"exchange\",\n  \"mail_smtpserver\": \"smtp.example.com\",\n  \"mail_smtpport\": 465,\n  \"mail_smtpuser\": \"foo@example.com\",\n  \"mail_smtppass\": true,\n  \"mail_smtpauth_req\": true,\n  \"mail_smtpssl\": \"1\",\n  \"deleted\": false,\n  \"my_favorite\": false,\n  \"_acl\": {\n    \"fields\": {}\n  },\n  \"_module\": \"OutboundEmail\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /OutboundEmail POST endpoint.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmail_POST/index.html"}
{"id": "b0a8111c28ce-3", "text": "Version\nChange\n            v10\n        \n            Added /OutboundEmail POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmail_POST/index.html"}
{"id": "f560111a823b-0", "text": "/Quotes/config GET\nOverview\n    Quote Config GET Help\nSummary\n    This endpoint returns dependent and related fields for all fields used in the Quoted Line Items\n    area of the Quote record.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            <config field>\n        \n            <config field type>\n        \n            The list of config fields will be returned.\n        \nResponse\n{\n    \"summary_columns\": [\n        {\n            \"name\": \"deal_tot\",\n            \"label\": \"LBL_LIST_DEAL_TOT\",\n            \"css_class\": \"quote-totals-row-item\",\n            \"related_fields\": [\n                \"deal_tot_discount_percentage\"\n            ],\n            \"type\": \"currency\",\n            \"labelModule\": \"Quotes\"\n        },\n        {\n            \"name\": \"new_sub\",\n            \"css_class\": \"quote-totals-row-item\",\n            \"type\": \"currency\",\n            \"label\": \"LBL_NEW_SUB\",\n            \"labelModule\": \"Quotes\"\n        },\n        {\n            \"name\": \"tax\",\n            \"label\": \"LBL_TAX_TOTAL\",\n            \"css_class\": \"quote-totals-row-item\",\n            \"type\": \"currency\",\n            \"labelModule\": \"Quotes\"\n        },\n        {\n            \"name\": \"shipping\",\n            \"css_class\": \"quote-totals-row-item\",\n            \"type\": \"currency\",\n            \"label\": \"LBL_SHIPPING\",\n            \"labelModule\": \"Quotes\"\n        },\n        {\n            \"name\": \"total\",\n            \"label\": \"LBL_LIST_GRAND_TOTAL\",\n            \"css_class\": \"quote-totals-row-item\",\n            \"type\": \"currency\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-1", "text": "\"type\": \"currency\",\n            \"labelModule\": \"Quotes\"\n        }\n    ],\n    \"worksheet_columns\": [\n        {\n            \"name\": \"line_num\",\n            \"label\": null,\n            \"widthClass\": \"cell-xsmall\",\n            \"css_class\": \"line_num tcenter\",\n            \"type\": \"line-num\",\n            \"readonly\": true\n        },\n        {\n            \"name\": \"quantity\",\n            \"label\": \"LBL_QUANTITY\",\n            \"widthClass\": \"cell-small\",\n            \"css_class\": \"quantity\",\n            \"type\": \"float\",\n            \"labelModule\": \"Products\"\n        },\n        {\n            \"name\": \"product_template_name\",\n            \"label\": \"LBL_ITEM_NAME\",\n            \"widthClass\": \"cell-large\",\n            \"type\": \"quote-data-relate\",\n            \"required\": true,\n            \"labelModule\": \"Quotes\"\n        },\n        {\n            \"name\": \"mft_part_num\",\n            \"label\": \"LBL_MFT_PART_NUM\",\n            \"type\": \"base\",\n            \"labelModule\": \"Products\"\n        },\n        {\n            \"name\": \"discount_price\",\n            \"label\": \"LBL_DISCOUNT_PRICE\",\n            \"type\": \"currency\",\n            \"convertToBase\": true,\n            \"showTransactionalAmount\": true,\n            \"related_fields\": [\n                \"discount_price\",\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"labelModule\": \"Products\"\n        },\n        {\n            \"name\": \"discount\",\n            \"type\": \"fieldset\",\n            \"css_class\": \"quote-discount-percent\",\n            \"label\": \"LBL_DISCOUNT_AMOUNT\",\n            \"fields\": [\n                {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-2", "text": "\"label\": \"LBL_DISCOUNT_AMOUNT\",\n            \"fields\": [\n                {\n                    \"name\": \"discount_amount\",\n                    \"label\": \"LBL_DISCOUNT_AMOUNT\",\n                    \"type\": \"discount\",\n                    \"convertToBase\": true,\n                    \"showTransactionalAmount\": true\n                },\n                {\n                    \"type\": \"discount-select\",\n                    \"name\": \"discount_select\",\n                    \"no_default_action\": true,\n                    \"buttons\": [\n                        {\n                            \"type\": \"rowaction\",\n                            \"name\": \"select_discount_amount_button\",\n                            \"label\": \"LBL_DISCOUNT_AMOUNT\",\n                            \"event\": \"button:discount_select_change:click\"\n                        },\n                        {\n                            \"type\": \"rowaction\",\n                            \"name\": \"select_discount_percent_button\",\n                            \"label\": \"LBL_DISCOUNT_PERCENT\",\n                            \"event\": \"button:discount_select_change:click\"\n                        }\n                    ],\n                    \"label\": \"LBL_DISCOUNT_AS_PERCENT\"\n                }\n            ],\n            \"labelModule\": \"Products\"\n        },\n        {\n            \"name\": \"total_amount\",\n            \"label\": \"LBL_LINE_ITEM_TOTAL\",\n            \"type\": \"currency\",\n            \"widthClass\": \"cell-medium\",\n            \"showTransactionalAmount\": true,\n            \"related_fields\": [\n                \"total_amount\",\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"labelModule\": \"Quotes\"\n        }\n    ],\n    \"footer_rows\": [\n        {\n            \"name\": \"new_sub\",\n            \"type\": \"currency\"\n        },\n        {\n            \"name\": \"tax\",\n            \"type\": \"currency\"\n        },\n        {\n            \"name\": \"shipping\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-3", "text": "},\n        {\n            \"name\": \"shipping\",\n            \"type\": \"quote-footer-currency\",\n            \"css_class\": \"quote-footer-currency\",\n            \"default\": \"0.00\"\n        },\n        {\n            \"name\": \"total\",\n            \"type\": \"currency\",\n            \"css_class\": \"grand-total\"\n        }\n    ],\n    \"summary_columns_related_fields\": [\n        \"base_rate\",\n        \"deal_tot\",\n        \"deal_tot_usdollar\",\n        \"shipping\",\n        \"subtotal\",\n        \"subtotal_usdollar\",\n        \"tax\",\n        \"taxable_subtotal\"\n    ],\n    \"worksheet_columns_related_fields\": [\n        \"base_rate\",\n        \"deal_calc\",\n        \"discount_amount\",\n        \"discount_price\",\n        \"discount_select\",\n        \"quantity\",\n        \"subtotal\",\n        \"tax_class\",\n        \"total_amount\",\n        \"description\",\n        \"quote_id\",\n        \"name\",\n        \"product_template_id\",\n        \"product_template_name\"\n    ],\n    \"footer_rows_related_fields\": [\n        \"deal_tot\",\n        \"deal_tot_usdollar\",\n        \"shipping\",\n        \"subtotal\",\n        \"subtotal_usdollar\",\n        \"tax\",\n        \"taxable_subtotal\"\n    ],\n    \"dependentFields\": {\n        \"Quotes\": {\n            \"currency_id\": {\n                \"related\": {\n                    \"subtotal\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"subtotal\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"discount\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"discount\",\n                        \"reason\": \"related_fields\"\n                    },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-4", "text": "\"field\": \"discount\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"new_sub\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"new_sub\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"tax\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"tax\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"shipping\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"shipping\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"subtotal_usdollar\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"subtotal_usdollar\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"base_rate\": {\n                \"related\": {\n                    \"subtotal\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"subtotal\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"discount\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"discount\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"new_sub\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"new_sub\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"tax\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"tax\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"shipping\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"shipping\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"subtotal_usdollar\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"subtotal_usdollar\",\n                        \"reason\": \"related_fields\"\n                    }\n                },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-5", "text": "\"reason\": \"related_fields\"\n                    }\n                },\n                \"locked\": {\n                    \"subtotal_usdollar\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"subtotal_usdollar\",\n                        \"reason\": \"formula\"\n                    },\n                    \"deal_tot_usdollar\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"deal_tot_usdollar\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            },\n            \"taxable_subtotal\": {\n                \"locked\": {\n                    \"tax\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"tax\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"tax\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"tax\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"taxrate_value\": {\n                \"locked\": {\n                    \"tax\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"tax\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"tax\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"tax\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"subtotal_usdollar\": {\n                \"locked\": {\n                    \"deal_tot_discount_percentage\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"deal_tot_discount_percentage\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            },\n            \"subtotal\": {\n                \"locked\": {\n                    \"subtotal_usdollar\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"subtotal_usdollar\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-6", "text": "\"module\": \"Quotes\",\n                        \"field\": \"subtotal_usdollar\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            },\n            \"deal_tot_usdollar\": {\n                \"locked\": {\n                    \"deal_tot_discount_percentage\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"deal_tot_discount_percentage\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            },\n            \"deal_tot\": {\n                \"locked\": {\n                    \"deal_tot_usdollar\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"deal_tot_usdollar\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            },\n            \"tax\": {\n                \"locked\": {\n                    \"total\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"total\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            },\n            \"shipping\": {\n                \"locked\": {\n                    \"total\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"total\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            }\n        },\n        \"ProductBundles\": {\n            \"subtotal\": {\n                \"locked\": {\n                    \"new_sub\": {\n                        \"module\": \"ProductBundles\",\n                        \"field\": \"new_sub\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            },\n            \"currency_id\": {\n                \"related\": {\n                    \"subtotal\": {\n                        \"module\": \"ProductBundles\",\n                        \"field\": \"subtotal\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"deal_tot\": {\n                        \"module\": \"ProductBundles\",\n                        \"field\": \"deal_tot\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-7", "text": "\"module\": \"ProductBundles\",\n                        \"field\": \"deal_tot\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"new_sub\": {\n                        \"module\": \"ProductBundles\",\n                        \"field\": \"new_sub\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"base_rate\": {\n                \"related\": {\n                    \"subtotal\": {\n                        \"module\": \"ProductBundles\",\n                        \"field\": \"subtotal\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"deal_tot\": {\n                        \"module\": \"ProductBundles\",\n                        \"field\": \"deal_tot\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"new_sub\": {\n                        \"module\": \"ProductBundles\",\n                        \"field\": \"new_sub\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"new_sub\": {\n                \"locked\": {\n                    \"new_sub\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"new_sub\",\n                        \"reason\": \"rollup\"\n                    },\n                    \"total\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"total\",\n                        \"reason\": \"rollup\"\n                    }\n                }\n            },\n            \"deal_tot\": {\n                \"locked\": {\n                    \"new_sub\": {\n                        \"module\": \"ProductBundles\",\n                        \"field\": \"new_sub\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            },\n            \"taxable_subtotal\": {\n                \"locked\": {\n                    \"taxable_subtotal\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"taxable_subtotal\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-8", "text": "\"module\": \"Quotes\",\n                        \"field\": \"taxable_subtotal\",\n                        \"reason\": \"rollup\"\n                    }\n                }\n            }\n        },\n        \"Products\": {\n            \"subtotal\": {\n                \"locked\": {\n                    \"subtotal\": {\n                        \"module\": \"ProductBundles\",\n                        \"field\": \"subtotal\",\n                        \"reason\": \"rollup\"\n                    }\n                }\n            },\n            \"quantity\": {\n                \"locked\": {\n                    \"total_amount\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"total_amount\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"discount_price\": {\n                \"locked\": {\n                    \"total_amount\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"total_amount\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"currency_id\": {\n                \"related\": {\n                    \"discount_price\": {\n                        \"module\": \"Products\",\n                        \"field\": \"discount_price\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"discount_amount\": {\n                        \"module\": \"Products\",\n                        \"field\": \"discount_amount\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"total_amount\": {\n                        \"module\": \"Products\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-9", "text": "},\n                    \"total_amount\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"base_rate\": {\n                \"related\": {\n                    \"discount_price\": {\n                        \"module\": \"Products\",\n                        \"field\": \"discount_price\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"discount_amount\": {\n                        \"module\": \"Products\",\n                        \"field\": \"discount_amount\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"total_amount\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"deal_calc\": {\n                \"locked\": {\n                    \"deal_tot\": {\n                        \"module\": \"ProductBundles\",\n                        \"field\": \"deal_tot\",\n                        \"reason\": \"rollup\"\n                    }\n                }\n            },\n            \"discount_select\": {\n                \"related\": {\n                    \"discount_amount\": {\n                        \"module\": \"Products\",\n                        \"field\": \"discount_amount\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"total_amount\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"related_fields\"\n                    }\n                },\n                \"locked\": {\n                    \"total_amount\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            },\n            \"discount_amount\": {\n                \"locked\": {\n                    \"total_amount\": {\n                        \"module\": \"Products\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-10", "text": "\"total_amount\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"total_amount\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"total_amount\": {\n                \"locked\": {\n                    \"taxable_subtotal\": {\n                        \"module\": \"ProductBundles\",\n                        \"field\": \"taxable_subtotal\",\n                        \"reason\": \"rollup\"\n                    }\n                }\n            },\n            \"tax_class\": {\n                \"locked\": {\n                    \"taxable_subtotal\": {\n                        \"module\": \"ProductBundles\",\n                        \"field\": \"taxable_subtotal\",\n                        \"reason\": \"rollup\"\n                    }\n                }\n            }\n        }\n    },\n    \"relatedFields\": {\n        \"Products\": {\n            \"name\": {\n                \"locked\": {\n                    \"product_template_name\": {\n                        \"module\": \"Products\",\n                        \"field\": \"name\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            },\n            \"subtotal\": {\n                \"locked\": {\n                    \"quantity\": {\n                        \"module\": \"Products\",\n                        \"field\": \"subtotal\",\n                        \"reason\": \"formula\"\n                    },\n                    \"discount_price\": {\n                        \"module\": \"Products\",\n                        \"field\": \"subtotal\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Products\",\n                        \"field\": \"subtotal\",\n                        \"reason\": \"related_fields\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-11", "text": "\"field\": \"subtotal\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Products\",\n                        \"field\": \"subtotal\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"discount_price\": {\n                        \"module\": \"Products\",\n                        \"field\": \"subtotal\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"quantity\": {\n                        \"module\": \"Products\",\n                        \"field\": \"subtotal\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"total_amount\": {\n                \"locked\": {\n                    \"quantity\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"formula\"\n                    },\n                    \"discount_price\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"formula\"\n                    },\n                    \"discount_select\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"formula\"\n                    },\n                    \"discount_amount\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"quantity\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"related_fields\"\n                    },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-12", "text": "\"reason\": \"related_fields\"\n                    },\n                    \"discount_price\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"discount_select\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"discount_amount\": {\n                        \"module\": \"Products\",\n                        \"field\": \"total_amount\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"manufacturer_name\": {\n                \"related\": {\n                    \"manufacturer_id\": {\n                        \"module\": \"Products\",\n                        \"field\": \"manufacturer_name\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"cost_price\": {\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Products\",\n                        \"field\": \"cost_price\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Products\",\n                        \"field\": \"cost_price\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"discount_price\": {\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Products\",\n                        \"field\": \"discount_price\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Products\",\n                        \"field\": \"discount_price\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"discount_amount\": {\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Products\",\n                        \"field\": \"discount_amount\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-13", "text": "\"module\": \"Products\",\n                        \"field\": \"discount_amount\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Products\",\n                        \"field\": \"discount_amount\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"discount_select\": {\n                        \"module\": \"Products\",\n                        \"field\": \"discount_amount\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"discount_rate_percent\": {\n                \"locked\": {\n                    \"discount_price\": {\n                        \"module\": \"Products\",\n                        \"field\": \"discount_rate_percent\",\n                        \"reason\": \"formula\"\n                    },\n                    \"discount_amount\": {\n                        \"module\": \"Products\",\n                        \"field\": \"discount_rate_percent\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            },\n            \"discount_amount_usdollar\": {\n                \"locked\": {\n                    \"discount_amount\": {\n                        \"module\": \"Products\",\n                        \"field\": \"discount_amount_usdollar\",\n                        \"reason\": \"formula\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Products\",\n                        \"field\": \"discount_amount_usdollar\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            },\n            \"deal_calc\": {\n                \"locked\": {\n                    \"discount_select\": {\n                        \"module\": \"Products\",\n                        \"field\": \"deal_calc\",\n                        \"reason\": \"formula\"\n                    },\n                    \"discount_price\": {\n                        \"module\": \"Products\",\n                        \"field\": \"deal_calc\",\n                        \"reason\": \"formula\"\n                    },\n                    \"quantity\": {\n                        \"module\": \"Products\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-14", "text": "},\n                    \"quantity\": {\n                        \"module\": \"Products\",\n                        \"field\": \"deal_calc\",\n                        \"reason\": \"formula\"\n                    },\n                    \"discount_amount\": {\n                        \"module\": \"Products\",\n                        \"field\": \"deal_calc\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Products\",\n                        \"field\": \"deal_calc\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Products\",\n                        \"field\": \"deal_calc\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"discount_price\": {\n                        \"module\": \"Products\",\n                        \"field\": \"deal_calc\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"quantity\": {\n                        \"module\": \"Products\",\n                        \"field\": \"deal_calc\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"discount_amount\": {\n                        \"module\": \"Products\",\n                        \"field\": \"deal_calc\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"deal_calc_usdollar\": {\n                \"locked\": {\n                    \"deal_calc\": {\n                        \"module\": \"Products\",\n                        \"field\": \"deal_calc_usdollar\",\n                        \"reason\": \"formula\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Products\",\n                        \"field\": \"deal_calc_usdollar\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Products\",\n                        \"field\": \"deal_calc_usdollar\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-15", "text": "\"module\": \"Products\",\n                        \"field\": \"deal_calc_usdollar\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Products\",\n                        \"field\": \"deal_calc_usdollar\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"list_price\": {\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Products\",\n                        \"field\": \"list_price\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Products\",\n                        \"field\": \"list_price\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"cost_usdollar\": {\n                \"locked\": {\n                    \"cost_price\": {\n                        \"module\": \"Products\",\n                        \"field\": \"cost_usdollar\",\n                        \"reason\": \"formula\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Products\",\n                        \"field\": \"cost_usdollar\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Products\",\n                        \"field\": \"cost_usdollar\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Products\",\n                        \"field\": \"cost_usdollar\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"discount_usdollar\": {\n                \"locked\": {\n                    \"discount_price\": {\n                        \"module\": \"Products\",\n                        \"field\": \"discount_usdollar\",\n                        \"reason\": \"formula\"\n                    },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-16", "text": "\"reason\": \"formula\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Products\",\n                        \"field\": \"discount_usdollar\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            },\n            \"list_usdollar\": {\n                \"locked\": {\n                    \"list_price\": {\n                        \"module\": \"Products\",\n                        \"field\": \"list_usdollar\",\n                        \"reason\": \"formula\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Products\",\n                        \"field\": \"list_usdollar\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Products\",\n                        \"field\": \"list_usdollar\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Products\",\n                        \"field\": \"list_usdollar\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"book_value\": {\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Products\",\n                        \"field\": \"book_value\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Products\",\n                        \"field\": \"book_value\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"book_value_usdollar\": {\n                \"locked\": {\n                    \"book_value\": {\n                        \"module\": \"Products\",\n                        \"field\": \"book_value_usdollar\",\n                        \"reason\": \"formula\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Products\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-17", "text": "},\n                    \"base_rate\": {\n                        \"module\": \"Products\",\n                        \"field\": \"book_value_usdollar\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Products\",\n                        \"field\": \"book_value_usdollar\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Products\",\n                        \"field\": \"book_value_usdollar\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"date_closed_timestamp\": {\n                \"locked\": {\n                    \"date_closed\": {\n                        \"module\": \"Products\",\n                        \"field\": \"date_closed_timestamp\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            }\n        },\n        \"Quotes\": {\n            \"subtotal\": {\n                \"locked\": {\n                    \"product_bundles\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"subtotal\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"subtotal\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"subtotal\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"subtotal_usdollar\": {\n                \"locked\": {\n                    \"subtotal\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"subtotal_usdollar\",\n                        \"reason\": \"formula\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Quotes\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-18", "text": "},\n                    \"base_rate\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"subtotal_usdollar\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"subtotal_usdollar\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"subtotal_usdollar\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"shipping\": {\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"shipping\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"shipping\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"shipping_usdollar\": {\n                \"locked\": {\n                    \"shipping\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"shipping_usdollar\",\n                        \"reason\": \"formula\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"shipping_usdollar\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"shipping_usdollar\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"shipping_usdollar\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-19", "text": "\"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"discount\": {\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"discount\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"discount\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"deal_tot\": {\n                \"locked\": {\n                    \"product_bundles\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"deal_tot\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            },\n            \"deal_tot_discount_percentage\": {\n                \"locked\": {\n                    \"subtotal_usdollar\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"deal_tot_discount_percentage\",\n                        \"reason\": \"formula\"\n                    },\n                    \"deal_tot_usdollar\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"deal_tot_discount_percentage\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            },\n            \"deal_tot_usdollar\": {\n                \"locked\": {\n                    \"deal_tot\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"deal_tot_usdollar\",\n                        \"reason\": \"formula\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"deal_tot_usdollar\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            },\n            \"new_sub\": {\n                \"locked\": {\n                    \"product_bundles\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"new_sub\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-20", "text": "\"module\": \"Quotes\",\n                        \"field\": \"new_sub\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"new_sub\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"new_sub\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"new_sub_usdollar\": {\n                \"locked\": {\n                    \"new_sub\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"new_sub_usdollar\",\n                        \"reason\": \"formula\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"new_sub_usdollar\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"new_sub_usdollar\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"new_sub_usdollar\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"taxable_subtotal\": {\n                \"locked\": {\n                    \"product_bundles\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"taxable_subtotal\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            },\n            \"tax\": {\n                \"locked\": {\n                    \"taxable_subtotal\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"tax\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-21", "text": "\"module\": \"Quotes\",\n                        \"field\": \"tax\",\n                        \"reason\": \"formula\"\n                    },\n                    \"taxrate_value\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"tax\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"tax\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"tax\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"taxrate_value\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"tax\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"taxable_subtotal\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"tax\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"tax_usdollar\": {\n                \"locked\": {\n                    \"tax\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"tax_usdollar\",\n                        \"reason\": \"formula\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"tax_usdollar\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"tax_usdollar\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"tax_usdollar\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-22", "text": "\"reason\": \"related_fields\"\n                    }\n                }\n            },\n            \"total\": {\n                \"locked\": {\n                    \"product_bundles\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"total\",\n                        \"reason\": \"formula\"\n                    },\n                    \"tax\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"total\",\n                        \"reason\": \"formula\"\n                    },\n                    \"shipping\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"total\",\n                        \"reason\": \"formula\"\n                    }\n                }\n            },\n            \"total_usdollar\": {\n                \"locked\": {\n                    \"total\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"total_usdollar\",\n                        \"reason\": \"formula\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"total_usdollar\",\n                        \"reason\": \"formula\"\n                    }\n                },\n                \"related\": {\n                    \"currency_id\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"total_usdollar\",\n                        \"reason\": \"related_fields\"\n                    },\n                    \"base_rate\": {\n                        \"module\": \"Quotes\",\n                        \"field\": \"total_usdollar\",\n                        \"reason\": \"related_fields\"\n                    }\n                }\n            }\n        }\n    },\n    \"productsFields\": {\n        \"date_entered\": {\n            \"type\": \"datetime\",\n            \"studio\": {\n                \"portaleditview\": false\n            },\n            \"readonly\": true,\n            \"label\": \"LBL_DATE_ENTERED\"\n        },\n        \"date_modified\": {\n            \"type\": \"datetime\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-23", "text": "},\n        \"date_modified\": {\n            \"type\": \"datetime\",\n            \"studio\": {\n                \"portaleditview\": false\n            },\n            \"readonly\": true,\n            \"label\": \"LBL_DATE_MODIFIED\"\n        },\n        \"modified_by_name\": {\n            \"type\": \"relate\",\n            \"link\": \"modified_user_link\",\n            \"readonly\": true,\n            \"label\": \"LBL_MODIFIED\"\n        },\n        \"created_by_name\": {\n            \"type\": \"relate\",\n            \"link\": \"created_by_link\",\n            \"readonly\": true,\n            \"label\": \"LBL_CREATED\"\n        },\n        \"description\": {\n            \"type\": \"text\",\n            \"label\": \"LBL_DESCRIPTION\"\n        },\n        \"revenuelineitem_name\": {\n            \"type\": \"relate\",\n            \"link\": \"revenuelineitems\",\n            \"studio\": \"visible\",\n            \"label\": \"LBL_REVENUELINEITEM_NAME\"\n        },\n        \"product_template_name\": {\n            \"type\": \"relate\",\n            \"link\": \"product_templates_link\",\n            \"studio\": {\n                \"editview\": false,\n                \"detailview\": false,\n                \"quickcreate\": false\n            },\n            \"label\": \"LBL_PRODUCT_TEMPLATE\"\n        },\n        \"subtotal\": {\n            \"type\": \"currency\",\n            \"default\": \"0\",\n            \"related_fields\": [\n                \"currency_id\",\n                \"base_rate\",\n                \"discount_price\",\n                \"quantity\"\n            ],\n            \"label\": \"LBL_SUBTOTAL\"\n        },\n        \"total_amount\": {\n            \"default\": \"0.00\",\n            \"type\": \"currency\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-24", "text": "\"default\": \"0.00\",\n            \"type\": \"currency\",\n            \"related_fields\": [\n                \"currency_id\",\n                \"base_rate\",\n                \"quantity\",\n                \"discount_price\",\n                \"discount_select\",\n                \"discount_amount\"\n            ],\n            \"label\": \"LBL_CALCULATED_LINE_ITEM_AMOUNT\"\n        },\n        \"contact_name\": {\n            \"type\": \"relate\",\n            \"link\": \"contact_link\",\n            \"label\": \"LBL_CONTACT_NAME\"\n        },\n        \"manufacturer_name\": {\n            \"type\": \"relate\",\n            \"link\": \"manufacturers\",\n            \"related_fields\": [\n                \"manufacturer_id\"\n            ],\n            \"label\": \"LBL_MANUFACTURER_NAME\"\n        },\n        \"category_name\": {\n            \"type\": \"relate\",\n            \"link\": \"product_categories_link\",\n            \"studio\": {\n                \"editview\": false,\n                \"detailview\": false,\n                \"quickcreate\": false\n            },\n            \"label\": \"LBL_CATEGORY_NAME\"\n        },\n        \"mft_part_num\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_MFT_PART_NUM\"\n        },\n        \"vendor_part_num\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_VENDOR_PART_NUM\"\n        },\n        \"date_purchased\": {\n            \"type\": \"date\",\n            \"label\": \"LBL_DATE_PURCHASED\"\n        },\n        \"discount_rate_percent\": {\n            \"type\": \"decimal\",\n            \"label\": \"LBL_DISCOUNT_RATE\"\n        },\n        \"discount_amount_usdollar\": {\n            \"type\": \"currency\",\n            \"studio\": {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-25", "text": "\"type\": \"currency\",\n            \"studio\": {\n                \"editview\": false,\n                \"mobile\": false\n            },\n            \"label\": \"LBL_DISCOUNT_RATE_USDOLLAR\"\n        },\n        \"discount_select\": {\n            \"type\": \"bool\",\n            \"default\": true,\n            \"label\": \"LBL_DISCOUNT_AS_PERCENT\"\n        },\n        \"deal_calc\": {\n            \"type\": \"currency\",\n            \"related_fields\": [\n                \"currency_id\",\n                \"base_rate\",\n                \"discount_price\",\n                \"quantity\",\n                \"discount_amount\"\n            ],\n            \"label\": \"LBL_DISCOUNT_TOTAL\"\n        },\n        \"deal_calc_usdollar\": {\n            \"type\": \"currency\",\n            \"studio\": {\n                \"editview\": false,\n                \"mobile\": false\n            },\n            \"related_fields\": [\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"label\": \"LBL_DISCOUNT_TOTAL_USDOLLAR\"\n        },\n        \"list_price\": {\n            \"type\": \"currency\",\n            \"related_fields\": [\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"label\": \"LBL_LIST_PRICE\"\n        },\n        \"cost_usdollar\": {\n            \"type\": \"currency\",\n            \"studio\": {\n                \"editview\": false,\n                \"mobile\": false\n            },\n            \"related_fields\": [\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"label\": \"LBL_COST_USDOLLAR\"\n        },\n        \"discount_usdollar\": {\n            \"type\": \"currency\",\n            \"studio\": {\n                \"editview\": false,\n                \"mobile\": false", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-26", "text": "\"studio\": {\n                \"editview\": false,\n                \"mobile\": false\n            },\n            \"label\": \"LBL_DISCOUNT_USDOLLAR\"\n        },\n        \"list_usdollar\": {\n            \"type\": \"currency\",\n            \"studio\": {\n                \"editview\": false,\n                \"mobile\": false\n            },\n            \"related_fields\": [\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"label\": \"LBL_LIST_USDOLLAR\"\n        },\n        \"tax_class\": {\n            \"type\": \"enum\",\n            \"default\": \"Taxable\",\n            \"label\": \"LBL_TAX_CLASS\"\n        },\n        \"website\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_URL\"\n        },\n        \"weight\": {\n            \"type\": \"decimal\",\n            \"label\": \"LBL_WEIGHT\"\n        },\n        \"quantity\": {\n            \"type\": \"decimal\",\n            \"default\": true,\n            \"label\": \"LBL_QUANTITY\"\n        },\n        \"support_name\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_SUPPORT_NAME\"\n        },\n        \"support_description\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_SUPPORT_DESCRIPTION\"\n        },\n        \"support_contact\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_SUPPORT_CONTACT\"\n        },\n        \"support_term\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_SUPPORT_TERM\"\n        },\n        \"date_support_expires\": {\n            \"type\": \"date\",\n            \"label\": \"LBL_DATE_SUPPORT_EXPIRES\"\n        },\n        \"date_support_starts\": {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-27", "text": "},\n        \"date_support_starts\": {\n            \"type\": \"date\",\n            \"label\": \"LBL_DATE_SUPPORT_STARTS\"\n        },\n        \"pricing_formula\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_PRICING_FORMULA\"\n        },\n        \"pricing_factor\": {\n            \"type\": \"int\",\n            \"label\": \"LBL_PRICING_FACTOR\"\n        },\n        \"serial_number\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_SERIAL_NUMBER\"\n        },\n        \"asset_number\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_ASSET_NUMBER\"\n        },\n        \"book_value\": {\n            \"type\": \"currency\",\n            \"related_fields\": [\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"label\": \"LBL_BOOK_VALUE\"\n        },\n        \"book_value_usdollar\": {\n            \"type\": \"currency\",\n            \"studio\": {\n                \"editview\": false,\n                \"mobile\": false\n            },\n            \"related_fields\": [\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"label\": \"LBL_BOOK_VALUE_USDOLLAR\"\n        },\n        \"book_value_date\": {\n            \"type\": \"date\",\n            \"label\": \"LBL_BOOK_VALUE_DATE\"\n        },\n        \"date_closed\": {\n            \"type\": \"date\",\n            \"label\": \"LBL_DATE_CLOSED\"\n        },\n        \"next_step\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_NEXT_STEP\"\n        },\n        \"campaign_name\": {\n            \"type\": \"relate\",\n            \"link\": \"campaign_products\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-28", "text": "\"type\": \"relate\",\n            \"link\": \"campaign_products\",\n            \"label\": \"LBL_CAMPAIGN\"\n        },\n        \"opportunity_name\": {\n            \"type\": \"relate\",\n            \"link\": \"opportunities\",\n            \"label\": \"LBL_OPPORTUNITY_NAME\"\n        },\n        \"type_name\": {\n            \"type\": \"relate\",\n            \"link\": \"product_types_link\",\n            \"label\": \"LBL_TYPE\"\n        },\n        \"tag\": {\n            \"type\": \"tag\",\n            \"link\": \"tag_link\",\n            \"studio\": {\n                \"portal\": false,\n                \"base\": {\n                    \"popuplist\": false\n                },\n                \"mobile\": {\n                    \"wirelesseditview\": true,\n                    \"wirelessdetailview\": true\n                }\n            },\n            \"sortable\": false,\n            \"label\": \"LBL_TAGS\"\n        },\n        \"team_name\": {\n            \"type\": \"relate\",\n            \"link\": \"team_link\",\n            \"studio\": {\n                \"portallistview\": false,\n                \"portalrecordview\": false\n            },\n            \"label\": \"LBL_TEAMS\"\n        },\n        \"base_rate\": {\n            \"type\": \"text\",\n            \"label\": \"LBL_CURRENCY_RATE\"\n        },\n        \"name\": {\n            \"type\": \"name\",\n            \"link\": true,\n            \"label\": \"LBL_NAME\",\n            \"default\": true\n        },\n        \"account_name\": {\n            \"type\": \"relate\",\n            \"link\": \"account_link\",\n            \"label\": \"LBL_ACCOUNT_NAME\",\n            \"related_fields\": [\n                \"account_id\"\n            ]", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-29", "text": "\"related_fields\": [\n                \"account_id\"\n            ]\n        },\n        \"status\": {\n            \"type\": \"enum\",\n            \"default\": \"\",\n            \"label\": \"LBL_STATUS\"\n        },\n        \"quote_name\": {\n            \"type\": \"relate\",\n            \"link\": true,\n            \"label\": \"LBL_ASSOCIATED_QUOTE\",\n            \"related_fields\": [\n                \"quote_id\"\n            ],\n            \"default\": true\n        },\n        \"discount_price\": {\n            \"type\": \"currency\",\n            \"default\": \"0\",\n            \"related_fields\": [\n                \"discount_price\",\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"label\": \"LBL_DISCOUNT_PRICE\"\n        },\n        \"cost_price\": {\n            \"type\": \"currency\",\n            \"related_fields\": [\n                \"cost_price\",\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"label\": \"LBL_COST_PRICE\"\n        },\n        \"discount_amount\": {\n            \"type\": \"discount\",\n            \"default\": \"0\",\n            \"related_fields\": [\n                \"discount_select\",\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"label\": \"LBL_DISCOUNT_AMOUNT\"\n        },\n        \"assigned_user_name\": {\n            \"link\": \"assigned_user_link\",\n            \"type\": \"relate\",\n            \"label\": \"LBL_ASSIGNED_TO\"\n        }\n    },\n    \"quotesFields\": {\n        \"modified_by_name\": {\n            \"type\": \"relate\",\n            \"link\": \"modified_user_link\",\n            \"readonly\": true,\n            \"label\": \"LBL_MODIFIED\"\n        },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-30", "text": "\"readonly\": true,\n            \"label\": \"LBL_MODIFIED\"\n        },\n        \"created_by_name\": {\n            \"type\": \"relate\",\n            \"link\": \"created_by_link\",\n            \"readonly\": true,\n            \"label\": \"LBL_CREATED\"\n        },\n        \"description\": {\n            \"type\": \"text\",\n            \"label\": \"LBL_DESCRIPTION\"\n        },\n        \"shipper_name\": {\n            \"type\": \"relate\",\n            \"link\": \"shippers\",\n            \"label\": \"LBL_SHIPPING_PROVIDER\"\n        },\n        \"taxrate_name\": {\n            \"type\": \"relate\",\n            \"link\": \"taxrates\",\n            \"label\": \"LBL_TAXRATE\"\n        },\n        \"show_line_nums\": {\n            \"type\": \"bool\",\n            \"default\": 1,\n            \"label\": \"LBL_SHOW_LINE_NUMS\"\n        },\n        \"quote_type\": {\n            \"type\": \"enum\",\n            \"label\": \"LBL_QUOTE_TYPE\"\n        },\n        \"original_po_date\": {\n            \"type\": \"date\",\n            \"label\": \"LBL_ORIGINAL_PO_DATE\"\n        },\n        \"payment_terms\": {\n            \"type\": \"enum\",\n            \"label\": \"LBL_PAYMENT_TERMS\"\n        },\n        \"date_quote_closed\": {\n            \"type\": \"date\",\n            \"label\": \"LBL_DATE_QUOTE_CLOSED\"\n        },\n        \"date_order_shipped\": {\n            \"type\": \"date\",\n            \"label\": \"LBL_LIST_DATE_QUOTE_CLOSED\"\n        },\n        \"order_stage\": {\n            \"type\": \"enum\",\n            \"label\": \"LBL_ORDER_STAGE\"\n        },\n        \"purchase_order_num\": {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-31", "text": "},\n        \"purchase_order_num\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_PURCHASE_ORDER_NUM\"\n        },\n        \"subtotal\": {\n            \"type\": \"currency\",\n            \"related_fields\": [\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"label\": \"LBL_SUBTOTAL\"\n        },\n        \"subtotal_usdollar\": {\n            \"type\": \"currency\",\n            \"studio\": {\n                \"wirelesseditview\": false,\n                \"wirelessdetailview\": false,\n                \"wirelesslistview\": false,\n                \"wireless_basic_search\": false,\n                \"wireless_advanced_search\": false,\n                \"mobile\": false\n            },\n            \"related_fields\": [\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"label\": \"LBL_SUBTOTAL_USDOLLAR\"\n        },\n        \"shipping\": {\n            \"type\": \"currency\",\n            \"related_fields\": [\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"default\": \"0\",\n            \"label\": \"LBL_SHIPPING\"\n        },\n        \"shipping_usdollar\": {\n            \"type\": \"currency\",\n            \"studio\": {\n                \"wirelesseditview\": false,\n                \"wirelessdetailview\": false,\n                \"wirelesslistview\": false,\n                \"wireless_basic_search\": false,\n                \"wireless_advanced_search\": false,\n                \"mobile\": false\n            },\n            \"related_fields\": [\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"label\": \"LBL_SHIPPING_USDOLLAR\"\n        },\n        \"discount\": {\n            \"type\": \"currency\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-32", "text": "},\n        \"discount\": {\n            \"type\": \"currency\",\n            \"default\": \"0\",\n            \"related_fields\": [\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"label\": \"LBL_DISCOUNT_TOTAL\"\n        },\n        \"deal_tot\": {\n            \"type\": \"currency\",\n            \"label\": \"LBL_DEAL_TOT\"\n        },\n        \"deal_tot_discount_percentage\": {\n            \"type\": \"float\",\n            \"default\": \"0\",\n            \"label\": \"LBL_DEAL_TOT_PERCENTAGE\"\n        },\n        \"deal_tot_usdollar\": {\n            \"type\": \"currency\",\n            \"studio\": {\n                \"wirelesseditview\": false,\n                \"wirelessdetailview\": false,\n                \"wirelesslistview\": false,\n                \"wireless_basic_search\": false,\n                \"wireless_advanced_search\": false,\n                \"mobile\": false\n            },\n            \"label\": \"LBL_DEAL_TOT_USDOLLAR\"\n        },\n        \"new_sub\": {\n            \"type\": \"currency\",\n            \"related_fields\": [\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"label\": \"LBL_NEW_SUB\"\n        },\n        \"new_sub_usdollar\": {\n            \"type\": \"currency\",\n            \"studio\": {\n                \"wirelesseditview\": false,\n                \"wirelessdetailview\": false,\n                \"wirelesslistview\": false,\n                \"wireless_basic_search\": false,\n                \"wireless_advanced_search\": false,\n                \"mobile\": false\n            },\n            \"related_fields\": [\n                \"currency_id\",\n                \"base_rate\"\n            ],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-33", "text": "\"currency_id\",\n                \"base_rate\"\n            ],\n            \"label\": \"LBL_NEW_SUB_USDOLLAR\"\n        },\n        \"taxable_subtotal\": {\n            \"type\": \"currency\",\n            \"label\": \"LBL_TAXABLE_SUBTOTAL\"\n        },\n        \"tax\": {\n            \"type\": \"currency\",\n            \"related_fields\": [\n                \"currency_id\",\n                \"base_rate\",\n                \"taxrate_value\",\n                \"taxable_subtotal\"\n            ],\n            \"default\": \"0\",\n            \"label\": \"LBL_TAX\"\n        },\n        \"tax_usdollar\": {\n            \"type\": \"currency\",\n            \"studio\": {\n                \"wirelesseditview\": false,\n                \"wirelessdetailview\": false,\n                \"wirelesslistview\": false,\n                \"wireless_basic_search\": false,\n                \"wireless_advanced_search\": false,\n                \"mobile\": false\n            },\n            \"related_fields\": [\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"label\": \"LBL_TAX_USDOLLAR\"\n        },\n        \"billing_address_street\": {\n            \"type\": \"text\",\n            \"label\": \"LBL_BILLING_ADDRESS_STREET\"\n        },\n        \"billing_address_city\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_BILLING_ADDRESS_CITY\"\n        },\n        \"billing_address_state\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_BILLING_ADDRESS_STATE\"\n        },\n        \"billing_address_postalcode\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_BILLING_ADDRESS_POSTAL_CODE\"\n        },\n        \"billing_address_country\": {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-34", "text": "},\n        \"billing_address_country\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_BILLING_ADDRESS_COUNTRY\"\n        },\n        \"shipping_address_street\": {\n            \"type\": \"text\",\n            \"label\": \"LBL_SHIPPING_ADDRESS_STREET\"\n        },\n        \"shipping_address_city\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_SHIPPING_ADDRESS_CITY\"\n        },\n        \"shipping_address_state\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_SHIPPING_ADDRESS_STATE\"\n        },\n        \"shipping_address_postalcode\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_SHIPPING_ADDRESS_POSTAL_CODE\"\n        },\n        \"shipping_address_country\": {\n            \"type\": \"varchar\",\n            \"label\": \"LBL_SHIPPING_ADDRESS_COUNTRY\"\n        },\n        \"shipping_account_name\": {\n            \"type\": \"relate\",\n            \"link\": \"shipping_accounts\",\n            \"label\": \"LBL_SHIPPING_ACCOUNT_NAME\"\n        },\n        \"shipping_contact_name\": {\n            \"type\": \"relate\",\n            \"link\": \"shipping_contacts\",\n            \"label\": \"LBL_SHIPPING_CONTACT_NAME\"\n        },\n        \"shipping_contact_id\": {\n            \"type\": \"relate\",\n            \"link\": \"shipping_contacts\",\n            \"label\": \"LBL_SHIPPING_CONTACT_ID\"\n        },\n        \"billing_contact_name\": {\n            \"type\": \"relate\",\n            \"link\": \"billing_contacts\",\n            \"label\": \"LBL_BILLING_CONTACT_NAME\"\n        },\n        \"billing_contact_id\": {\n            \"type\": \"relate\",\n            \"link\": \"billing_contacts\",\n            \"label\": \"LBL_BILLING_CONTACT_ID\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-35", "text": "\"label\": \"LBL_BILLING_CONTACT_ID\"\n        },\n        \"bundles\": {\n            \"type\": \"collection\",\n            \"label\": \"LBL_PRODUCT_BUNDLES\"\n        },\n        \"opportunity_name\": {\n            \"type\": \"relate\",\n            \"link\": \"opportunities\",\n            \"label\": \"LBL_OPPORTUNITY_NAME\"\n        },\n        \"opportunity_id\": {\n            \"type\": \"relate\",\n            \"link\": \"opportunities\",\n            \"label\": \"LBL_OPPORTUNITY_ID\"\n        },\n        \"tag\": {\n            \"type\": \"tag\",\n            \"link\": \"tag_link\",\n            \"studio\": {\n                \"portal\": false,\n                \"base\": {\n                    \"popuplist\": false\n                },\n                \"mobile\": {\n                    \"wirelesseditview\": true,\n                    \"wirelessdetailview\": true\n                }\n            },\n            \"sortable\": false,\n            \"label\": \"LBL_TAGS\"\n        },\n        \"team_name\": {\n            \"type\": \"relate\",\n            \"link\": \"team_link\",\n            \"studio\": {\n                \"portallistview\": false,\n                \"portalrecordview\": false\n            },\n            \"label\": \"LBL_TEAMS\"\n        },\n        \"base_rate\": {\n            \"type\": \"text\",\n            \"label\": \"LBL_CURRENCY_RATE\"\n        },\n        \"quote_num\": {\n            \"type\": \"int\",\n            \"readonly\": true,\n            \"label\": \"LBL_LIST_QUOTE_NUM\",\n            \"default\": true\n        },\n        \"name\": {\n            \"type\": \"name\",\n            \"label\": \"LBL_LIST_QUOTE_NAME\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-36", "text": "\"type\": \"name\",\n            \"label\": \"LBL_LIST_QUOTE_NAME\",\n            \"default\": true,\n            \"link\": true\n        },\n        \"billing_account_name\": {\n            \"type\": \"relate\",\n            \"link\": \"billing_accounts\",\n            \"label\": \"LBL_LIST_ACCOUNT_NAME\",\n            \"default\": true,\n            \"sortable\": false\n        },\n        \"quote_stage\": {\n            \"type\": \"enum\",\n            \"label\": \"LBL_QUOTE_STAGE\",\n            \"default\": true\n        },\n        \"total\": {\n            \"type\": \"currency\",\n            \"label\": \"LBL_TOTAL\",\n            \"default\": true,\n            \"related_fields\": [\n                \"currency_id\"\n            ]\n        },\n        \"total_usdollar\": {\n            \"type\": \"currency\",\n            \"studio\": {\n                \"wirelesseditview\": false,\n                \"wirelessdetailview\": false,\n                \"wirelesslistview\": false,\n                \"wireless_basic_search\": false,\n                \"wireless_advanced_search\": false,\n                \"mobile\": false\n            },\n            \"related_fields\": [\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"label\": \"LBL_LIST_AMOUNT_USDOLLAR\",\n            \"default\": true\n        },\n        \"date_quote_expected_closed\": {\n            \"type\": \"date\",\n            \"label\": \"LBL_LIST_DATE_QUOTE_EXPECTED_CLOSED\",\n            \"default\": true\n        },\n        \"assigned_user_name\": {\n            \"link\": \"assigned_user_link\",\n            \"type\": \"relate\",\n            \"label\": \"LBL_LIST_ASSIGNED_TO_NAME\",\n            \"default\": true,\n            \"sortable\": false\n        },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "f560111a823b-37", "text": "\"default\": true,\n            \"sortable\": false\n        },\n        \"date_modified\": {\n            \"type\": \"datetime\",\n            \"studio\": {\n                \"portaleditview\": false\n            },\n            \"readonly\": true,\n            \"default\": true,\n            \"label\": \"LBL_DATE_MODIFIED\"\n        },\n        \"date_entered\": {\n            \"type\": \"datetime\",\n            \"studio\": {\n                \"portaleditview\": false\n            },\n            \"readonly\": true,\n            \"default\": true,\n            \"label\": \"LBL_DATE_ENTERED\"\n        }\n    }\n}\nChange Log\nVersion\nChange\n            v11.3\n        \n            Added /Quotes/config GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_GET/index.html"}
{"id": "8cb4fac91111-0", "text": "/pmse_Inbox/userListByTeam/:id GET\nOverview\n    Deprecated endpoint.\nSummary\nThis endpoint is deprecated and will be removed in a future release.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxuserListByTeamid_GET/index.html"}
{"id": "9f0f0aca3caa-0", "text": "/globalsearch POST\nOverview\n    Global search\nSummary\n    This endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the\n    /search endpoint. This endpoint can be used with a long list of request arguments. Instead of using GET request\n    arguments, all described arguments can be used inside a JSON encoded request body using a the GET request. If your\n    client has no support for GET requests with a body, the POST method can be used as an alternative.\nRequest Arguments\nName\nType\nDescription\nRequired\n            q\n        \n            String\n        \n            The search expression. Multiple terms can be specified at once. All enabled fields will be searched in. The\n            results are ordered by relevance which is based on a multitude of settings based on token counts, hit\n            ratio, (weighted) boost values and type of field. Currently no operators are supported in the search\n            expression itself. By refining the search expression more relevant results will be returned as top results.\n            If no search expression is given results are returned based on last modified date.\n        \n            False\n        \n            module_list\n        \n            String\n        \n            Comma delimited list of modules to search. If omitted, all search enabled modules will be queried. Note that\n            when consuming the endpoint /:module/globalsearch that this parameter is ignored.\n            \n            Example: Accounts,Contacts\n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            highlights\n        \n            Boolean\n        \n            Wether or not to return highlighted results. Default is true.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/globalsearch_POST/index.html"}
{"id": "9f0f0aca3caa-1", "text": "Wether or not to return highlighted results. Default is true.\n        \n            False\n        \n            sort\n        \n            Array\n        \n            Define the sort order of the results. By default the results are returned by relevance which is the\n            preferred approach. Using this argument any search enabled field can be used to sort on. Keep in mind the\n            not sorting by relevance may have a negative performance impact.\n            \n            Example: {\"date_modified\":\"desc\",\"name\":\"asc\"}\n            False\n        \nRequest\n{\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /globalsearch GET/POST endpoint.\n        \n            v10\n        \n            Added /:module/globalsearch GET/POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/globalsearch_POST/index.html"}
{"id": "5d58541d4bdb-0", "text": "/connector/twitter/currentUser GET\nOverview\n    Responds with twitter timeline if connector is set up in administration\nRequest Arguments\nName\nType\nDescription\nRequired\ncount\nInteger\nThe number of tweets to retrieve.\nFalse\nResponse Arguments\nName\nType\nDescription\n            <response>\n        \n            String\n        \nResponse\n[\n   {\n      \"created_at\":\"Tue Jun 25 23:45:35 +0000 2013\",\n      \"id\":349674766946414592,\n      \"id_str\":\"349674766946414592\",\n      \"text\":\"this tweet is awesome!\",\n      \"source\":\"web\",\n      \"truncated\":false,\n      \"in_reply_to_status_id\":null,\n      \"in_reply_to_status_id_str\":null,\n      \"in_reply_to_user_id\":143456975,\n      \"in_reply_to_user_id_str\":\"14934565\",\n      \"in_reply_to_screen_name\":\"testdesk\",\n      \"user\":{\n         \"id\":2630841,\n         \"id_str\":\"2630841\",\n         \"name\":\"SugarCRM\",\n         \"screen_name\":\"sugarcrm\",\n         \"location\":\"Cupertino, CA\",\n         \"description\":\"Everyone Sells. Everyone Supports. Everyone Connects.\",\n         \"url\":\"http:\\/\\/t.co\\/s9ejrBSlki\",\n         \"entities\":{\n            \"url\":{\n               \"urls\":[\n                  {\n                     \"url\":\"http:\\/\\/t.co\\/s9ejrBSlki\",\n                     \"expanded_url\":\"http:\\/\\/www.sugarcrm.com\",\n                     \"display_url\":\"sugarcrm.com\",\n                     \"indices\":[\n                        0,\n                        22\n                     ]\n                  }\n               ]\n            },\n            \"description\":{\n               \"urls\":[\n               ]", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittercurrentUser_GET/index.html"}
{"id": "5d58541d4bdb-1", "text": "]\n            },\n            \"description\":{\n               \"urls\":[\n               ]\n            }\n         },\n         \"protected\":false,\n         \"followers_count\":8761,\n         \"friends_count\":6966,\n         \"listed_count\":453,\n         \"created_at\":\"Wed Mar 28 07:16:58 +0000 2007\",\n         \"favourites_count\":27,\n         \"utc_offset\":-28800,\n         \"time_zone\":\"Pacific Time (US \\u0026 Canada)\",\n         \"geo_enabled\":false,\n         \"verified\":false,\n         \"statuses_count\":7488,\n         \"lang\":\"en\",\n         \"contributors_enabled\":false,\n         \"is_translator\":false,\n         \"profile_background_color\":\"98C7EA\",\n         \"profile_background_image_url\":\"http:\\/\\/a0.twimg.com\\/profile_background_images\\/551274192\\/sugar-twitter-background.png\",\n         \"profile_background_image_url_https\":\"https:\\/\\/si0.twimg.com\\/profile_background_images\\/551274192\\/sugar-twitter-background.png\",\n         \"profile_background_tile\":false,\n         \"profile_image_url\":\"http:\\/\\/a0.twimg.com\\/profile_images\\/2027721183\\/Sugar_cube_RGB_180x180_normal.png\",\n         \"profile_image_url_https\":\"https:\\/\\/si0.twimg.com\\/profile_images\\/2027721183\\/Sugar_cube_RGB_180x180_normal.png\",\n         \"profile_link_color\":\"0045AD\",\n         \"profile_sidebar_border_color\":\"FFFFFF\",\n         \"profile_sidebar_fill_color\":\"CCEAFF\",\n         \"profile_text_color\":\"000000\",\n         \"profile_use_background_image\":true,\n         \"default_profile\":false,\n         \"default_profile_image\":false,\n         \"following\":null,\n         \"follow_request_sent\":false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittercurrentUser_GET/index.html"}
{"id": "5d58541d4bdb-2", "text": "\"following\":null,\n         \"follow_request_sent\":false,\n         \"notifications\":null\n      },\n      \"geo\":null,\n      \"coordinates\":null,\n      \"place\":null,\n      \"contributors\":null,\n      \"retweet_count\":1,\n      \"favorite_count\":0,\n      \"entities\":{\n         \"hashtags\":[\n         ],\n         \"symbols\":[\n         ],\n         \"urls\":[\n         ],\n         \"user_mentions\":[\n            {\n               \"screen_name\":\"testdesk\",\n               \"name\":\"testdesk\",\n               \"id\":143455,\n               \"id_str\":\"ertrt75\",\n               \"indices\":[\n                  0,\n                  8\n               ]\n            }\n         ],\n         \"media\":[\n         ]\n      },\n      \"favorited\":false,\n      \"retweeted\":false,\n      \"possibly_sensitive\":false,\n      \"lang\":\"en\"\n   }\n]\nChange Log\nVersion\nChange\n            v10\n        \n            Added /twitter/{twitterId} GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittercurrentUser_GET/index.html"}
{"id": "5a975fb3a45d-0", "text": "/pmse_Inbox/reassignFlows PUT\nOverview\n    Call methods to reassign processes \nSummary\n    This endpoint reassigns a collection of processes \nRequest Arguments\nName\nType\nDescription\nRequired\nflow_data\narray\nCollection of flow data arrays, each containing a user_id property\ntrue\nResponse Arguments\nName\nType\nDescription\nsuccess\nboolean\nResult of the reassign operation\nResponse\n{\n    \"success\":true,\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxreassignFlows_PUT/index.html"}
{"id": "4a3b2cfeb112-0", "text": "/Emails/filter POST\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n        \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. The field date_modified will always be returned.\n            \n            Example: name,account_type,description\n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html"}
{"id": "4a3b2cfeb112-1", "text": "constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example\n    you would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html"}
{"id": "4a3b2cfeb112-2", "text": "Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\nThere are two module expressions, they operate on modules instead of fields. The current module can be specified by\neither using the module name \"_this\" or by leaving the module name as a blank string. The example expression would", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html"}
{"id": "4a3b2cfeb112-3", "text": "filter the records in the current module to only your favorites. The only currently accepted module expressions are\n\"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html"}
{"id": "4a3b2cfeb112-4", "text": "\"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",\n         \"full_name\":\"Dale Spivey\",\n         \"title\":\"VP Operations\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(523) 825-4311\",\n         \"email\":[\n            {\n               \"email_address\":\"sugar.dev.sugar@example.co.jp\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            },\n            {\n               \"email_address\":\"the.support@example.biz\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            }\n         ],\n         \"phone_mobile\":\"(373) 861-0757\",\n         \"phone_work\":\"(212) 542-9596\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"sugar.dev.sugar@example.co.jp\",\n         \"email2\":\"the.support@example.biz\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"345 Sugar Blvd.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"87261\",\n         \"primary_address_country\":\"USA\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html"}
{"id": "4a3b2cfeb112-5", "text": "\"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Campaign\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"DaleSpivey97\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\\/\",\n         \"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html"}
{"id": "4a3b2cfeb112-6", "text": "\"name\":\"Florence Haddock\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Florence\",\n         \"last_name\":\"Haddock\",\n         \"full_name\":\"Florence Haddock\",\n         \"title\":\"Director Sales\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(729) 845-3137\",\n         \"email\":[\n            {\n               \"email_address\":\"dev.vegan@example.de\",\n               \"opt_out\":\"1\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            },\n            {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html"}
{"id": "4a3b2cfeb112-7", "text": "\"primary_address\":\"0\"\n            },\n            {\n               \"email_address\":\"section71@example.it\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            }\n         ],\n         \"phone_mobile\":\"(246) 233-1382\",\n         \"phone_work\":\"(565) 696-6981\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"section71@example.it\",\n         \"email2\":\"dev.vegan@example.de\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"111 Silicon Valley Road\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"79900\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Support Portal User Registration\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html"}
{"id": "4a3b2cfeb112-8", "text": "\"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"FlorenceHaddock169\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$nWFhTbK6$JF9BCGSqL\\/NCrbhueX5ia0\",\n         \"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html"}
{"id": "df8b54321d25-0", "text": "/VCardDownload GET\nOverview\n    Downloads a vCard.\nRequest Arguments\nName\nType\nDescription\nRequired\n            id\n        \n            String\n        \n            The id of the vcard.\n        \n            True\n        \n            module\n        \n            String\n        \n            The name of the module to get the vcard from.\n        \n            True\n        \nRequest\nhttp://{site_url}/rest/v10/VCardDownload?id=2c9e5c09-6824-0d14-f5cb-5130321ac3cf&module=Contacts\nNote: GET endpoint parameters are passed in the form of a query string.\nResponse Arguments\nName\nType\nDescription\n            <vcard information>\n        \n            String;\n        \n            Record in vcard format.\n        \nResponse\nBEGIN:VCARD\nN;CHARSET=utf-8:Leone;Rosemarie;;\nFN;CHARSET=utf-8: Rosemarie Leone\nBDAY:\nTEL;WORK;FAX:\nTEL;HOME;CHARSET=utf-8:(692) 586-8287\nTEL;CELL;CHARSET=utf-8:(117) 577-0969\nTEL;WORK;CHARSET=utf-8:(844) 325-7679\nEMAIL;INTERNET;CHARSET=utf-8:support.im@example.it\nADR;WORK;CHARSET=utf-8:;;777 West Filmore Ln;San Mateo;CA;74984;USA\nORG;CHARSET=utf-8:Q.R.&E. Corp;\nTITLE;CHARSET=utf-8:Director Sales\nEND:VCARD\nChange Log\nVersion\nChange\n            v10\n        \n            Added /VCardDownload GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/VCardDownload_GET/index.html"}
{"id": "38b2cbc86385-0", "text": "/<module>/:record/link/:link_name/count GET\nOverview\n    Lists related filtered records.\nSummary\n    This endpoint will return a set of related records filtered by an expression. The filter can be applied to multiple\n    fields and have multiple and/or conditions in it. Care will need to be taken to make sure this filter has\n    appropriate indexes on the server side otherwise the runtime of the endpoint will be very long. Related fields can\n    be searched by specifying the field name as: \"link_name.remote_field\", so if you wished to search the Accounts\n    module by a related member account you would use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. The field date_modified will always be returned. This argument\n            can be combined with the view argument.\n            \n            Example: name,account_type,description\n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html"}
{"id": "38b2cbc86385-1", "text": "False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html"}
{"id": "38b2cbc86385-2", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html"}
{"id": "38b2cbc86385-3", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nRepsonse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html"}
{"id": "38b2cbc86385-4", "text": "\"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",\n         \"full_name\":\"Dale Spivey\",\n         \"title\":\"VP Operations\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(523) 825-4311\",\n         \"email\":[\n            {\n               \"email_address\":\"sugar.dev.sugar@example.co.jp\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            },\n            {\n               \"email_address\":\"the.support@example.biz\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            }\n         ],\n         \"phone_mobile\":\"(373) 861-0757\",\n         \"phone_work\":\"(212) 542-9596\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"sugar.dev.sugar@example.co.jp\",\n         \"email2\":\"the.support@example.biz\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"345 Sugar Blvd.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"87261\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html"}
{"id": "38b2cbc86385-5", "text": "\"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Campaign\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"DaleSpivey97\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\\/\",\n         \"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html"}
{"id": "38b2cbc86385-6", "text": "\"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Florence\",\n         \"last_name\":\"Haddock\",\n         \"full_name\":\"Florence Haddock\",\n         \"title\":\"Director Sales\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(729) 845-3137\",\n         \"email\":[\n            {\n               \"email_address\":\"dev.vegan@example.de\",\n               \"opt_out\":\"1\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            },\n            {\n               \"email_address\":\"section71@example.it\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            }\n         ],\n         \"phone_mobile\":\"(246) 233-1382\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html"}
{"id": "38b2cbc86385-7", "text": "],\n         \"phone_mobile\":\"(246) 233-1382\",\n         \"phone_work\":\"(565) 696-6981\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"section71@example.it\",\n         \"email2\":\"dev.vegan@example.de\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"111 Silicon Valley Road\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"79900\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Support Portal User Registration\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"FlorenceHaddock169\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$nWFhTbK6$JF9BCGSqL\\/NCrbhueX5ia0\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html"}
{"id": "38b2cbc86385-8", "text": "\"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/link/:link_name/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html"}
{"id": "4700a038a97a-0", "text": "/pmse_Inbox/changeCaseUser/:cas_id GET\nOverview\n    Deprecated endpoint.\nSummary\nThis endpoint is deprecated and will be removed in a future release.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxchangeCaseUsercas_id_GET/index.html"}
{"id": "827e213a1a3c-0", "text": "/pmse_Inbox/save_notes POST\nOverview\n    Creates a new note for a process\nSummary\nThis endpoint creates a new note for a process\nRequest Arguments\nName\nType\nDescription\nRequired\ndata\narray\nCollection of data for a note containing the following:\ntrue\ndata.cas_id\nstring\nThe id of the process trigger sequence\ntrue\ndata.cas_index\nstring\nThe step in the process\ntrue\ndata.not_content\nstring\nThe content of the note\ntrue\ndata.not_type\nstring\nThe type of note, defaults to 'GENERAL'\nfalse\nResponse Arguments\nName\nType\nDescription\nsuccess\nboolean\nResult of the update\nid\nstring\nId of new note\ndate_entered\ndate\nDate of creation\nResponse\n{\n    \"success\":true,\n    \"id\":\"06c075d0-28e7-11e6-8bb1-6c4008960436\",\n    \"date_entered\":\"2016-06-02T10:25:39-07:00\"\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxsave_notes_POST/index.html"}
{"id": "f2d7decfb3ca-0", "text": "/integrate/<module>/:sync_key_field_name/:sync_key_field_value PUT\nOverview\nUpserts based on sync_key_field_name. If a record can be found with sync_key_field_name, then update. If the record does not exist, then create it.\u00c2\u00a0Note that the PATCH method is recommended over the PUT method.\nNote:\u00c2\u00a0This endpoint cannot be used to set the sync_key_field_name for an existing Sugar record. To do so, it is recommended to use the set sync key endpoint to update the matching Sugar record ID. Once the sync_key_field_name is set for the record, then it is possible to leverage this endpoint.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule\nString\nThe module the record belongs to\nTrue\nsync_key_field_name\nString\nThe name of the field that contains sync_key_field_value (the default field is named\u00c2\u00a0sync_key but can be renamed via code customization)\nTrue\nsync_key_field_value\nString\nA unique ID for the record identifying it in an external system\nTrue\nRequest\n/integrate/<module>/:sync_key_field_name/:sync_key_field_value\nResponse Arguments\nName\nType\nDescription\nrecord\nString\nThe ID of the record that was upserted.\nResponse\nStatus 201: For a created record\nStatus 200: For an updated record\n{    record: \"a0328573-a252-a27c-3530-4e4297d4c9e1\"} \nChange Log\nVersion\nChange\nv11_10\nAdded /integrate/<module>/:sync_key_field_name/:sync_key_field_value\u00c2\u00a0PUT endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulesync_key_field_namesync_key_field_value_PUT/index.html"}
{"id": "f277a6503a69-0", "text": "/pmse_Inbox/settings PUT\nOverview\n    Update settings for the SugarBPMTM engine\nSummary\n    This endpoint updates settings for the SugarBPMTM engine\nRequest Arguments\nName\nType\nDescription\nRequired\ndata\narray\nKey/value map of config keys and their associated values for the SugarBPMTM engine to update\nfalse\nResponse Arguments\nName\nType\nDescription\nsuccess\nboolean\nResult of update\ndata\nobject\nKey/Value map of config keys and their new values\nResponse\n{\n    \"success\":true,\n    \"data\":\n    {\n        \"logger_level\":\"critical\",\n        \"error_number_of_cycles\":\"10\",\n        \"error_timeout\":\"40\"\n    }\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxsettings_PUT/index.html"}
{"id": "ebca27356043-0", "text": "/pmse_Project/validateCrmData/:data/:filter GET\nOverview\nValidates information about Fields, Modules, Users, Roles, etc.\nSummary\nThis endpoint will validate the existence of various data related to the Process Definition.\nRequest Arguments\nName\nType\nDescription\nRequired\ndata\nString\nThe type of data to be retrieved\nTrue\nfilter\nString\nFiltering criteria to be applied to data retrieved\nFalse\nkey\nString\nKey of the entry to search for within the given data and filter\nTrue\nRequest\nNote: \"key\" should be provided in the form of a URL query string.\nExample Request:\n/rest/v11_10/pmse_Project/validateCrmData/field/Accounts?key=data_entered\nResponse Arguments\nName\nType\nDescription\nresult\nBoolean\nThe result of the validation. True if the key exists in the specified data set; false otherwise\nResponse\n{\n    result: true\n}\nChange Log\nVersion\nChange\nv11_10\nAdded /pmse_Project/validateCrmData/:data/:filter\u00c2\u00a0GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectvalidateCrmDatadatafilter_GET/index.html"}
{"id": "e4dc023c9224-0", "text": "/pmse_Business_Rules/file/businessrules_import POST\nOverview\n    Imports a Process Business Rules definition from a .pbr file\nSummary\n    This endpoint will import a Process Business Rules definition from the\n    uploaded .pbr file containing JSON encoded data.\nRequest Arguments\nName\nType\nDescription\nRequired\nN/A\nRequest\nNote: A JSON encoded .pbr file attachment should be included with\nthe request as part of the form-data.\nResponse Arguments\nName\nType\nDescription\nbusinessrules_import\nObject\nResult of the import operation\nResponse\n{\n    \"businessrules_import\":\n    {\n         \"success\":true,\n         \"id\":\"e4396c91-81cd-c097-8149-5733bab68316\"\n    }\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Business_Rulesfilebusinessrules_import_POST/index.html"}
{"id": "328f6f016a92-0", "text": "/<module>/filter/count GET\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n        \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. The field date_modified will always be returned.\n            \n            Example: name,account_type,description\n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_GET/index.html"}
{"id": "328f6f016a92-1", "text": "constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example\n    you would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_GET/index.html"}
{"id": "328f6f016a92-2", "text": "Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\nThere are two module expressions, they operate on modules instead of fields. The current module can be specified by\neither using the module name \"_this\" or by leaving the module name as a blank string. The example expression would", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_GET/index.html"}
{"id": "328f6f016a92-3", "text": "filter the records in the current module to only your favorites. The only currently accepted module expressions are\n\"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_GET/index.html"}
{"id": "328f6f016a92-4", "text": "\"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",\n         \"full_name\":\"Dale Spivey\",\n         \"title\":\"VP Operations\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(523) 825-4311\",\n         \"email\":[\n            {\n               \"email_address\":\"sugar.dev.sugar@example.co.jp\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            },\n            {\n               \"email_address\":\"the.support@example.biz\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            }\n         ],\n         \"phone_mobile\":\"(373) 861-0757\",\n         \"phone_work\":\"(212) 542-9596\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"sugar.dev.sugar@example.co.jp\",\n         \"email2\":\"the.support@example.biz\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"345 Sugar Blvd.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"87261\",\n         \"primary_address_country\":\"USA\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_GET/index.html"}
{"id": "328f6f016a92-5", "text": "\"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Campaign\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"DaleSpivey97\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\\/\",\n         \"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_GET/index.html"}
{"id": "328f6f016a92-6", "text": "\"name\":\"Florence Haddock\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Florence\",\n         \"last_name\":\"Haddock\",\n         \"full_name\":\"Florence Haddock\",\n         \"title\":\"Director Sales\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(729) 845-3137\",\n         \"email\":[\n            {\n               \"email_address\":\"dev.vegan@example.de\",\n               \"opt_out\":\"1\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            },\n            {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_GET/index.html"}
{"id": "328f6f016a92-7", "text": "\"primary_address\":\"0\"\n            },\n            {\n               \"email_address\":\"section71@example.it\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            }\n         ],\n         \"phone_mobile\":\"(246) 233-1382\",\n         \"phone_work\":\"(565) 696-6981\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"section71@example.it\",\n         \"email2\":\"dev.vegan@example.de\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"111 Silicon Valley Road\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"79900\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Support Portal User Registration\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_GET/index.html"}
{"id": "328f6f016a92-8", "text": "\"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"FlorenceHaddock169\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$nWFhTbK6$JF9BCGSqL\\/NCrbhueX5ia0\",\n         \"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_GET/index.html"}
{"id": "9bec2e9911ee-0", "text": "/Dashboards/<module> POST\n    Create a new dashboard.\nNotice\nThis endpoint is not supported in v11. If you continue to use v10 of the API, your\n    REST calls should behave as below. But, it is advisable to upgrade to v11.Migrating to v11:\n    For more information on behavior in v11, refer to POST /<module>.\n    Recommended Replacement: POST /Dashboards\n    The module name is no longer part of the path. To specify a module name, include it in the Request Body.\n    For example, to create an Accounts module dashboard, usev11: POST /Dashboards with the following in the Request Body:\n{\"dashboard_module\":\"Accounts\"}\nRequest Arguments\nName\nType\nDescription\nRequired\n<record field>\n<record field type>\nThe name value list of fields to populate.\nTrue\nRequest\n{\n    \"name\": \"New Dashboard for Accounts Module\",\n    \"dashboard_module\": \"Accounts\",\n    \"view_name\": \"records\",\n    \"metadata\": {\n        \"components\": [{\n            \"rows\": [[{\n                \"view\": {\n                    \"type\": \"dashablelist\",\n                    \"label\": \"TPL_DASHLET_MY_MODULE\",\n                    \"display_columns\": [\"name\",\"billing_address_city\"]\n                },\n                \"context\": {\"module\":\"Accounts\"},\n                \"width\": 12\n            }]],\n            \"width\": 12\n        }]\n    }\n}\nResponse Arguments\nName\nType\nDescription\n<record field>\n<record field type>\nReturns the fields for the newly created dashboard.\nResponse\n{\n  \"id\": \"8f9cd3d1-ce5d-e8d4-12d8-56cf674d2600\",\n  \"name\": \"New Dashboard for Accounts Module\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboardsmodule_POST/index.html"}
{"id": "9bec2e9911ee-1", "text": "\"name\": \"New Dashboard for Accounts Module\",\n  \"date_entered\": \"2016-02-25T12:44:27-08:00\",\n  \"date_modified\": \"2016-02-25T12:44:27-08:00\",\n  \"modified_user_id\": \"1\",\n  \"modified_by_name\": \"Administrator\",\n  \"created_by\": \"1\",\n  \"created_by_name\": \"Administrator\",\n  \"description\": \"\",\n  \"deleted\": false,\n  \"dashboard_module\": \"Accounts\",\n  \"view_name\": \"records\",\n  \"metadata\": {\n    \"components\": [\n      {\n        \"rows\": [\n          [\n            {\n              \"view\": {\n                \"type\": \"dashablelist\",\n                \"label\": \"TPL_DASHLET_MY_MODULE\",\n                \"display_columns\": [\n                  \"name\",\n                  \"billing_address_city\"\n                ]\n              },\n              \"context\": {\n                \"module\": \"Accounts\"\n              },\n              \"width\": 12\n            }\n          ]\n        ],\n        \"width\": 12\n      }\n    ]\n  },\n  \"following\": \"\",\n  \"my_favorite\": false,\n  \"tag\": [],\n  \"assigned_user_id\": \"1\",\n  \"assigned_user_name\": \"Administrator\",\n  \"_acl\": {\n    \"fields\": {}\n  },\n  \"view\": \"records\",\n  \"_module\": \"Dashboards\"\n}\nChange Log\nVersion\nChange\nv11\nNo longer supported. Please use POST /Dashboards instead.\nv10\nAdded /Dashboards/<module> POST endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboardsmodule_POST/index.html"}
{"id": "78fc115409c2-0", "text": "/<module>/globalsearch GET\nOverview\n    Global search\nSummary\n    This endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the\n    /search endpoint. This endpoint can be used with a long list of request arguments. Instead of using GET request\n    arguments, all described arguments can be used inside a JSON encoded request body using a the GET request. If your\n    client has no support for GET requests with a body, the POST method can be used as an alternative.\nRequest Arguments\nName\nType\nDescription\nRequired\n            q\n        \n            String\n        \n            The search expression. Multiple terms can be specified at once. All enabled fields will be searched in. The\n            results are ordered by relevance which is based on a multitude of settings based on token counts, hit\n            ratio, (weighted) boost values and type of field. Currently no operators are supported in the search\n            expression itself. By refining the search expression more relevant results will be returned as top results.\n            If no search expression is given results are returned based on last modified date.\n        \n            False\n        \n            module_list\n        \n            String\n        \n            Comma delimited list of modules to search. If omitted, all search enabled modules will be queried. Note that\n            when consuming the endpoint /:module/globalsearch that this parameter is ignored.\n            \n            Example: Accounts,Contacts\n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            highlights\n        \n            Boolean\n        \n            Wether or not to return highlighted results. Default is true.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleglobalsearch_GET/index.html"}
{"id": "78fc115409c2-1", "text": "Wether or not to return highlighted results. Default is true.\n        \n            False\n        \n            sort\n        \n            Array\n        \n            Define the sort order of the results. By default the results are returned by relevance which is the\n            preferred approach. Using this argument any search enabled field can be used to sort on. Keep in mind the\n            not sorting by relevance may have a negative performance impact.\n            \n            Example: {\"date_modified\":\"desc\",\"name\":\"asc\"}\n            False\n        \nRequest\n{\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /globalsearch GET/POST endpoint.\n        \n            v10\n        \n            Added /:module/globalsearch GET/POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleglobalsearch_GET/index.html"}
{"id": "fa1c280bbc1d-0", "text": "/pmse_Inbox/engine_claim PUT\nOverview\n    Claims the processes to the current user\nSummary\n    This endpoint claims the processes to the current user.\nRequest Arguments\nName\nType\nDescription\nRequired\ncas_id\nstring\nThe id of the process trigger sequence\ntrue\ncas_index\nstring\nThe step in the process\ntrue\nResponse\nThere is no Response to this endpoint\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxengine_claim_PUT/index.html"}
{"id": "cfa2326a241a-0", "text": "/<module>/prepend/:target POST\nOverview\n    Append new node to target node as first child.\nRequest Arguments\nName\nType\nDescription\nRequired\n                module\n            \n                String\n            \n                The name of sugar module that contains a nested set data and implements the NestedSetInterface.\n            \n                True\n            \n                target\n            \n                String\n            \n                The ID of record that will be used as target to prepend new node\n            \n                True\n            \nRequest\n{\n    \"name\" : \"Children Node 1\"\n}\nResponse Arguments\n    This endpoint does not return any response arguments.\nResponse\n    This enpdoint returns a newly created record GUID\n    {\n    \"my_favorite\":false,\n    \"following\":\"\",\n    \"id\":\"59fa8dd7-0f2c-4bfd-364f-54495f77fa3f\",\n    \"name\":\"Default title\",\n    \"date_entered\":\"2014-10-23T23:03:22+03:00\",\n    \"date_modified\":\"2014-10-23T23:03:22+03:00\",\n    \"modified_user_id\":\"1\",\n    \"modified_by_name\":\"Administrator\",\n    \"created_by\":\"1\",\n    \"created_by_name\":\"Administrator\",\n    \"doc_owner\":\"\",\n    \"description\":\"\",\n    \"deleted\":false,\n    \"source_id\":\"\",\n    \"source_type\":\"\",\n    \"source_meta\":\"\",\n    \"root\":\"be9b0c4a-8b78-1ffa-4f14-54481c2f6269\",\n    \"lft\":118,\n    \"rgt\":119,\n    \"level\":1,\n    \"_acl\":{\"fields\":{}},\n    \"_module\":\"Categories\"\n    }", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleprependtarget_POST/index.html"}
{"id": "cfa2326a241a-1", "text": "\"_acl\":{\"fields\":{}},\n    \"_module\":\"Categories\"\n    }\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/prepend/:target POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleprependtarget_POST/index.html"}
{"id": "183f12b6157a-0", "text": "/pmse_Inbox/:record/file/:field GET\nOverview\n    Returns the process status image file \nSummary\n    This endpoint returns the process status image file. \nRequest Arguments\nName\nType\nDescription\nRequired\nrecord\nstring\nThe id of the record or image to get\ntrue\nfield\nstring\nThe image type field to get the image from\ntrue\n_project\nstring\nIf set, will get an image for a project instead of a process\nfalse\nResponse\nThere is no Response to this endpoint\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxrecordfilefield_GET/index.html"}
{"id": "f9756a04e90c-0", "text": "/ping GET\nOverview\n    Responds with \"pong\" if the access_token is valid.\nRequest Arguments\n    This endpoint does not accept any arguments.\nResponse Arguments\nName\nType\nDescription\n            <response>\n        \n            String\n        \n            Returns pong is authenticated.\n        \nResponse\npong\nChange Log\nVersion\nChange\n            v10\n        \n            Added /ping GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ping_GET/index.html"}
{"id": "860e2ec4b20a-0", "text": "/Documents/:record/file/:field PUT\nOverview\n    This endpoint takes a file or image and saves it to a record that already contains an attachment in the specified field. The PUT method is very similar to the POST method but differs slightly in how the request is constructed. PUT requests should send the file data as the body of the request. Optionally, a filename query parameter can be sent with the request to assign a name. Additionally, the PUT \n    method can accept base64 encoded file data which will be decoded by the endpoint\n    if the content_transfer_encoding parameter is set to 'base64'.NOTE: In lieu of the content_transfer_encoding parameter, a\n    request header of X-Content-Transfer-Encoding can also be sent with a value\n    of 'base64'. In the event both the content transfer encoding header and request\n    parameter are sent, the header will be used.\nRequest Arguments\nName\nType\nDescription\nRequired\n            filename\n        \n            String\n        \n            Filename to save the document as\n        \n            False\n        \n            content_transfer_encoding\n        \n            String\n        \n            When set to 'base64', indicates the file contents are base64 encoded\n            and will result in the file contents being base64 decoded before being\n            saved\n        \n            False\n        \nRequest\nPUT /rest/v10/Notes/abcd-1234/file/field/ HTTP/1.1 Host: localhost Connection: keep-alive Content-Length: 23456 Content-Type: application/document-doc ...This is where the bin data would be\nResponse Arguments\nName\nType\nDescription\n            field\n        \n            Array\n        \n            The fields containing file properties.\n        \n            field.content-type\n        \n            String\n        \n            The files content type.\n        \n            field.content-length\n        \n            Integer\n        \n            The files content length.\n        \n            field.name", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Documentsrecordfilefield_PUT/index.html"}
{"id": "860e2ec4b20a-1", "text": "Integer\n        \n            The files content length.\n        \n            field.name\n        \n            String\n        \n            The files name.\n        \n            field.width\n        \n            Integer\n        \n            The width of the image.\n        \n            field.height\n        \n            Integer\n        \n            The height of the image.\n        \n            field.uri\n        \n            String\n        \n            The URI of the file.\n        \nResponse\n{\n   \"picture\":{\n      \"content-type\":\"image\\/png\",\n      \"content-length\":72512,\n      \"name\":\"1a7b8f5c-b11c-0094-c8d8-512e9daaa983\",\n      \"width\":933,\n      \"height\":519,\n      \"uri\":\"http:\\/\\/sugarcrm\\/rest\\/v10\\/Contacts\\/fa300a0e-0ad1-b322-9601-512d0983c19a\\/file\\/picture\"\n   }\n    \"attachment\":{\n        \"content-type\":\"application/document-doc\",\n        \"content-length\":\"873921\",\n        \"name\":\"myFile.doc\",\n        \"uri\": \"http:\\/\\/sugarcrm\\/rest\\/v10\\/Contacts\\/f2f9aa4d-99a8-e86e-f4d5-512d0986effa\\/file\\/attachment\"\n    }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/file/:field PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Documentsrecordfilefield_PUT/index.html"}
{"id": "8177ffa5392f-0", "text": "/<module>/:record/file GET\nOverview\n    Lists all populated fields of type \"file\" or of type \"image\" for a record.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            field\n        \n            Array\n        \n            The fields containing file properties.\n        \n            field.content-type\n        \n            String\n        \n            The files content type.\n        \n            field.content-length\n        \n            Integer\n        \n            The files content length.\n        \n            field.name\n        \n            String\n        \n            The files ID.\n        \n            field.width\n        \n            Integer\n        \n            The width of the image.\n        \n            field.height\n        \n            Integer\n        \n            The height of the image.\n        \n            field.uri\n        \n            String\n        \n            The URI of the file.\n        \nResponse\n{\n   \"picture\":{\n      \"content-type\":\"image\\/png\",\n      \"content-length\":72512,\n      \"name\":\"1a7b8f5c-b11c-0094-c8d8-512e9daaa983\",\n      \"width\":933,\n      \"height\":519,\n      \"uri\":\"http:\\/\\/sugarcrm\\/rest\\/v10\\/Contacts\\/fa300a0e-0ad1-b322-9601-512d0983c19a\\/file\\/picture\"\n   },\n   \"record\": {\n      \"my_favorite\": false,\n      \"following\": true,\n      \"id\": \"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n      \"name\": \"Test\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfile_GET/index.html"}
{"id": "8177ffa5392f-1", "text": "\"name\": \"Test\",\n      \"date_modified\": \"2014-05-16T03:49:12+02:00\",\n      \"modified_user_id\": \"1\",\n      \"modified_by_name\": \"admin\",\n      \"created_by\": \"1\",\n      \"created_by_name\": \"Administrator\",\n      \"doc_owner\": \"1\",\n      \"description\": \"\",\n      \"deleted\": false,\n      \"assigned_user_id\": \"1\",\n      \"assigned_user_name\": \"Administrator\",\n      \"team_count\": \"\",\n      \"team_name\": [\n         {\n            \"id\": 1,\n            \"name\": \"Global\",\n            \"name_2\": \"\",\n            \"primary\": true\n         }\n      ],\n      \"email\": [],\n      \"email1\": \"\",\n      \"email2\": \"\",\n      \"invalid_email\": \"\",\n      \"email_opt_out\": \"\",\n      \"email_addresses_non_primary\": \"\",\n      \"salutation\": \"\",\n      \"first_name\": \"\",\n      \"last_name\": \"Test\",\n      \"full_name\": \"Test\",\n      \"title\": \"\",\n      \"facebook\": \"\",\n      \"twitter\": \"\",\n      \"googleplus\": \"\",\n      \"department\": \"\",\n      \"do_not_call\": false,\n      \"phone_home\": \"\",\n      \"phone_mobile\": \"\",\n      \"phone_work\": \"\",\n      \"phone_other\": \"\",\n      \"phone_fax\": \"\",\n      \"primary_address_street\": \"\",\n      \"primary_address_city\": \"\",\n      \"primary_address_state\": \"\",\n      \"primary_address_postalcode\": \"\",\n      \"primary_address_country\": \"\",\n      \"alt_address_street\": \"\",\n      \"alt_address_city\": \"\",\n      \"alt_address_state\": \"\",\n      \"alt_address_postalcode\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfile_GET/index.html"}
{"id": "8177ffa5392f-2", "text": "\"alt_address_state\": \"\",\n      \"alt_address_postalcode\": \"\",\n      \"alt_address_country\": \"\",\n      \"assistant\": \"\",\n      \"assistant_phone\": \"\",\n      \"picture\": \"\",\n      \"email_and_name1\": \"\",\n      \"lead_source\": \"\",\n      \"account_name\": \"\",\n      \"account_id\": \"\",\n      \"dnb_principal_id\": \"\",\n      \"opportunity_role_fields\": \"\",\n      \"opportunity_role_id\": \"\",\n      \"opportunity_role\": \"\",\n      \"reports_to_id\": \"\",\n      \"report_to_name\": \"\",\n      \"birthdate\": \"\",\n      \"portal_name\": \"\",\n      \"portal_active\": false,\n      \"portal_password\": null,\n      \"portal_password1\": null,\n      \"portal_app\": \"\",\n      \"preferred_language\": \"en_us\",\n      \"campaign_id\": \"\",\n      \"campaign_name\": \"\",\n      \"c_accept_status_fields\": \"\",\n      \"m_accept_status_fields\": \"\",\n      \"accept_status_id\": \"\",\n      \"accept_status_name\": \"\",\n      \"accept_status_calls\": \"\",\n      \"accept_status_meetings\": \"\",\n      \"sync_contact\": false,\n      \"mkto_sync\": false,\n      \"mkto_id\": null,\n      \"mkto_lead_score\": null,\n      \"_acl\": {\n         \"fields\": {}\n      },\n      \"_module\": \"Contacts\"\n  }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/file GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfile_GET/index.html"}
{"id": "63e81d3426b5-0", "text": "/pmse_Business_Rules/:record/brules GET\nOverview\n    Exports a .pbr file with a Process Business Rules definition\nSummary\n    This endpoint will retrieve a .pbr file containing JSON encoded data of a\n    Process Business Rules definition identified by the record input\n    parameter.\nRequest Arguments\nName\nType\nDescription\nRequired\nrecord\nString\nThe Process Business Rule record ID\nTrue\nResponse Arguments\nName\nType\nDescription\nN/A\nResponse\nNote: The response is a MIME type application/pbr file attachment without any response parameters.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Business_Rulesrecordbrules_GET/index.html"}
{"id": "c8218f829dfd-0", "text": "/<module>/:record/link/activities GET\nActivities on a module's list view\nSummary:\n  This endpoint lists activities across a particular module in the system. It does not use a subscription model unlike the other endpoints. It can be queried as a regular bean collection, but without search, ordering or filtering.\nQuery Parameters:\nParamDescriptionOptionalmax_numA maximum number of records to returnOptionaloffsetHow many records to skip over before records are returnedOptional\nInput Example:\nThis endpoint does not accept any input\nOutput Example:\n{\n    \"next_offset\": 20, This will be set to -1 when there are no more records after this \"page\".\n    \"records\": [{\n        \"id\": \"22fb8b16-de1d-f1dc-b15b-51240efde177\",\n        \"date_entered\": \"2013-02-19T23:47:11+00:00\",\n        \"date_modified\": \"2013-02-19T23:47:11+00:00\",\n        \"created_by\": \"1\",\n        \"deleted\": \"0\",\n        \"parent_id\": \"f5bb0331-2c0f-5c7c-b4db-5123caac0056\",\n        \"parent_type\": \"Contacts\",\n        \"activity_type\": \"post\", This will be the type of activity performed.\n        \"data\": {\n            \"value\": \"This is a test post on a contact I'm subscribed to.\"\n        },\n        \"comment_count\": 0, This will be set to the total number of comments on the post.\n        \"last_comment\": { This will be the last comment on the post, which can be used to create a comment model on the frontend.\n            \"deleted\": 0,\n            \"data\": []\n        },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkactivities_GET/index.html"}
{"id": "c8218f829dfd-1", "text": "\"deleted\": 0,\n            \"data\": []\n        },\n        \"fields\": [],\n        \"first_name\": null,\n        \"last_name\": \"Administrator\",\n        \"created_by_name\": \" Administrator\" This will be the locale-formatted full name of the user.\n    }, ... ]\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkactivities_GET/index.html"}
{"id": "7d1781516414-0", "text": "/<module>/:record/file/:field POST\nOverview\n    Attaches a file to a field on a record.\nRequest Arguments\nName\nType\nDescription\nRequired\n            format\n        \n            String\n        \n            The data format. Currently accepts 'sugar-html-json'.\n        \n            True\n        \n            delete_if_fails\n        \n            Boolean\n        \n            Indicates whether the API is to mark related record deleted if the file upload fails.\n        \n            False\n        \n            oauth_token\n        \n            String\n        \n            The oauth_token value.\n        \n            False - Required if only if delete_if_fails is true.\n        \n            <attachment field>\n        \n            String\n        \n            The field and file to populate.\n            \n            Example: {\"\":\"@\\/path\\/to\\/ExampleDocument.txt\"}\n            True\n        \nRequest\n{\n   \"format\":\"sugar-html-json\",\n   \"delete_if_fails\":true,\n   \"oauth_token\":\"43b6b327-cc70-c301-3299-512ffb99ad97\",\n   \"<attachment field>\":\"@\\/path\\/to\\/ExampleDocument.txt\"\n}\nResponse Arguments\nName\nType\nDescription\n            content-type\n        \n            String\n        \n            The files content type.\n        \n            content-length\n        \n            Integer\n        \n            The files content length.\n        \n            name\n        \n            String\n        \n            The files name.\n        \n            uri\n        \n            String\n        \n            The URI of the file.\n        \nResponse\n{\n   \"content-type\":\"text\\/plain\",\n   \"content-length\":16,\n   \"name\":\"ExampleDocument.txt\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfilefield_POST/index.html"}
{"id": "7d1781516414-1", "text": "\"content-length\":16,\n   \"name\":\"ExampleDocument.txt\",\n   \"uri\":\"http:\\/\\/sugarcrm\\/rest\\/v10\\/Notes\\/ca66c92f-5a8b-28b4-4fc8-512d099b790b\\/file\\/<attachment field>?format=sugar-html-json&delete_if_fails=1&oauth_token=6ec91cf3-1f97-25b9-e0b1-512f8971b2d4\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/file/:field POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfilefield_POST/index.html"}
{"id": "8c86de151c51-0", "text": "/Contacts/:record/freebusy GET\n    Get a contact's FreeBusy schedule\nSummary:\n    This endpoint returns a list of time slots for which the specified person is busy.\nRequest\n        GET /Contacts/:id/freebusy\n    \nResponse\n    {\n      \"id\": \"foo\"\n      \"module\": \"Users\",\n      \"freebusy\": [\n                    {\n                      \"start\": \"2014-08-24T08:45:00-04:00\",\n                      \"end\": \"2014-08-24T09:15:00-04:00\"\n                    },\n                    {\n                      \"start\": \"2014-08-30T05:45:00-04:00\",\n                      \"end\": \"2014-08-30T06:15:00-04:00\"\n                    },\n                    {\n                      \"start\": \"2014-09-12T15:45:00-04:00\",\n                      \"end\": \"2014-09-12T16:15:00-04:00\"\n                    }\n                  ]\n    }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Contactsrecordfreebusy_GET/index.html"}
{"id": "803770c04e68-0", "text": "/TimePeriods/:date GET\nReturn a Timeperiod by a given date\nSummary:\n     This endpoint is used to get a TimePeriod for a given date.  If one is not found a 404 is returned.\nOutput Example:\n        {\n           \"id\":\"e394485a-5889-ea75-84c8-51543bd1a5ba\",\n           \"name\":\"Q1 (01\\/01\\/2013 - 03\\/31\\/2013)\",\n           \"parent_id\":\"e28efe2d-c51c-be45-3d84-51543b4d2910\",\n           \"start_date\":\"2013-01-01\",\n           \"start_date_timestamp\":\"1356998400\",\n           \"end_date\":\"2013-03-31\",\n           \"end_date_timestamp\":\"1364774399\",\n           \"created_by\":\"1\",\n           \"date_entered\":\"2013-03-28 12:46:36\",\n           \"date_modified\":\"2013-03-28 12:46:36\",\n           \"deleted\":\"0\",\n           \"is_fiscal\":\"0\",\n           \"is_fiscal_year\":\"0\",\n           \"leaf_cycle\":\"1\",\n           \"type\":\"Quarter\",\n           \"related_timeperiods\":\"\"\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriodsdate_GET/index.html"}
{"id": "938cd94ce397-0", "text": "/logger POST\nOverview\n    Logs a message to the Sugar Log\nRequest Arguments\nName\nType\nDescription\nRequired\n            level\n        \n            String\n        \n            The log level\n        \n            True\n        \n            message\n        \n            String\n        \n            The message to log\n        \n            True\n        \n            channel\n        \n            String\n        \n            Prefix for the log message, defaults to Main\n        \n            false\n        \nResponse Arguments\nName\nType\nDescription\n            status\n        \n            bool\n        \n            if the message was logged\n        \nResponse\n{\n   \"status\":true,\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /logger POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/logger_POST/index.html"}
{"id": "ae9e8cf76a4c-0", "text": "/<module>/:record/vcard GET\nOverview\n    Downloads a vCard.\nRequest Arguments\n    This endpoint does not accept any arguments.\nResponse Arguments\nName\nType\nDescription\n            <vcard information>\n        \n            String;\n        \n            Record in vcard format\n        \nResponse\nBEGIN:VCARD\nN;CHARSET=utf-8:Leone;Rosemarie;;\nFN;CHARSET=utf-8: Rosemarie Leone\nBDAY:\nTEL;WORK;FAX:\nTEL;HOME;CHARSET=utf-8:(692) 586-8287\nTEL;CELL;CHARSET=utf-8:(117) 577-0969\nTEL;WORK;CHARSET=utf-8:(844) 325-7679\nEMAIL;INTERNET;CHARSET=utf-8:support.im@example.it\nADR;WORK;CHARSET=utf-8:;;777 West Filmore Ln;San Mateo;CA;74984;USA\nORG;CHARSET=utf-8:Q.R.&E. Corp;\nTITLE;CHARSET=utf-8:Director Sales\nEND:VCARD\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/vcard GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordvcard_GET/index.html"}
{"id": "8790b76e61ff-0", "text": "/PdfManager GET\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n            Note that JSON-encoded filters can be specified as query parameters\n            in one of two ways for GET requests:\n            \n                    By specifying individual filter arguments as distinct parameters.\n                    Example: filter[0][id]=1.\n                \n                    By specifying the whole filter as a single JSON-encoded string.\n                    Note that this syntax is currently not supported on certain modules.\n                    Example: filter=[{\"id\":\"1\"}].\n                \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/PdfManager_GET/index.html"}
{"id": "8790b76e61ff-1", "text": "False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. Each field may be represented either by string, or by map\n            containing field name and additional field parameters (applicable to link and collection fields).\n            The fields id and date_modified will always be returned.\n            \n            Example: name,account_type,description,{\"name\":\"opportunities\",\"fields\":[\"id\",\"name\",\"sales_status\"],\"order_by\":\"date_closed:desc\"}\n            For more details on additional field parameters, see\n            Relate API and\n            Collection API.\n        \n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \n            q\n        \n            String\n        \n            A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.\n        \n            False\n        \n            deleted\n        \n            Boolean\n        \n            Boolean to show deleted records in the result set.\n        \n            False\n        \n            nulls_last\n        \n            Boolean", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/PdfManager_GET/index.html"}
{"id": "8790b76e61ff-2", "text": "False\n        \n            nulls_last\n        \n            Boolean\n        \n            Boolean to return records with null values in order_by fields last in the result set.\n        \n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\nExample\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/PdfManager_GET/index.html"}
{"id": "8790b76e61ff-3", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/PdfManager_GET/index.html"}
{"id": "8790b76e61ff-4", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\",\n               \"id\": \"b0701501-1fab-8ae7-3942-540da93f5017\",\n               \"name\": \"360 Vacations - 228 Units\",\n               \"date_modified\": \"2014-09-08T16:05:00+03:00\",\n               \"sales_status\": \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/PdfManager_GET/index.html"}
{"id": "8790b76e61ff-5", "text": "{\n               _module: \"Opportunities\"\n               date_modified: \"2014-09-08T16:05:00+03:00\"\n               id: \"9ce7c088-8ee4-7cd3-18f1-540da944d4c0\"\n               name: \"360 Vacations - 312 Units\"\n               sales_status: \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/PdfManager_GET/index.html"}
{"id": "1c6b0af2153b-0", "text": "/Leads/register POST\nOverview\n    Creates new Leads.\nRequest Arguments\nName\nType\nDescription\nRequired\n            <record field>\n        \n            <record field type>\n        \n            The name value list of fields to populate.\n        \n            True\n        \nRequest\n{\n   \"first_name\":\"John\",\n   \"last_name\":\"Smith\"\n}\nResponse Arguments\nName\nType\nDescription\n            <record field>\n        \n            <record field type>\n        \n            Returns the fields for the newly created record.\n        \nResponse\n{\n   \"id\":\"ecba9f86-4a4a-def6-359c-505a5b33f014\",\n   \"name\":\"John Smith\",\n   \"date_entered\":\"2012-09-19T23:54:54+0000\",\n   \"date_modified\":\"2012-09-19T23:54:54+0000\",\n   \"modified_user_id\":\"1\",\n   \"created_by\":\"1\",\n   \"deleted\":0,\n   \"team_id\":\"1\",\n   \"team_set_id\":\"1\",\n   \"first_name\":\"John\",\n   \"last_name\":\"Smith\",\n   \"full_name\":\"John Smith\",\n   \"do_not_call\":false,\n   \"converted\":false,\n   \"lead_source\":\"Support Portal User Registration\",\n   \"status\":\"New\",\n   \"preferred_language\":\"en_us\",\n   \"email\":[\n   ],\n   \"my_favorite\":false\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Leads/register POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Leadsregister_POST/index.html"}
{"id": "7e85ea45f8d1-0", "text": "/<module>/MassUpdate DELETE\nOverview\n    An API to mass delete records.\nQuery String Parameters\nName\nType\nDescription\nRequired\n            massupdate_params\n        \n            Array\n        \n            Mass update parameters.\n        \n            True\n        \n            massupdate_params.uid\n        \n            Array\n        \n            A list of ids.\n        \n            True\n        \nRequest\nMass Deleting Records by ID in a Module\n{\n    \"massupdate_params\":{\n        \"uid\":[\n            \"ebf22b86-94ea-1601-4f4f-512d09173438\",\n            \"e3b71c55-d96b-80bb-1696-512d09672398\"\n        ]\n    }\n}\nResponse Arguments\nName\nType\nDescription\n            Status\n        \n            String\n        \n            The status of the mass update. Possible value is 'done'.\n        \nOutput Done Example\n{\n    \"status\":\"done\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/MassUpdate DELETE endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleMassUpdate_DELETE/index.html"}
{"id": "c8456202a3f1-0", "text": "/<module>/record_list POST\nOverview\n    An API to create and save lists of records.\nSummary\n    Create record list. Only POST request allowed.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule\nstring\n            Module name\n        \nTrue\nrecords\narray\n            Array of records\n        \nTrue\nRequest Example\nPOST /rest/v10/:module/record_list\n{records: [\"e5c8bb3b-5eea-3d8a-c278-56c6affa6212\", \"e49395b4-d3b0-1e3f-600a-56c6afe7e34f\"]}\nResponse Arguments\nName\nType\nDescription\nid\nguid\n            record list id\n        \nassigned_user_id\nguid\n            user id\n        \nmodule_name\nstring\n            Module name\n        \nrecords\narray\n            record ids\n        \ndate modified\ndate\n            date modified\n        \nOutput Example\n{\n    \"id\": \"39d2c781-c0b7-446f-1d83-56c6e3cda510\",\n    \"assigned_user_id\": \"1\",\n    \"module_name\": \"Accounts\",\n    \"records\": [\n        \"e5c8bb3b-5eea-3d8a-c278-56c6affa6212\",\n        \"e49395b4-d3b0-1e3f-600a-56c6afe7e34f\",\n        \"c03ed8ee-60d3-c6a6-55c3-56c6af95e696\",\n        \"d65573e3-c25a-f9b4-33f2-56c6afb8d856\"\n    ],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_list_POST/index.html"}
{"id": "c8456202a3f1-1", "text": "],\n    \"date_modified\": \"2016-02-19 09:42:44\"\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_list_POST/index.html"}
{"id": "b6e40198dcd5-0", "text": "/<module>/config GET\nOverview\n    Retrieves the config settings for a given module.\nSummary\n    This endpoint is normally used for the forecasting module.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            <config field>\n        \n            <config field type>\n        \n            The list of config fields will be returned.\n        \nResponse\n{\n   \"is_setup\":1,\n   \"is_upgrade\":0,\n   \"has_commits\":1,\n   \"timeperiod_type\":\"chronological\",\n   \"timeperiod_interval\":\"Annual\",\n   \"timeperiod_leaf_interval\":\"Quarter\",\n   \"timeperiod_start_date\":\"2013-01-01\",\n   \"timeperiod_shown_forward\":2,\n   \"timeperiod_shown_backward\":2,\n   \"forecast_ranges\":\"show_binary\",\n   \"buckets_dom\":\"commit_stage_binary_dom\",\n   \"show_binary_ranges\":{\n      \"include\":{\n         \"min\":70,\n         \"max\":100\n      },\n      \"exclude\":{\n         \"min\":0,\n         \"max\":69\n      }\n   },\n   \"show_buckets_ranges\":{\n      \"include\":{\n         \"min\":85,\n         \"max\":100\n      },\n      \"upside\":{\n         \"min\":70,\n         \"max\":84\n      },\n      \"exclude\":{\n         \"min\":0,\n         \"max\":69\n      }\n   },\n   \"show_custom_buckets_ranges\":{\n      \"include\":{\n         \"min\":85,\n         \"max\":100\n      },\n      \"upside\":{\n         \"min\":70,\n         \"max\":84\n      },\n      \"exclude\":{\n         \"min\":0,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleconfig_GET/index.html"}
{"id": "b6e40198dcd5-1", "text": "},\n      \"exclude\":{\n         \"min\":0,\n         \"max\":69\n      }\n   },\n   \"sales_stage_won\":[\n      \"Closed Won\"\n   ],\n   \"sales_stage_lost\":[\n      \"Closed Lost\"\n   ],\n   \"show_worksheet_likely\":1,\n   \"show_worksheet_best\":1,\n   \"show_worksheet_worst\":0,\n   \"show_projected_likely\":1,\n   \"show_projected_best\":1,\n   \"show_projected_worst\":0,\n   \"show_forecasts_commit_warnings\":1\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/config GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleconfig_GET/index.html"}
{"id": "fdaf05f956e5-0", "text": "/ForecastManagerWorksheets/assignQuota POST\nAssign Quotas to All Reporting Users for a given timeperiod\nSummary:\n    This endpoint is used to assign out the quota to the reporting users with out having to commit a forecast.\nParameters:\nParam\nDescription\nOptional\nuser_id\nThe Manager's user id for who is assigning out the quota\nfalse\ntimeperiod_id\nWhich timeperiod are we assigning quota for\nfalse\nInput Example:\n        { \"user_id\" : \"seed_sarah_id\",\n          \"timeperiod_id\" : \"36f7085a-5889-ea75-84c8-50f42bd1a5ba\"\n        }\n    \nOutput Example:\n        {success: true}\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsassignQuota_POST/index.html"}
{"id": "57aef0f54958-0", "text": "/Forecasts/enum/selectedTimePeriod GET\nForecastsApi Timeperiod filter info\nSummary:\n    This returns the timeperiods with respect to the forward/backward options selected. For example, if we elect to use\n    quarterly timeperiods and 2 forward and 2 backward timeperiod intervals are set, then 5 years worth of timeperiods\n    will be returned (2 backward + current + 2 forward).\nQuery Parameters:\nParam\nDescription\nOptional\nThis endpoint does not accept any parameters.\nInput Example:\nOutput Example:\n        { \"d181230a-a7e0-3176-d10f-50f8530a51ce\" : \"Q1 (01/01/2012 - 03/31/2012)\",\n          \"d2bc58ef-21c4-27d5-e416-50f853db29f9\" : \"Q2 (04/01/2012 - 06/30/2012)\",\n          \"d3db853e-94d6-b5ac-98af-50f8530689be\" : \"Q3 (07/01/2012 - 09/30/2012)\",\n          \"d519f521-5303-1cfc-24f5-50f8537f5b54\" : \"Q4 (10/01/2012 - 12/31/2012)\",\n          \"dcc2885a-5889-ea75-84c8-50f853d1a5ba\" : \"Q1 (01/01/2013 - 03/31/2013)\",\n          \"ddc24224-c6c9-04aa-7869-50f853db2ea2\" : \"Q2 (04/01/2013 - 06/30/2013)\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastsenumselectedTimePeriod_GET/index.html"}
{"id": "57aef0f54958-1", "text": "\"deadcfd3-41ed-5f6b-ce5b-50f853de6ef6\" : \"Q3 (07/01/2013 - 09/30/2013)\",\n          \"dfaa3724-6295-8ddb-6d14-50f853047fcc\" : \"Q4 (10/01/2013 - 12/31/2013)\",\n          \"e1ceee19-c8dd-afdd-e797-50f8538d900a\" : \"Q1 (01/01/2014 - 03/31/2014)\",\n          \"e307594a-c12a-6be6-74b7-50f85351c574\" : \"Q2 (04/01/2014 - 06/30/2014)\",\n          \"e469239c-3f71-a48e-cda1-50f853214b6a\" : \"Q3 (07/01/2014 - 09/30/2014)\",\n          \"e57f4889-cefd-4356-6d82-50f85350decd\" : \"Q4 (10/01/2014 - 12/31/2014)\"\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastsenumselectedTimePeriod_GET/index.html"}
{"id": "ec616064e070-0", "text": "/<module>/customfield POST\nOverview\nCreate a new custom field for a specified module.\nSummary\nThis endpoint is used to create a new custom field for a specified module.\nRequest Arguments\nName\nType\nDescription\nRequired\ndata\narray\nThe field metadata.\nTrue\nRequest Examples\nThis example will create a decimal type custom field:\n{\n    \"localizations\": {\n      \"en_us\": {\n          \"LBL_AI_SCORE\": \"Ai Score\"\n      },\n      ...\n    },\n    \"data\":{\n      \"name\":\"ai_score\",\n      \"label\":\"LBL_AI_SCORE\",\n      \"type\":\"decimal\",\n      \"len\":\"18\",\n      \"precision\":8,\n      \"required\":false,\n      \"reportable\":false,\n      \"audited\":false,\n      \"importable\":false,\n      \"duplicate_merge\":false\n    }\n}\nThis example will create a textField type custom field:\n{\n    \"localizations\": {\n      \"en_us\": {\n          \"LBL_AI_SCORE_DESC\": \"Ai Score Description\"\n      },\n      ...\n    },\n    \"data\":{\n      \"name\":\"ai_score_desc\",\n      \"label\":\"LBL_AI_SCORE_DESC\",\n      \"type\":\"varchar\",\n      \"help\":\"Text Field Help Text\",\n      \"comments\":\"Text Field Comment Text\",\n      \"default_value\":\"\",\n      \"len\":255,\n      \"required\":false,\n      \"reportable\":true,\n      \"audited\":false,\n      \"importable\":\"true\",\n      \"duplicate_merge\":false\n    }\n}\nThis example will create an enum type custom field with a new dropdown list:\n{\n    \"localizations\": {\n      \"en_us\": {\n          \"LBL_DROPDOWN_FIELD\": \"New Dropdown Field\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulecustomfield_POST/index.html"}
{"id": "ec616064e070-1", "text": "\"en_us\": {\n          \"LBL_DROPDOWN_FIELD\": \"New Dropdown Field\",\n          \"LBL_DD_ITEM_ONE\": \"First Text\",\n          \"LBL_DD_ITEM_TWO\": \"Second Text\",\n          \"LBL_DD_ITEM_THREE\": \"Third Text\"\n      },\n      ...\n    },\n    \"data\": {\n      \"name\":\"new_dropdown_field\",\n      \"label\":\"LBL_DROPDOWN_FIELD\",\n      \"type\":\"enum\",\n      \"options\": {\n        \"dropdownName\": \"a_new_dropdown\",\n        \"dropdownList\": [\n          {\"value\":\"First\", \"label\":\"LBL_DD_ITEM_ONE\"},\n          {\"value\":\"Second\", \"label\":\"LBL_DD_ITEM_TWO\"},\n          {\"value\":\"Third\", \"label\":\"LBL_DD_ITEM_THREE\"}\n        ]\n      },\n      \"default_value\":\"First\"\n    }\n}\nThis example will create an enum type custom field using an existing dropdown list:\n{\n    \"localizations\": {\n      \"en_us\": {\n          \"LBL_DROPDOWN_FIELD\": \"New Dropdown Field\"\n      },\n      ...\n    },\n    \"data\": {\n      \"name\":\"new_dropdown_field\",\n      \"label\":\"LBL_DROPDOWN_FIELD\",\n      \"type\":\"enum\",\n      \"options\": \"account_type_dom\",\n      \"default_value\":\"Analyst\"\n    }\n}\nResponse\n{\n    \"duplicate_merge_dom_value\": 0,\n    \"required\": false,\n    \"source\": \"custom_fields\",\n    \"name\": \"ai_score_c\",\n    \"vname\": \"LBL_AI_SCORE\",\n    \"type\": \"decimal\",\n    \"massupdate\": false,\n    \"hidemassupdate\": false,\n    \"no_default\": false,\n    \"comments\": \"\",\n    \"help\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulecustomfield_POST/index.html"}
{"id": "ec616064e070-2", "text": "\"no_default\": false,\n    \"comments\": \"\",\n    \"help\": \"\",\n    \"importable\": \"\",\n    \"duplicate_merge\": \"disabled\",\n    \"audited\": false,\n    \"reportable\": false,\n    \"unified_search\": false,\n    \"merge_filter\": \"disabled\",\n    \"pii\": false,\n    \"calculated\": false,\n    \"len\": 18,\n    \"size\": \"20\",\n    \"enable_range_search\": false,\n    \"precision\": \"8\",\n    \"id\": \"ca9653de-0976-11eb-a558-6c400895ea84\",\n    \"custom_module\": \"Opportunities\"\n}\nChange Log\nVersion\nChange\nv11.11\nAdded /<module>/customfield POST endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulecustomfield_POST/index.html"}
{"id": "a0b31ee398d7-0", "text": "/<module>/:record/file/:field DELETE\nOverview\n    Removes an attachment from a field for a record and subsequently removes the file from the file system.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            field\n        \n            Array\n        \n            The fields containing file properties.\n        \n            field.content-type\n        \n            String\n        \n            The files content type.\n        \n            field.content-length\n        \n            Integer\n        \n            The files content length.\n        \n            field.name\n        \n            String\n        \n            The files ID.\n        \n            field.width\n        \n            Integer\n        \n            The width of the image.\n        \n            field.height\n        \n            Integer\n        \n            The height of the image.\n        \n            field.uri\n        \n            String\n        \n            The URI of the file.\n        \nResponse\n{\n    \"picture\":{}\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/file/:field DELETE endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfilefield_DELETE/index.html"}
{"id": "45139bb36d5c-0", "text": "/KBContents/config PUT\nCreates and/or updates the config settings for the KBContents module\nSummary:\n    This endpoint is used to create and/or update the config settings for the KBContents module as json data.\n    It extends the core config endpoint by adding the functionality to process deleted languages and documents\n    related to them.\nQuery Parameters:\nParam\nDescription\nOptional\nInput Example:\n    {\n        \"languages\":[{\n            \"en\":\"English\",\n            \"primary\":true\n        },{\n            \"de\":\"German\",\n            \"primary\":false\n        }],\n        \"category_root\":\"31696245-0438-ff7a-9144-544f8c659daf\",\n        \"deleted_languages\":[\"es\",\"ru\"]\n    }\n    \nOutput Example:\n    {\n        \"languages\":[{\n            \"en\":\"English\",\n            \"primary\":true\n        },{\n            \"de\":\"German\",\n            \"primary\":false\n        }],\n        \"category_root\":\"31696245-0438-ff7a-9144-544f8c659daf\",\n        \"deleted_languages\":[\"es\",\"ru\"]\n    }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsconfig_PUT/index.html"}
{"id": "cafb9669f6f3-0", "text": "/<module>/:record GET\nOverview\n    Retrieves a record.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            <record field>\n        \n            <record field type>\n        \n            Returns the fields for the selected record.\n        \nResponse\n{\n   \"id\":\"bdd59d85-687b-1739-b00a-512d09f6db9e\",\n   \"name\":\"Insight Marketing Inc\",\n   \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n   \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n   \"modified_user_id\":\"1\",\n   \"modified_by_name\":\"Administrator\",\n   \"created_by\":\"1\",\n   \"created_by_name\":\"Administrator\",\n   \"description\":\"\",\n   \"img\":\"\",\n   \"last_activity_date\":\"2013-02-26T19:12:00+00:00\",\n   \"deleted\":false,\n   \"assigned_user_id\":\"seed_max_id\",\n   \"assigned_user_name\":\"Max Jensen\",\n   \"team_name\":[\n      {\n         \"id\":\"East\",\n         \"name\":\"East\",\n         \"name_2\":\"\",\n         \"primary\":false\n      },\n      {\n         \"id\":1,\n         \"name\":\"Global\",\n         \"name_2\":\"\",\n         \"primary\":false\n      },\n      {\n         \"id\":\"West\",\n         \"name\":\"West\",\n         \"name_2\":\"\",\n         \"primary\":true\n      }\n   ],\n   \"linkedin\":\"\",\n   \"facebook\":\"\",\n   \"twitter\":\"\",\n   \"googleplus\":\"\",\n   \"account_type\":\"Customer\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_GET/index.html"}
{"id": "cafb9669f6f3-1", "text": "\"googleplus\":\"\",\n   \"account_type\":\"Customer\",\n   \"industry\":\"Electronics\",\n   \"annual_revenue\":\"\",\n   \"phone_fax\":\"\",\n   \"billing_address_street\":\"345 Sugar Blvd.\",\n   \"billing_address_street_2\":\"\",\n   \"billing_address_street_3\":\"\",\n   \"billing_address_street_4\":\"\",\n   \"billing_address_city\":\"San Mateo\",\n   \"billing_address_state\":\"CA\",\n   \"billing_address_postalcode\":\"56019\",\n   \"billing_address_country\":\"USA\",\n   \"rating\":\"\",\n   \"phone_office\":\"(927) 136-9572\",\n   \"phone_alternate\":\"\",\n   \"website\":\"www.sectionvegan.de\",\n   \"ownership\":\"\",\n   \"employees\":\"\",\n   \"ticker_symbol\":\"\",\n   \"shipping_address_street\":\"345 Sugar Blvd.\",\n   \"shipping_address_street_2\":\"\",\n   \"shipping_address_street_3\":\"\",\n   \"shipping_address_street_4\":\"\",\n   \"shipping_address_city\":\"San Mateo\",\n   \"shipping_address_state\":\"CA\",\n   \"shipping_address_postalcode\":\"56019\",\n   \"shipping_address_country\":\"USA\",\n   \"email1\":\"kid.support.vegan@example.info\",\n   \"parent_id\":\"\",\n   \"sic_code\":\"\",\n   \"parent_name\":\"\",\n   \"email_opt_out\":false,\n   \"invalid_email\":false,\n   \"email\":[\n      {\n         \"email_address\":\"kid.support.vegan@example.info\",\n         \"opt_out\":\"0\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"1\"\n      },\n      {\n         \"email_address\":\"phone.kid@example.cn\",\n         \"opt_out\":\"0\",\n         \"invalid_email\":\"0\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_GET/index.html"}
{"id": "cafb9669f6f3-2", "text": "\"opt_out\":\"0\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"0\"\n      }\n   ],\n   \"campaign_id\":\"\",\n   \"campaign_name\":\"\",\n   \"my_favorite\":false,\n   \"_acl\":{\n      \"fields\":{\n      }\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_GET/index.html"}
{"id": "7feae5c8e12a-0", "text": "/Cases/clients/portal PUT\nOverview\n[ADMIN] Set a case as 'Requested For Close'\nSummary\nThis endpoint sets a case as 'Requested for Close' in the portal on a Sugar Serve instance.\nRequest Arguments\nThis endpoint does not accept any arguments.\nResponse Arguments\nName\nType\nDescription\n<record field>\n<record field type>\nReturns the fields for the updated Cases record.\nResponse\n{\n    \"id\":\"d6582610-d69b-11ea-afe4-acde48001122\",\n    \"name\":\"Need to purchase additional licenses\",\n    \"date_entered\":\"2020-08-04T21:44:16+00:00\",\n    \"date_modified\":\"2020-08-04T21:56:03+00:00\",\n    \"modified_user_id\":\"19dc0582-d69c-11ea-95e6-acde48001122\",\n    \"modified_by_name\":\"Sugar Customer Support Portal \",\n    \"created_by\":\"1\",\n    \"created_by_name\":\"Administrator\",\n    \"description\":\"\",\n    \"deleted\":false,\n    \"case_number\":150,\n    \"type\":\"Product\",\n    \"status\":\"Pending Input\",\n    \"priority\":\"P2\",\n    \"resolution\":\"\",\n    \"work_log\":\"\",\n    \"follow_up_datetime\":\"\",\n    \"widget_follow_up_datetime\":\"\",\n    \"resolved_datetime\":\"\",\n    \"hours_to_resolution\":null,\n    \"business_hours_to_resolution\":null,\n    \"pending_processing\":false,\n    \"account_name\":\"Gifted Holdings AG\",\n    \"business_center_id\":\"\",\n    \"source\":\"\",\n    \"request_close\":true,\n    \"request_close_date\":\"2020-08-04T21:56:03+00:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Casesclientsportal_PUT/index.html"}
{"id": "7feae5c8e12a-1", "text": "\"portal_viewable\":true,\n    \"widget_status\":\"\",\n    \"primary_contact_name\":\"\",\n    \"team_count\":\"\",\n    \"team_name\":[{\"id\":\"West\",\"name\":\"West\",\"name_2\":\"\",\"primary\":true,\"selected\":false}],\n    \"first_response_target_datetime\":\"\",\n    \"first_response_actual_datetime\":\"\",\n    \"hours_to_first_response\":null,\n    \"business_hrs_to_first_response\":null,\n    \"first_response_var_from_target\":null,\n    \"first_response_sla_met\":\"\",\n    \"first_response_user_id\":\"\",\n    \"first_response_user_name\":\"\",\n    \"first_response_sent\":false,\n    \"_acl\":{\"edit\":\"no\",\"create\":\"no\",\"fields\":{}},\"_module\":\"Cases\"\n}\nChange Log\nVersion\nChange\nv11_10\nAdded /Cases/clients/portal\u00c2\u00a0PUT endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Casesclientsportal_PUT/index.html"}
{"id": "95be73fd03c7-0", "text": "/Administration/idm/migration/disable POST\nOverview\n    [ADMIN] Disable Idm migrations\nSummary\n    This endpoint disables Idm migrations. This endpoint is only available to administrators.\nRequest Arguments\n    This endpoint does not accept any arguments.\nResponse\n{\n    \"success\": true\n}\nChange Log\nVersion\nChange\n            v11_2\n        \n            Added Administration/idm/migration/disable POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationidmmigrationdisable_POST/index.html"}
{"id": "d84e772baf8f-0", "text": "/Calls POST\nOverview\n    Create a single event or a series of event records.\nRequest Arguments\nName\nType\nDescription\nRequired\n            <record field>\n        \n            <record field type>\n        \n            The name value list of fields to populate.\n        \n            True\n        \nRequest\n{\n    \"name\":\"Department Meeting\",\n    \"description\":\"Weekly Department Meeting\",\n    \"date_start\":\"yyyy-mm-ddThh:mm:ss-00:00\",\n    \"date_end\":\"yyyy-mm-ddThh:mm:ss-00:00\",\n    \"repeat_type\":\"Weekly\",\n    \"repeat_interval\":\"1\",  /* Every Week */\n    \"repeat_dow\":\"25\",      /* Tue and Fri */\n    \"repeat_count\":\"4\",     /* 4 Recurrences */\n    \"repeat_until\":\"\",\n}\nResponse Arguments\nName\nDescription\nStart Date\nEnd Date\n            <record field>\n        \n            Returns the fields for the newly created record.\n        \nResponse\n{\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module> POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Calls_POST/index.html"}
{"id": "a38a097b3526-0", "text": "/<module>/:record/file/:field PUT\nOverview\n    This endpoint takes a file or image and saves it to a record that already contains an attachment in the specified field. The PUT method is very similar to the POST method but differs slightly in how the request is constructed. PUT requests should send the file data as the body of the request. Optionally, a filename query parameter can be sent with the request to assign a name. Additionally, the PUT \n    method can accept base64 encoded file data which will be decoded by the endpoint\n    if the content_transfer_encoding parameter is set to 'base64'.NOTE: In lieu of the content_transfer_encoding parameter, a\n    request header of X-Content-Transfer-Encoding can also be sent with a value\n    of 'base64'. In the event both the content transfer encoding header and request\n    parameter are sent, the header will be used.\nRequest Arguments\nName\nType\nDescription\nRequired\n            filename\n        \n            String\n        \n            Filename to save the document as\n        \n            False\n        \n            content_transfer_encoding\n        \n            String\n        \n            When set to 'base64', indicates the file contents are base64 encoded\n            and will result in the file contents being base64 decoded before being\n            saved\n        \n            False\n        \nRequest\nPUT /rest/v10/Notes/abcd-1234/file/field/ HTTP/1.1 Host: localhost Connection: keep-alive Content-Length: 23456 Content-Type: application/document-doc ...This is where the bin data would be\nResponse Arguments\nName\nType\nDescription\n            field\n        \n            Array\n        \n            The fields containing file properties.\n        \n            field.content-type\n        \n            String\n        \n            The files content type.\n        \n            field.content-length\n        \n            Integer\n        \n            The files content length.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfilefield_PUT/index.html"}
{"id": "a38a097b3526-1", "text": "Integer\n        \n            The files content length.\n        \n            field.name\n        \n            String\n        \n            The files name.\n        \n            field.width\n        \n            Integer\n        \n            The width of the image.\n        \n            field.height\n        \n            Integer\n        \n            The height of the image.\n        \n            field.uri\n        \n            String\n        \n            The URI of the file.\n        \nResponse\n{\n   \"picture\":{\n      \"content-type\":\"image\\/png\",\n      \"content-length\":72512,\n      \"name\":\"1a7b8f5c-b11c-0094-c8d8-512e9daaa983\",\n      \"width\":933,\n      \"height\":519,\n      \"uri\":\"http:\\/\\/sugarcrm\\/rest\\/v10\\/Contacts\\/fa300a0e-0ad1-b322-9601-512d0983c19a\\/file\\/picture\"\n   }\n    \"attachment\":{\n        \"content-type\":\"application/document-doc\",\n        \"content-length\":\"873921\",\n        \"name\":\"myFile.doc\",\n        \"uri\": \"http:\\/\\/sugarcrm\\/rest\\/v10\\/Contacts\\/f2f9aa4d-99a8-e86e-f4d5-512d0986effa\\/file\\/attachment\"\n    }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/file/:field PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfilefield_PUT/index.html"}
{"id": "69a008ecc91a-0", "text": "/Teams/:record/link/:link_name/:remote_id DELETE\nOverview\n    Deletes an existing relationship between two records.\nRequest Arguments\n    This endpoint does not accept any arguments.\nResponse Arguments\nName\nType\nDescription\n            record\n        \n            Array\n        \n            The record to disassociate from the related record.\n        \n            related_record\n        \n            Array\n        \n            The record that was disassociated.\n        \nResponse\n{\n   \"record\":{\n      \"id\":\"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n      \"name\":\"Slender Broadband Inc - 1000 units\",\n      \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n      \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n      \"modified_user_id\":\"1\",\n      \"modified_by_name\":\"Administrator\",\n      \"created_by\":\"1\",\n      \"created_by_name\":\"Administrator\",\n      \"description\":\"\",\n      \"img\":\"\",\n      \"last_activity_date\":\"2013-02-28T18:36:00+00:00\",\n      \"deleted\":false,\n      \"assigned_user_id\":\"seed_max_id\",\n      \"assigned_user_name\":\"Max Jensen\",\n      \"team_name\":[\n         {\n            \"id\":\"East\",\n            \"name\":\"East\",\n            \"name_2\":\"\",\n            \"primary\":false\n         },\n         {\n            \"id\":\"West\",\n            \"name\":\"West\",\n            \"name_2\":\"\",\n            \"primary\":true\n         }\n      ],\n      \"opportunity_type\":\"\",\n      \"account_name\":\"Slender Broadband Inc\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_DELETE/index.html"}
{"id": "69a008ecc91a-1", "text": "\"opportunity_type\":\"\",\n      \"account_name\":\"Slender Broadband Inc\",\n      \"account_id\":\"181461c6-dc81-1115-1fe0-512d092e8f15\",\n      \"campaign_id\":\"\",\n      \"campaign_name\":\"\",\n      \"lead_source\":\"Campaign\",\n      \"amount\":\"25000\",\n      \"base_rate\":\"1\",\n      \"amount_usdollar\":\"25000\",\n      \"currency_id\":\"-99\",\n      \"currency_name\":\"\",\n      \"currency_symbol\":\"\",\n      \"date_closed\":\"2013-02-27\",\n      \"date_closed_timestamp\":\"1361992480\",\n      \"next_step\":\"\",\n      \"sales_stage\":\"Needs Analysis\",\n      \"sales_status\":\"New\",\n      \"probability\":\"90\",\n      \"best_case\":\"25000\",\n      \"worst_case\":\"25000\",\n      \"commit_stage\":\"include\",\n      \"my_favorite\":false,\n      \"_acl\":{\n         \"fields\":{\n         }\n      }\n   },\n   \"related_record\":{\n      \"id\":\"e689173e-c953-1e14-c215-512d0927e7a2\",\n      \"name\":\"Gus Dales\",\n      \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n      \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n      \"modified_user_id\":\"1\",\n      \"modified_by_name\":\"Administrator\",\n      \"created_by\":\"1\",\n      \"created_by_name\":\"Administrator\",\n      \"description\":\"\",\n      \"img\":\"\",\n      \"deleted\":false,\n      \"assigned_user_id\":\"seed_sally_id\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_DELETE/index.html"}
{"id": "69a008ecc91a-2", "text": "\"deleted\":false,\n      \"assigned_user_id\":\"seed_sally_id\",\n      \"assigned_user_name\":\"Sally Bronsen\",\n      \"team_name\":[\n         {\n            \"id\":\"West\",\n            \"name\":\"West\",\n            \"name_2\":\"\",\n            \"primary\":true\n         }\n      ],\n      \"salutation\":\"\",\n      \"first_name\":\"Gus\",\n      \"last_name\":\"Dales\",\n      \"full_name\":\"Gus Dales\",\n      \"title\":\"Director Operations\",\n      \"linkedin\":\"\",\n      \"facebook\":\"\",\n      \"twitter\":\"\",\n      \"googleplus\":\"\",\n      \"department\":\"\",\n      \"do_not_call\":false,\n      \"phone_home\":\"(661) 120-2292\",\n      \"email\":[\n         {\n            \"email_address\":\"section.sugar.section@example.it\",\n            \"opt_out\":\"1\",\n            \"invalid_email\":\"0\",\n            \"primary_address\":\"0\"\n         },\n         {\n            \"email_address\":\"support.qa.kid@example.co.uk\",\n            \"opt_out\":\"0\",\n            \"invalid_email\":\"0\",\n            \"primary_address\":\"1\"\n         }\n      ],\n      \"phone_mobile\":\"(294) 447-9707\",\n      \"phone_work\":\"(036) 840-3216\",\n      \"phone_other\":\"\",\n      \"phone_fax\":\"\",\n      \"email1\":\"support.qa.kid@example.co.uk\",\n      \"email2\":\"section.sugar.section@example.it\",\n      \"invalid_email\":false,\n      \"email_opt_out\":false,\n      \"primary_address_street\":\"48920 San Carlos Ave\",\n      \"primary_address_street_2\":\"\",\n      \"primary_address_street_3\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_DELETE/index.html"}
{"id": "69a008ecc91a-3", "text": "\"primary_address_street_2\":\"\",\n      \"primary_address_street_3\":\"\",\n      \"primary_address_city\":\"Persistance\",\n      \"primary_address_state\":\"CA\",\n      \"primary_address_postalcode\":\"54556\",\n      \"primary_address_country\":\"USA\",\n      \"alt_address_street\":\"\",\n      \"alt_address_street_2\":\"\",\n      \"alt_address_street_3\":\"\",\n      \"alt_address_city\":\"\",\n      \"alt_address_state\":\"\",\n      \"alt_address_postalcode\":\"\",\n      \"alt_address_country\":\"\",\n      \"assistant\":\"\",\n      \"assistant_phone\":\"\",\n      \"picture\":\"\",\n      \"email_and_name1\":\"\",\n      \"lead_source\":\"Support Portal User Registration\",\n      \"account_name\":\"Arts & Crafts Inc\",\n      \"account_id\":\"d43243c6-9b8e-2973-aee2-512d09bc34b4\",\n      \"opportunity_role_fields\":\"\",\n      \"opportunity_role_id\":\"\",\n      \"opportunity_role\":\"\",\n      \"reports_to_id\":\"\",\n      \"report_to_name\":\"\",\n      \"portal_name\":\"GusDales145\",\n      \"portal_active\":true,\n      \"portal_password\":\"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0\",\n      \"portal_password1\":\"\",\n      \"portal_app\":\"\",\n      \"preferred_language\":\"en_us\",\n      \"campaign_id\":\"\",\n      \"campaign_name\":\"\",\n      \"c_accept_status_fields\":\"\",\n      \"m_accept_status_fields\":\"\",\n      \"accept_status_id\":\"\",\n      \"accept_status_name\":\"\",\n      \"sync_contact\":\"\",\n      \"my_favorite\":false,\n      \"_acl\":{\n         \"fields\":{\n         }", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_DELETE/index.html"}
{"id": "69a008ecc91a-4", "text": "\"_acl\":{\n         \"fields\":{\n         }\n      }\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/link/:link_name/:remote_id DELETE endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_DELETE/index.html"}
{"id": "534e464fb325-0", "text": "/<module>/:record/file/:field GET\nOverview\n    Retrieves an attached file for a specific field on a record.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\n    The response from this request is an HTTP response with a forced download. This can be used in rendering images through the API or in offering immediate file downloads.\nResponse\nCache-Control: no-cache, must-revalidate Connection: keep-alive Content-Encoding: gzip Content-Type: application/octet-stream Date: Mon, 30 Jan 2012 17:00:46 GMT Expires: Mon, 30 Jan 2012 17:00:45 GMT Last-Modified: Thu, 10 Nov 2011 19:01:31 GMT Transfer-Encoding: chunked Vary: Accept-Encoding...\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/file/:field GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfilefield_GET/index.html"}
{"id": "c766660bfe2f-0", "text": "/pmse_Inbox/ReassignForm PUT\nOverview\n    Deprecated endpoint.\nSummary\nThis endpoint is deprecated and will be removed in a future release.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxReassignForm_PUT/index.html"}
{"id": "c754e95965e7-0", "text": "/Mail/recipients/lookup POST\nOverview\n    Accepts an array of one or more recipients and tries to resolve unsupplied arguments to provide more comprehensive\n    data for the recipient(s).\nRequest\n[\n  {\n    \"module\": \"Contacts\",\n    \"id\": \"962cefa8-2f1f-11e6-9ade-80e6500b09a0\",\n    \"email\": \"\",\n    \"name\": \"\"\n  },\n  {\n    \"module\": \"Leads\",\n    \"id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n    \"email\": \"\",\n    \"name\": \"Vince Tallion\"\n  }\n]\nResponse\n[\n  {\n    \"module\": \"Contacts\",\n    \"id\": \"962cefa8-2f1f-11e6-9ade-80e6500b09a0\",\n    \"email\": \"kg@example.com\",\n    \"name\": \"Kelly Germaine\",\n    \"resolved\": true\n  },\n  {\n    \"module\": \"Leads\",\n    \"id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n    \"email\": \"vtallion@example.com\",\n    \"name\": \"Vince Tallion\",\n    \"resolved\": true\n  }\n]\nChange Log\nVersion\nChange\n            v11\n        \n            Last version in which /Mail/recipients/lookup POST is available.\n        \n            v10\n        \n            Added /Mail/recipients/lookup POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailrecipientslookup_POST/index.html"}
{"id": "d36bead58f23-0", "text": "/integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value DELETE\nOverview\nRemoves a relationship based on lhs_sync_key_field_name and rhs_sync_key_field_name. If both the LHS and RHS records can be found with the respective fields, and those records are related, then remove the relationship of the RHS record to the LHS record.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule\nString\nThe module the record belongs to\nTrue\nlhs_sync_key_field_name\nString\nThe name of the LHS field that contains lhs_sync_key_field_value (the default field is named\u00c2\u00a0sync_key but can be renamed via code customization)\nTrue\nlhs_sync_key_field_value\nString\nA unique ID for the LHS record identifying it in an external system\nTrue\nlink_name\nString\nA name for the link\nTrue\nrhs_sync_key_field_name\nString\nThe name of the RHS field that contains rhs_sync_key_field_value (the default field is named\u00c2\u00a0sync_key but can be renamed via code customization)\nTrue\nrhs_sync_key_field_value\nString\nA unique ID for the RHS record identifying it in an external system\nTrue\nRequest\n/integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value\nResponse Arguments\nName\nType\nDescription\nrecord\nString\nThe ID of the record.\nrelated_record\nString\nThe ID of the related record.\nResponse\nStatus 200\n{\n    \"record\": \"a0328573-a252-a27c-3530-4e4297d4c9e1\",\n    \"related_record\": \"a0328573-bc54-a554-3530-4e4297d4c9e1\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulelhs_sync_key_field_namelhs_sync_key_field_valuelinklink_namerhs_sync_key_field_namerhs_sync_key_field_value_DELETE/index.html"}
{"id": "d36bead58f23-1", "text": "}\nStatus 422\n{\n    \"error\": \"invalid_parameter\",\n    \"error_message\": \"Could not find record with :xhs_sync_key_field_name::xhs_sync_key_field_value in module: <module>\"\n}\nChange Log\nVersion\nChange\nv11_10\nAdded /integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value\u00c2\u00a0DELETE endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulelhs_sync_key_field_namelhs_sync_key_field_valuelinklink_namerhs_sync_key_field_namerhs_sync_key_field_value_DELETE/index.html"}
{"id": "0995a4d04fbc-0", "text": "/Administration/config/:category POST\nOverview\n[ADMIN] Set Configuration Settings for a Category.\nSummary\nThis endpoint sets configuration values for a given category. This endpoint is only available to administrators.\nRequest\nPOST /Administration/config/:category\n\u00c2\u00a0\nResponse Example\n{\n    \"a_config\": \"good\"\n}\nChange Log\nVersion\nChange\nv11.13\nAdded\u00c2\u00a0Administration/config/:category\u00c2\u00a0POST endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationconfigcategory_POST/index.html"}
{"id": "4da2cbdae419-0", "text": "/Administration/portalmodules GET\nOverview\n[ADMIN] Gets an array of modules currently enabled for Sugar Portal.\nSummary\nThis endpoint gets an array of modules currently enabled for Sugar Portal. This endpoint is only available to administrators.\nRequest Arguments\nThis endpoint does not accept any arguments.\nResponse Example\n[\n    'Home',\n    'Bugs',\n    'Cases',\n    'KBContents',\n]\nChange Log\nVersion\nChange\nv11.13\nAdded\u00c2\u00a0Administration/portalmodules\u00c2\u00a0GET endpoint\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/AdministrationportalmodulesGET/index.html"}
{"id": "bf1ddc49b355-0", "text": "/Meetings/:record DELETE\nOverview\n    Deletes either a single event record or a series of event records\nRequest Arguments\nName\nType\nDescription\nRequired\n            all_recurrences\n        \n            Boolean\n        \n            Flag to delete all events in a series.\n        \n            False\n        \nRequest\nhttp://{site_url}/rest/v10/Meetings/2c9e5c09-6824-0d14-f5cb-5130321ac3cf?all_recurrences=true\nResponse Arguments\nName\nType\nDescription\n            id\n        \n            String\n        \n            Returns the ID of the deleted record.\n        \nResponse\n{\n    \"id\": \"11cf0d0a-40af-8cb1-9da0-5057a5f511f9\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record DELETE endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Meetingsrecord_DELETE/index.html"}
{"id": "5beb81b90f02-0", "text": "/<module>/record_list/:record_list_id GET\nOverview\n    An API to return record list data\nSummary\n    Get record list data. Only GET request allowed.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule\nstring\n            Module name\n        \nTrue\nrecord_list_id\nguid\n            record list id\n        \nTrue\nRequest Example\nGET /rest/v10/:module/record_list/:id\nResponse Arguments\nName\nType\nDescription\nid\nguid\n            record list id\n        \nassigned_user_id\nguid\n            user id\n        \nmodule_name\nstring\n            Module name\n        \nrecords\narray\n            record ids\n        \ndate modified\ndate\n            date modified\n        \nOutput Example\n{\n    \"id\": \"39d2c781-c0b7-446f-1d83-56c6e3cda510\",\n    \"assigned_user_id\": \"1\",\n    \"module_name\": \"Accounts\",\n    \"records\": [\n        \"e5c8bb3b-5eea-3d8a-c278-56c6affa6212\",\n        \"e49395b4-d3b0-1e3f-600a-56c6afe7e34f\",\n        \"c03ed8ee-60d3-c6a6-55c3-56c6af95e696\",\n        \"d65573e3-c25a-f9b4-33f2-56c6afb8d856\"\n    ],\n    \"date_modified\": \"2016-02-19 09:42:44\"\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_listrecord_list_id_GET/index.html"}
{"id": "e782952a46e7-0", "text": "/<module>/recent-product GET\nOverview\n    Opportunity Recent Product Help\nSummary\n    This endpoint retrieves top 10 recently used Quoted/Revenue Line Items based on the module to display them in the\n    \"Product Catalog Quick Picks\" dashlet in the reverse chronological order.\nRequest Arguments\nNone\nResponse Arguments\nNONE\nResponse\n{\n    \"next_offset\":-1,\n    \"records\":[\n                {\n                    \"id\":\"c1b4680e-c7f2-11e8-9380-7831c1c14620\",\n                    \"name\":\"Brain Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c1b3bf58-c7f2-11e8-92e7-7831c1c14620\",\n                    \"mft_part_num\":\"Smallville Resources Inc 362299XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"370.000000\",\n                    \"discount_price\":\"854.370000\",\n                    \"list_price\":\"863.000000\",\n                    \"cost_usdollar\":\"370.000000\",\n                    \"discount_usdollar\":\"854.370000\",\n                    \"list_usdollar\":\"863.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html"}
{"id": "e782952a46e7-1", "text": "\"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"10.00\",\n                    \"qty_in_stock\":106,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"PercentageDiscount\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"Base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c186a612-c7f2-11e8-9fee-7831c1c14620\",\n                    \"name\":\"Bradford Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c185dbb0-c7f2-11e8-a6b7-7831c1c14620\",\n                    \"mft_part_num\":\"Mississippi Bank Group 133834XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"528.000000\",\n                    \"discount_price\":\"533.333333\",\n                    \"list_price\":\"745.000000\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html"}
{"id": "e782952a46e7-2", "text": "\"list_price\":\"745.000000\",\n                    \"cost_usdollar\":\"528.000000\",\n                    \"discount_usdollar\":\"533.333333\",\n                    \"list_usdollar\":\"745.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"33.00\",\n                    \"qty_in_stock\":70,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"ProfitMargin\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"Base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c1b60434-c7f2-11e8-8964-7831c1c14620\",\n                    \"name\":\"Billie Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c1b3bf58-c7f2-11e8-92e7-7831c1c14620\",\n                    \"mft_part_num\":\"Kringle Bell IncK.A. Tower \\u0026 Co 694143XYZ987\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html"}
{"id": "e782952a46e7-3", "text": "\"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"403.000000\",\n                    \"discount_price\":\"927.000000\",\n                    \"list_price\":\"927.000000\",\n                    \"cost_usdollar\":\"403.000000\",\n                    \"discount_usdollar\":\"927.000000\",\n                    \"list_usdollar\":\"927.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"16.00\",\n                    \"qty_in_stock\":148,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"IsList\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"Base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c18e0448-c7f2-11e8-86b0-7831c1c14620\",\n                    \"name\":\"Arla Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html"}
{"id": "e782952a46e7-4", "text": "\"category_id\":\"c18b8b64-c7f2-11e8-8c1a-7831c1c14620\",\n                    \"mft_part_num\":\"24\\/7 Couriers 795391XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"398.000000\",\n                    \"discount_price\":\"402.020202\",\n                    \"list_price\":\"941.000000\",\n                    \"cost_usdollar\":\"398.000000\",\n                    \"discount_usdollar\":\"402.020202\",\n                    \"list_usdollar\":\"941.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"22.00\",\n                    \"qty_in_stock\":145,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"ProfitMargin\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"Base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c181bd32-c7f2-11e8-b4eb-7831c1c14620\",\n                    \"name\":\"Allyson Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html"}
{"id": "e782952a46e7-5", "text": "\"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c18112d8-c7f2-11e8-b753-7831c1c14620\",\n                    \"mft_part_num\":\"Ink Conglomerate Inc 921535XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"534.000000\",\n                    \"discount_price\":\"842.000000\",\n                    \"list_price\":\"905.000000\",\n                    \"cost_usdollar\":\"534.000000\",\n                    \"discount_usdollar\":\"842.000000\",\n                    \"list_usdollar\":\"905.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"20.00\",\n                    \"qty_in_stock\":26,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"Fixed\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"base_rate\":\"1.000000\"\n                }\n            ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Opportunities/recent_product GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html"}
{"id": "22a5db7f7973-0", "text": "/ForecastManagerWorksheets/export GET\nOverview\n    Returns a record set in CSV format along with HTTP headers to indicate content type.\nRequest Arguments\nName\nType\nDescription\nRequired\n            uid\n        \n            Array\n        \n            A list of bean ids.\n        \n            False\n        \n            filter\n        \n            Array\n        \n            The filter expression. More information on filter expressions can be found in /<module>/filter.\n        \n            False\n        \n            sample\n        \n            Array\n        \n            Indicates whether to download sample data.\n        \n            False\n        \nRequest\nExporting Records by Specific IDs\n{\n   \"uid\":\"d43243c6-9b8e-2973-aee2-512d09bc34b4\"\n}\nExporting Records by a List of IDs\n{\n   \"uid\":[\n      \"d43243c6-9b8e-2973-aee2-512d09bc34b4\",\n      \"b3e87a3f-cd8f-7b86-467a-512d09e8d240\"\n   ]\n}\nExporting Records Using a Filter\n{\n   \"filter\":[\n      {\n         \"name\":\"airline\"\n      }\n   ]\n}\nExporting a Sample Result Set\n{\n    \"sample\":true\n}\nResponse Arguments\nName\nType\nDescription\n            <csv export>\n        \n            String\n        \n            Returns the selected records in CSV format with the content headers.\n        \nResponse\nresult: HTTP/1.1 200 OK\nDate: Fri, 01 Mar 2013 04:05:55 GMT\nServer: Apache/2.2.22 (Unix) DAV/2 PHP/5.3.17", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsexport_GET/index.html"}
{"id": "22a5db7f7973-1", "text": "X-Powered-By: PHP/5.3.17\nExpires: Mon, 26 Jul 1997 05:00:00 GMT\nCache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0\nPragma: cache\nContent-Disposition: attachment; filename=Accounts.csv\nContent-transfer-encoding: binary\nLast-Modified: Fri, 01 Mar 2013 04:05:55 GMT\nCache-Control: post-check=0, pre-check=0\nContent-Length: 1080\nConnection: close\nContent-Type: application/octet-stream; charset=UTF-8\n\"Name\",\"ID\",\"Website\",\"Email Address\",\"Office Phone\",\"Alternate Phone\",\"Fax\",\"Billing Street\",\"Billing City\",\"Billing State\",\"Billing Postal Code\",\"Billing Country\",\"Shipping Street\",\"Shipping City\",\"Shipping State\",\"Shipping Postal Code\",\"Shipping Country\",\"Description\",\"Type\",\"Industry\",\"Annual Revenue\",\"Employees\",\"SIC Code\",\"Ticker Symbol\",\"Parent Account ID\",\"Ownership\",\"Campaign ID\",\"Rating\",\"Assigned User Name\",\"Assigned To\",\"Team ID\",\"Teams\",\"Team Set ID\",\"Date Created\",\"Date Modified\",\"Modified By\",\"Created By\",\"Deleted\",\"Image\",\"last_activity_date\",\"Linkedin Company ID\",\"Facebook Account\",\"Twitter Account\",\"Google Plus ID\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsexport_GET/index.html"}
{"id": "22a5db7f7973-2", "text": "\"Arts & Crafts Inc\",\"d43243c6-9b8e-2973-aee2-512d09bc34b4\",\"\",\"\",\"(052) 034-1853\",\"\",\"\",\"777 West Filmore Ln\",\"Santa Monica\",\"CA\",\"35354\",\"USA\",\"777 West Filmore Ln\",\"Santa Monica\",\"CA\",\"35354\",\"USA\",\"\",\"Customer\",\"Transportation\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"sally\",\"seed_sally_id\",\"West\",\"West\",\"West\",\"02/26/2013 07:12 pm\",\"02/26/2013 07:12 pm\",\"1\",\"1\",\"0\",\"\",\"02/26/2013 07:12 pm\",\"\",\"\",\"\",\"\"\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/export GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsexport_GET/index.html"}
{"id": "c2da72370247-0", "text": "/Users GET\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n            Note that JSON-encoded filters can be specified as query parameters\n            in one of two ways for GET requests:\n            \n                    By specifying individual filter arguments as distinct parameters.\n                    Example: filter[0][id]=1.\n                \n                    By specifying the whole filter as a single JSON-encoded string.\n                    Note that this syntax is currently not supported on certain modules.\n                    Example: filter=[{\"id\":\"1\"}].\n                \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Users_GET/index.html"}
{"id": "c2da72370247-1", "text": "The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. Each field may be represented either by string, or by map\n            containing field name and additional field parameters (applicable to link and collection fields).\n            The fields id and date_modified will always be returned.\n            \n            Example: name,account_type,description,{\"name\":\"opportunities\",\"fields\":[\"id\",\"name\",\"sales_status\"],\"order_by\":\"date_closed:desc\"}\n            For more details on additional field parameters, see\n            Relate API and\n            Collection API.\n        \n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \n            q\n        \n            String\n        \n            A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.\n        \n            False\n        \n            deleted\n        \n            Boolean\n        \n            Boolean to show deleted records in the result set.\n        \n            False\n        \n            nulls_last\n        \n            Boolean", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Users_GET/index.html"}
{"id": "c2da72370247-2", "text": "False\n        \n            nulls_last\n        \n            Boolean\n        \n            Boolean to return records with null values in order_by fields last in the result set.\n        \n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\nExample\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Users_GET/index.html"}
{"id": "c2da72370247-3", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Users_GET/index.html"}
{"id": "c2da72370247-4", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\",\n               \"id\": \"b0701501-1fab-8ae7-3942-540da93f5017\",\n               \"name\": \"360 Vacations - 228 Units\",\n               \"date_modified\": \"2014-09-08T16:05:00+03:00\",\n               \"sales_status\": \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Users_GET/index.html"}
{"id": "c2da72370247-5", "text": "{\n               _module: \"Opportunities\"\n               date_modified: \"2014-09-08T16:05:00+03:00\"\n               id: \"9ce7c088-8ee4-7cd3-18f1-540da944d4c0\"\n               name: \"360 Vacations - 312 Units\"\n               sales_status: \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Users_GET/index.html"}
{"id": "3e91b8c18d59-0", "text": "/pmse_Emails_Templates/file/emailtemplates_import POST\nOverview\n    Imports a Process Email Templates definition from a .pet file\nSummary\n    This endpoint will import a Process Email Templates definition from the\n    uploaded .pet file containing JSON encoded data.\nRequest Arguments\nName\nType\nDescription\nRequired\nN/A\nRequest\nNote: A JSON encoded .pet file attachment should be included with\nthe request as part of the form-data.\nResponse Arguments\nName\nType\nDescription\nemailtemplates_import\nObject\nResult of the import operation\nResponse\n{\n    \"emailtemplates_import\":\n    {\n         \"success\":true,\n         \"id\":\"aa5f7fd9-73a9-8338-fd1a-573635ce5c51\"\n    }\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesfileemailtemplates_import_POST/index.html"}
{"id": "77cde83b7c06-0", "text": "/<module>/sync_key/:sync_key_field_value DELETE\nOverview\nDeletes the record with the given sync_key.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule\nString\nThe module the record belongs to\nTrue\nsync_key_field_value\nString\nA unique ID for the record identifying it in an external system\nTrue\nRequest\n/<module>/sync_key/:sync_key_field_value\nResponse Arguments\nName\nType\nDescription\nrecord\nString\nThe ID of the record that was deleted.\nResponse\nStatus 200\n{    \"id\": \"a0328573-a252-a27c-3530-4e4297d4c9e1\"} \nChange Log\nVersion\nChange\nv11_10\nAdded /<module>/sync_key/:sync_key_field_value\u00c2\u00a0DELETE endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulesync_keysync_key_field_value_DELETE/index.html"}
{"id": "817cdd7b7c27-0", "text": "/pmse_Inbox/casesList GET\nOverview\n    Returns a list with the processes for Process Management \nSummary\n    This endpoint gets a list of Processes. \nRequest Arguments\nName\nType\nDescription\nRequired\nmodule_list\nstring\nIdentifier used to determine which status to filter against\nfalse\norder_by\nstring\nHow to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon.\nfalse\nq\nstring\nA search expression, will search on this module. Cannot be used at the same time as a filter expression or id.\nfalse\nfilter\nstring\nThe filter expression\nfalse\nfilter_id\nstring\nIdentifier for a preexisting filter. If filter is also set, the two filters are joined with an AND.\nfalse\nmax_num\ninteger\nA maximum number of records to return. Default is 20.\nfalse\noffset\ninteger\nThe number of records to skip over before records are returned. Default is 0.\nfalse\nfields\nstring\nComma delimited list of fields to return\nfalse\ndeleted\nboolean\nBoolean to show deleted records in the result set.\nfalse\nResponse Arguments\nName\nType\nDescription\nnext_offset\nInteger\nNext offset\nrecords\n<field>/<value>\nList of process attributes\nResponse\n{\n    {\n        \"next_offset\":-1,\n        \"records\":\n        [\n            {\n                \"id\":\"3922976c-284f-11e6-9f40-6c4008960436\",\n                \"name\":\"ABC2\",\n                \"date_entered\":\"2016-06-01T16:18:59-07:00\",\n                \"date_modified\":\"2016-06-01T16:18:59-07:00\",\n                \"modified_user_id\":\"1\",\n                \"created_by\":\"1\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxcasesList_GET/index.html"}
{"id": "817cdd7b7c27-1", "text": "\"modified_user_id\":\"1\",\n                \"created_by\":\"1\",\n                \"deleted\":\"0\",\n                \"cas_id\":\"2\",\n                \"cas_parent\":\"0\",\n                \"cas_status\":\"IN PROGRESS\",\n\t\t\"pro_id\":\"6e172e2c-2842-11e6-a4bb-6c4008960436\",\n\t\t\"cas_title\":\"ABC2\",\n\t\t\"cas_custom_status\":\"\",\n\t\t\"cas_init_user\":\"1\",\n\t\t\"cas_create_date\":\"2016-06-01T16:18:59-07:00\",\n\t\t\"cas_update_date\":\"2016-06-01 23:18:59\",\n\t\t\"cas_finish_date\":null,\n\t\t\"cas_assigned_status\":\"UNASSIGNED\",\n\t\t\"cas_module\":\"Accounts\",\n\t\t\"team_id\":\"1\",\n\t\t\"team_set_id\":\"1\",\n\t\t\"assigned_user_id\":\"1\",\n\t\t\"assigned_user_name\":\"Administrator\",\n\t\t\"prj_id\":\"6e025038-2842-11e6-b4f7-6c4008960436\",\n\t\t\"prj_created_by\":\"1\",\n\t\t\"prj_module\":\"Accounts\",\n\t\t\"cas_sugar_module\":\"Accounts\",\n\t\t\"cas_sugar_object_id\":\"38beb03a-284f-11e6-b059-6c4008960436\",\n\t\t\"pro_title\":\"PD1\",\n\t\t\"prj_deleted\":\"0\",\n\t\t\"prj_user_id_full_name\":\"Administrator\",\n\t\t\"cas_user_id_full_name\":\"Sarah Smith\"\n            },\n    } \n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxcasesList_GET/index.html"}
{"id": "cde14a186ed3-0", "text": "/Mail/attachment/:file_guid DELETE\nOverview\n    Delete an updated email attachment (where :file_guid is the guid value returned from the /Mail/attachment API)\nQuery Parameters:\n    This endpoint does not accept any parameters.\nInput Example:\n    This endpoint does not accept any input.\nOutput Example:\n    If successful, the endpoint responds with a bool of true.\nChange Log\nVersion\nChange\n            v11\n        \n            Last version in which /Mail/attachment/:file_guid DELETE is available. Use\n            /Notes/:id/file/filename DELETE to delete a file from the filesystem. Use\n            /Emails/:record/link/attachments/:remote_id DELETE to remove an attachment from an\n            email. Note that removing an attachment from an email will also delete it from the filesystem.\n        \n            v10\n        \n            Added /Mail/attachment/:file_guid DELETE endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailattachmentfile_guid_DELETE/index.html"}
{"id": "85188288b16c-0", "text": "/me PUT\nOverview\n    Returns the current user object.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nResponse User Example\n{\n   \"current_user\":{\n      \"type\":\"user\",\n      \"id\":\"1\",\n      \"full_name\":\"Administrator\",\n      \"timepref\":\"h:ia\",\n      \"timezone\":\"America/Los_Angles\",\n      \"user_name\":\"admin\"\n   }\n}\nResponse Portal User Example\n{\n   \"current_user\":{\n      \"type\":\"support_portal\",\n      \"id\":\"1234-567\",\n      \"user_id\":\"abcd-123\",\n      \"full_name\":\"Bill Williamson\",\n      \"timepref\":\"h:ia\",\n      \"timezone\":\"America/Denver\",\n      \"user_name\":\"SupportPortalApi\"\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /me PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/me_PUT/index.html"}
{"id": "c5c7bdf428e8-0", "text": "/Administration/config/:category GET\nOverview\n[ADMIN] Get Configuration Settings for a Category.\nSummary\nThis endpoint gets configuration values for a given category. This endpoint is only available to administrators.\nRequest\nGET /Administration/config/:category\n\u00c2\u00a0\nResponse Example\n{\n    \"a_config\": \"good\"\n}\nChange Log\nVersion\nChange\nv11.13\nAdded\u00c2\u00a0Administration/config/:category\u00c2\u00a0GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationconfigcategory_GET/index.html"}
{"id": "244a74bfc90e-0", "text": "/Administration/packages GET\nOverview\n[ADMIN] PackageManager list packages.\nSummary\nLists all packages in the system.\nResponse\n{\n    \"packages\": [\n        {\n            \"name\": \"project_P3\",\n            \"version\": \"1580885734\",\n            \"type\": \"module\",\n            \"published_date\": \"2020-02-06 12:51:17\",\n            \"description\": \"\",\n            \"uninstallable\": true,\n            \"file_install\": \"cd590eb069a73b2eeb6c107776fd60dc\",\n            \"file\": \"cd590eb069a73b2eeb6c107776fd60dc\",\n            \"enabled\": \"ENABLED\",\n            \"id\": \"66172e0e-48df-11ea-9f1f-acde48001122\",\n            \"installed\": true\n        },\n        {\n            \"name\": \"project_P1\",\n            \"version\": 1580885419,\n            \"published_date\": \"2020-02-05 06:50:19\",\n            \"description\": \"None\",\n            \"uninstallable\": \"Yes\",\n            \"type\": \"Module\",\n            \"file\": \"0ef4dd8b237f4358bdb246a744eb2b38\",\n            \"file_install\": \"5d4b4614421586fd2111714abf622392\",\n            \"unFile\": \"5d4b4614421586fd2111714abf622392\",\n            \"installed\": false\n        }\n    ]\n}\nChange Log\nVersion\nChange\nv11.8\nAdded /Administration/packages GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationpackages_GET/index.html"}
{"id": "5a6c2a15d4c8-0", "text": "/<module>/Activities GET\nActivities on a module's list view\nSummary:\n  This endpoint lists activities across a particular module in the system. It uses a subscription model, and can be queried like a normal bean collection, but without search, ordering or filtering.\nQuery Parameters:\nParamDescriptionOptionalmax_numA maximum number of records to returnOptionaloffsetHow many records to skip over before records are returnedOptional\nInput Example:\nThis endpoint does not accept any input\nOutput Example:\n{\n    \"next_offset\": 20, This will be set to -1 when there are no more records after this \"page\".\n    \"records\": [{\n        \"id\": \"22fb8b16-de1d-f1dc-b15b-51240efde177\",\n        \"date_entered\": \"2013-02-19T23:47:11+00:00\",\n        \"date_modified\": \"2013-02-19T23:47:11+00:00\",\n        \"created_by\": \"1\",\n        \"deleted\": \"0\",\n        \"parent_id\": \"f5bb0331-2c0f-5c7c-b4db-5123caac0056\",\n        \"parent_type\": \"Contacts\",\n        \"activity_type\": \"post\", This will be the type of activity performed.\n        \"data\": {\n            \"value\": \"This is a test post on a contact I'm subscribed to.\"\n        },\n        \"comment_count\": 0, This will be set to the total number of comments on the post.\n        \"last_comment\": { This will be the last comment on the post, which can be used to create a comment model on the frontend.\n            \"deleted\": 0,\n            \"data\": []\n        },\n        \"fields\": [],\n        \"first_name\": null,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleActivities_GET/index.html"}
{"id": "5a6c2a15d4c8-1", "text": "},\n        \"fields\": [],\n        \"first_name\": null,\n        \"last_name\": \"Administrator\",\n        \"created_by_name\": \" Administrator\" This will be the locale-formatted full name of the user.\n    }, ... ]\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleActivities_GET/index.html"}
{"id": "ddf3682cf80c-0", "text": "/<module>/count GET\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n            Note that JSON-encoded filters can be specified as query parameters\n            in one of two ways for GET requests:\n            \n                    By specifying individual filter arguments as distinct parameters.\n                    Example: filter[0][id]=1.\n                \n                    By specifying the whole filter as a single JSON-encoded string.\n                    Note that this syntax is currently not supported on certain modules.\n                    Example: filter=[{\"id\":\"1\"}].\n                \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulecount_GET/index.html"}
{"id": "ddf3682cf80c-1", "text": "False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. Each field may be represented either by string, or by map\n            containing field name and additional field parameters (applicable to link and collection fields).\n            The fields id and date_modified will always be returned.\n            \n            Example: name,account_type,description,{\"name\":\"opportunities\",\"fields\":[\"id\",\"name\",\"sales_status\"],\"order_by\":\"date_closed:desc\"}\n            For more details on additional field parameters, see\n            Relate API and\n            Collection API.\n        \n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \n            q\n        \n            String\n        \n            A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.\n        \n            False\n        \n            deleted\n        \n            Boolean\n        \n            Boolean to show deleted records in the result set.\n        \n            False\n        \n            nulls_last\n        \n            Boolean", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulecount_GET/index.html"}
{"id": "ddf3682cf80c-2", "text": "False\n        \n            nulls_last\n        \n            Boolean\n        \n            Boolean to return records with null values in order_by fields last in the result set.\n        \n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\nExample\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulecount_GET/index.html"}
{"id": "ddf3682cf80c-3", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulecount_GET/index.html"}
{"id": "ddf3682cf80c-4", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\",\n               \"id\": \"b0701501-1fab-8ae7-3942-540da93f5017\",\n               \"name\": \"360 Vacations - 228 Units\",\n               \"date_modified\": \"2014-09-08T16:05:00+03:00\",\n               \"sales_status\": \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulecount_GET/index.html"}
{"id": "ddf3682cf80c-5", "text": "{\n               _module: \"Opportunities\"\n               date_modified: \"2014-09-08T16:05:00+03:00\"\n               id: \"9ce7c088-8ee4-7cd3-18f1-540da944d4c0\"\n               name: \"360 Vacations - 312 Units\"\n               sales_status: \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulecount_GET/index.html"}
{"id": "306803ca7f6b-0", "text": "/Mail POST\nOverview\n    Create an email and send or save as draft.\nQuery String Parameters\n    This endpoint does not accept any query string parameters.\nInput Parameters\nName\nType\nDescription\nRequired\n            email_config\n        \n            String\n        \n            ID of the outbound email configuration to use when sending this email\n        \n            True\n        \n            to_addresses\n        \n            Array\n        \n            Array of name/email address pairs for the TO field, when present, only email subfield is required (not name).\n        \n            True\n        \n            cc_addresses\n        \n            Array\n        \n            Array of name/email address pairs for the CC field, when present, email subfield is required.\n        \n            False\n        \n            bcc_addresses\n        \n            Array\n        \n            Array of name/email address pairs for the BCC field, when present, email subfield is required.\n        \n            False\n        \n            subject\n        \n            String\n        \n            Subject of the email\n        \n            False\n        \n            html_body\n        \n            String\n        \n            HTML body of the email\n        \n            False\n        \n            text_body\n        \n            String\n        \n            Text body of the email\n        \n            False\n        \n            status\n        \n            String\n        \n            Indicates the status of the email - 'draft' or 'ready' (ready to be sent)\n        \n            True\n        \n            related\n        \n            Object\n        \n            Contains 'parent_type' and 'parent_id' to relate this email to (for example 'Contact' and a contact's id)\n        \n            False\n        \n            teams\n        \n            Object", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mail_POST/index.html"}
{"id": "306803ca7f6b-1", "text": "False\n        \n            teams\n        \n            Object\n        \n            Team(s) to assign this email to. 'primary' attribute is an id string for the primary team and 'other' attribute is an array of id strings for the other teams - only primary is required\n        \n            True\n        \n            attachments\n        \n            Array\n        \n            Array of file attachments - each attachment consists of a 'type' (where the attachment came from: upload, document, or template), 'id' (of the file upload, note, document revision, etc), and 'name' (the file name)\n        \n            False\n        \nInput Example\n{\n  \"email_config\":\"abc181a2-5c05-b879-8e68-502279a8c401\",\n  \"to_addresses\":[\n    {\n      \"name\":\"John Doe\",\n      \"email\":\"john_doe@foo.com\"\n    },\n    {\n      \"name\":\"David Madison\",\n      \"email\":\"david_madison@bar.com\"\n    }\n  ],\n  \"cc_addresses\":[\n    {\n      \"name\":\"Tom Swift\",\n      \"email\":\"tswift@baz.com\"\n    }\n  ],\n  \"bcc_addresses\":null,\n  \"subject\":\"Minneapolis Convention\",\n  \"html_body\":\"<html><body>Hello World<\\/body><\\/html>\",\n  \"text_body\":\"Hello World\"\n  \"status\":\"ready\",\n  \"related\": {\n    \"type\":\"Contacts\",\n    \"id\":\"61cf0f8d-938c-c9b2-53ad-51ed7bbcf83b\"\n  },\n  \"teams\": {\n    \"primary\": \"dabec868-696c-f458-e204-50227995ab50\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mail_POST/index.html"}
{"id": "306803ca7f6b-2", "text": "\"others\": [\n      \"c3094c88-c95f-2e17-4553-50227996ad20\",\n      \"abcde868-696c-f458-e704-58369095ab62\"\n    ]\n  },\n  \"attachments\": [\n    {\n       \"type\": \"upload\",\n       \"id\": \"cfbe4551-548d-f602-b228-45387645fc12\",\n       \"name\": \"company_logo.jpg\"\n    },\n    {\n       \"type\": \"document\",\n       \"id\": \"876112a4-89c1-4ba7-a05a-7729a7a76818\"\n    },\n    {\n       \"type\": \"template\",\n       \"id\": \"002cfe6c-98e9-4342-bdb1-1660d0788872\"\n    }\n  ],\n}\nResult\nName\nType\nDescription\n            <email record field>\n        \n            <email record field type>\n        \n            Returns the fields for the newly created email record.\n        \nOutput Example\n{\n    \"team_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n    \"team_set_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n    \"id\": \"d9c165d0-8863-ba61-dc85-51ed8016c476\",\n    \"date_entered\": \"2013-07-22 18:57:57\",\n    \"date_modified\": \"2013-07-22 18:57:57\",\n    \"assigned_user_id\": \"1\",\n    \"assigned_user_name\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mail_POST/index.html"}
{"id": "306803ca7f6b-3", "text": "\"assigned_user_id\": \"1\",\n    \"assigned_user_name\": \"\",\n    \"modified_user_id\": \"1\",\n    \"modified_by_name\": \"admin\",\n    \"created_by\": \"1\",\n    \"created_by_name\": \"\",\n    \"deleted\": 0,\n    \"from_addr_name\": \"SugarCRM\",\n    \"reply_to_addr\": \"\",\n    \"to_addrs_names\": \"john_doe@foo.com, david_madison@bar.com\",\n    \"cc_addrs_names\": \"tswift@baz.com\",\n    \"description_html\": \"<html><body>Hello World<\\/body><\\/html>\",\n    \"description\": \"Hello World\",\n    \"date_sent\": \"2013-07-22 18:57:00\",\n    \"name\": \"Minneapolis Convention\",\n    \"type\": \"out\",\n    \"status\": \"sent\",\n    \"parent_type\": \"Contacts\",\n    \"parent_id\": \"61cf0f8d-938c-c9b2-53ad-51ed7bbcf83b\",\n}\nChange Log\nVersion\nChange\n            v11\n        \n            Last version in which /Mail POST is available. Use /Emails POST instead.\n        \n            v10\n        \n            Added /Mail POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mail_POST/index.html"}
{"id": "d701e06a4d6f-0", "text": "/ForecastWorksheets/export GET\nOverview\n    Returns a record set in CSV format along with HTTP headers to indicate content type.\nRequest Arguments\nName\nType\nDescription\nRequired\n            uid\n        \n            Array\n        \n            A list of bean ids.\n        \n            False\n        \n            filter\n        \n            Array\n        \n            The filter expression. More information on filter expressions can be found in /<module>/filter.\n        \n            False\n        \n            sample\n        \n            Array\n        \n            Indicates whether to download sample data.\n        \n            False\n        \nRequest\nExporting Records by Specific IDs\n{\n   \"uid\":\"d43243c6-9b8e-2973-aee2-512d09bc34b4\"\n}\nExporting Records by a List of IDs\n{\n   \"uid\":[\n      \"d43243c6-9b8e-2973-aee2-512d09bc34b4\",\n      \"b3e87a3f-cd8f-7b86-467a-512d09e8d240\"\n   ]\n}\nExporting Records Using a Filter\n{\n   \"filter\":[\n      {\n         \"name\":\"airline\"\n      }\n   ]\n}\nExporting a Sample Result Set\n{\n    \"sample\":true\n}\nResponse Arguments\nName\nType\nDescription\n            <csv export>\n        \n            String\n        \n            Returns the selected records in CSV format with the content headers.\n        \nResponse\nresult: HTTP/1.1 200 OK\nDate: Fri, 01 Mar 2013 04:05:55 GMT\nServer: Apache/2.2.22 (Unix) DAV/2 PHP/5.3.17", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsexport_GET/index.html"}
{"id": "d701e06a4d6f-1", "text": "X-Powered-By: PHP/5.3.17\nExpires: Mon, 26 Jul 1997 05:00:00 GMT\nCache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0\nPragma: cache\nContent-Disposition: attachment; filename=Accounts.csv\nContent-transfer-encoding: binary\nLast-Modified: Fri, 01 Mar 2013 04:05:55 GMT\nCache-Control: post-check=0, pre-check=0\nContent-Length: 1080\nConnection: close\nContent-Type: application/octet-stream; charset=UTF-8\n\"Name\",\"ID\",\"Website\",\"Email Address\",\"Office Phone\",\"Alternate Phone\",\"Fax\",\"Billing Street\",\"Billing City\",\"Billing State\",\"Billing Postal Code\",\"Billing Country\",\"Shipping Street\",\"Shipping City\",\"Shipping State\",\"Shipping Postal Code\",\"Shipping Country\",\"Description\",\"Type\",\"Industry\",\"Annual Revenue\",\"Employees\",\"SIC Code\",\"Ticker Symbol\",\"Parent Account ID\",\"Ownership\",\"Campaign ID\",\"Rating\",\"Assigned User Name\",\"Assigned To\",\"Team ID\",\"Teams\",\"Team Set ID\",\"Date Created\",\"Date Modified\",\"Modified By\",\"Created By\",\"Deleted\",\"Image\",\"last_activity_date\",\"Linkedin Company ID\",\"Facebook Account\",\"Twitter Account\",\"Google Plus ID\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsexport_GET/index.html"}
{"id": "d701e06a4d6f-2", "text": "\"Arts & Crafts Inc\",\"d43243c6-9b8e-2973-aee2-512d09bc34b4\",\"\",\"\",\"(052) 034-1853\",\"\",\"\",\"777 West Filmore Ln\",\"Santa Monica\",\"CA\",\"35354\",\"USA\",\"777 West Filmore Ln\",\"Santa Monica\",\"CA\",\"35354\",\"USA\",\"\",\"Customer\",\"Transportation\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"sally\",\"seed_sally_id\",\"West\",\"West\",\"West\",\"02/26/2013 07:12 pm\",\"02/26/2013 07:12 pm\",\"1\",\"1\",\"0\",\"\",\"02/26/2013 07:12 pm\",\"\",\"\",\"\",\"\"\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/export GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsexport_GET/index.html"}
{"id": "8a1bfaa4fc48-0", "text": "/Administration/elasticsearch/replicas/enable POST\nOverview\n    [ADMIN] Elasticsearch enable replicas\nSummary\n    Enable replicas for all indices managed by SugarCRM. This endpoint is only\n    available to administrators. This requires reindex_zero_replica to be enabled.\nResponse\n{\n  \"aabbcc_contactsleads\": 200,\n  \"aabbcc_accountsonly\": 200,\n  \"aabbcc_shared\": 200\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Administration/elasticsearch/replicas/enable POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchreplicasenable_POST/index.html"}
{"id": "c741827928ca-0", "text": "/<module>/:record/pii GET\nOverview\n    Returns personally identifiable information (pii) fields with current data and source of data capture for a specific record.\nVersion Requirements\n    Minimum REST API Version required - 11.1\nRequest Arguments\nName\nType\nDescription\nRequired\n            module\n        \n            String\n        \n            The name of the module.\n        \n            True\n        \n            record\n        \n            String\n        \n            The record id.\n        \n            True\n        \nResponse Arguments\nName\nType\nDescription\n            records\n        \n            String\n        \n            Returns the set of PII field records for the given module record.\n        \nResponse\n{\n  \"fields\": [\n    {\n      \"field_name\": \"phone_mobile\",\n      \"value\": \"(645) 604-0128\",\n      \"event_type\": \"update\",\n      \"date_modified\": \"2018-02-21T19:56:42+00:00\",\n      \"source\": {\n        \"subject\": {\n          \"_type\": \"user\",\n          \"id\": \"999b3b50-16dc-11e8-9c03-a45e60e64123\",\n          \"_module\": \"Users\",\n          \"client\": {\n            \"_type\": \"rest-api\"\n          },\n          \"first_name\": \"Tim\",\n          \"last_name\": \"Zhang\",\n          \"name\": \"Tim Zhang\"\n        },\n        \"attributes\": {\n          \"platform\": \"base\"\n        }\n      }\n    },\n    {\n      \"field_name\": \"phone_work\",\n      \"value\": \"(212) 692-3480\",\n      \"event_type\": \"update\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordpii_GET/index.html"}
{"id": "c741827928ca-1", "text": "\"event_type\": \"update\",\n      \"date_modified\": \"2018-02-21T19:56:42+00:00\",\n      \"source\": {\n        \"subject\": {\n          \"_type\": \"user\",\n          \"id\": \"654b3b50-16dc-11e8-9c03-a45e60e64465\",\n          \"_module\": \"Users\",\n          \"client\": {\n            \"_type\": \"rest-api\"\n          },\n          \"first_name\": \"Jim\",\n          \"last_name\": \"Conners\",\n          \"name\": \"Jim Conners\"\n        },\n        \"attributes\": {\n          \"platform\": \"base\"\n        }\n      }\n    }\n  ]\n}\nChange Log\nVersion\nChange\n            11.1\n        \n            Added /pii GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordpii_GET/index.html"}
{"id": "80be9109b419-0", "text": "/Forecasts/:timeperiod_id/quotas/rollup/:user_id GET\nForecastsQuotasApi - Get\nSummary:\n    This endpoint is used to return quota information for a specific user ID, in a specific timeperiod and by a specifc type..\nQuery Parameters:\nParam\nDescription\nOptional\ntimeperiod_id\nShow for a specific time period\nRequired\nquota_type\n\"rollup\" or \"direct\" quota\nRequired\nuser_id\nShow for a specific user\nRequired\nInput Example:\nOutput Example:\n{\n    \"currency_id\":\"-99\",\n    \"amount\":\"75.000000\",\n    \"date_modified\":\"2013-09-17 21:23:32\",\n    \"formatted_amount\":\"$75.00\",\n    \"is_top_level_manager\":true\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_idquotasrollupuser_id_GET/index.html"}
{"id": "4963ad8e6f53-0", "text": "/<module>/:record/prev GET\nOverview\n    Retrieves previous sibling of selected record.\nRequest Arguments\nName\nType\nDescription\nRequired\n                module\n            \n                String\n            \n                The name of sugar module that contains a nested set data and implements the NestedSetInterface.\n            \n                True\n            \n                :record\n            \n                String\n            \n                The ID of record\n            \n                True\n            \nResponse Arguments\n    This endpoint does not return any response arguments.\nResponse\n{\n    id: \"e1ae8646-ac90-104a-59d6-5412cf5009b2\"\n    name: \"SugarCategoryExample\"\n    date_entered: \"2014-09-12 10:47:46\"\n    date_modified: \"2014-09-12 10:47:46\"\n    modified_user_id: \"9c9ad14e-1789-3340-f88d-5412cf551d3b\"\n    created_by: \"9c9ad14e-1789-3340-f88d-5412cf551d3b\"\n    description: null\n    deleted: \"0\"\n    source_id: null\n    source_type: null\n    source_meta: null\n    root: \"e1ae8646-ac90-104a-59d6-5412cf5009b2\"\n    lft: \"6\"\n    rgt: \"11\"\n    level: \"1\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/prev GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordprev_GET/index.html"}
{"id": "f1256362353b-0", "text": "/Dashboards/<module> GET\nOverview\n    List current user's filtered dashboards.\nSummary\n    This endpoint will return a set of dashboards filtered by an expression. The filter can be applied to multiple\n    fields and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its\n    id. If both a filter definition and a filter id are passed, currently the definition will override the id,\n    but please do not rely on this behavior as it is subject to change. Care will need to be\n    taken to make sure that any filters used have appropriate indexes on the server side otherwise the runtime of the\n    endpoint will be very long.\nNotice\nThis endpoint is not supported in v11. If you continue to use v10 of the API, your\n    REST calls should behave as below. But, it is advisable to upgrade to v11.Migrating to v11:\n    For more information on behavior in v11, refer to GET /<module>.\n    \n    Recommended Replacement:\nGET /Dashboards\n    The module name is no longer part of the path. To specify a module name, include it as a filter\n    parameter. For example, to retrieve all dashboards from the Accounts module, usev11: \nGET /Dashboards?filter[0][dashboard_module]=Accounts\n    name, id. etc. are no longer specified as default fields. To retain the default fields, usev11: \n        GET /Dashboards?filter[0][dashboard_module]=Accounts&fields=id,name,view_name\n    \nRequest Arguments\nName\nType\nDescription\nRequired\nfilter\nString\nSee Filter API.\nFalse\nfilter_id\nString\n            Identifier for a preexisting filter. See \n            the Filter API for details.\n        \nFalse\nmax_num\nInteger", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboardsmodule_GET/index.html"}
{"id": "f1256362353b-1", "text": "the Filter API for details.\n        \nFalse\nmax_num\nInteger\nMax number of records that can be returned. Default is 20.\nFalse\noffset\nInteger\nThe number of records to skip over before records are returned. Default is 0.\nFalse\nfields\nString\n            Comma delimited list of fields to return. Each field may be represented either by string, or by map\n            containing field name and additional field parameters (applicable to link and collection fields).\n            The fields id and date_modified will always be returned.\n            For more details on additional field parameters, see\n            Relate API and\n            Collection API.\n        \nFalse\norder_by\nString\nSee Filter API.\nFalse\ndeleted\nBoolean\nBoolean to show deleted records in the result set.\nFalse\nResponse Arguments\nName\nType\nDescription\nnext_offset\nInteger\n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \nrecords\nArray\nAn array of results containing matched records.\nResponse\n{\n  \"next_offset\": -1,\n  \"records\": [\n    {\n      \"id\": \"d509b3da-29f6-7b23-7cce-56fab1a6335b\",\n      \"name\": \"Accounts Dashboard\",\n      \"date_modified\": \"2016-03-29T09:46:00-07:00\",\n      \"view_name\": \"records\",\n      \"_acl\": {\n        \"fields\": {}\n      },\n      \"view\": \"records\",\n      \"_module\": \"Dashboards\"\n    },\n    {\n      \"id\": \"cc4982cd-0bdf-bad4-d079-56fab4bdddf1\",\n      \"name\": \"Contacts Dashboard\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboardsmodule_GET/index.html"}
{"id": "f1256362353b-2", "text": "\"name\": \"Contacts Dashboard\",\n      \"date_modified\": \"2016-03-29T09:57:58-07:00\",\n      \"view_name\": \"records\",\n      \"_acl\": {\n        \"fields\": {}\n      },\n      \"view\": \"records\",\n      \"_module\": \"Dashboards\"\n    }\n  ]\n}\nChange Log\nVersion\nChange\nv11\nNo longer supported. Please use GET /Dashboards instead.\nv10\nAdded /Dashboards/<module> GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboardsmodule_GET/index.html"}
{"id": "8593ae8c41b0-0", "text": "/Calls/:record PUT\nOverview\n    Update a calendar event record of the specified type.\nRequest Arguments\nName\nType\nDescription\nRequired\n            all_recurrences\n        \n            Boolean\n        \n            Flag to update all events in a series.\n        \n            False\n        \nRequest\nhttp://{site_url}/rest/v10/Meetings/2c9e5c09-6824-0d14-f5cb-5130321ac3cf?all_recurrences=true\n{\n    \"name\":\"Department Meeting\",\n    \"description\":\"Weekly Department Meeting\",\n    \"date_start\":\"yyyy-mm-ddThh:mm:ss-00:00\",\n    \"date_end\":\"yyyy-mm-ddThh:mm:ss-00:00\",\n    \"repeat_type\":\"Weekly\",\n    \"repeat_interval\":\"1\",  /* Every Week */\n    \"repeat_dow\":\"25\",      /* Tue and Fri */\n    \"repeat_count\":\"4\",     /* 4 Recurrences */\n    \"repeat_until\":\"\",\n}\nResponse Arguments\nName\nDescription\nStart Date\nEnd Date\n            <record field>\n        \n            Returns the fields for the updated record.\n        \nResponse\n{\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Callsrecord_PUT/index.html"}
{"id": "2c7adb64440a-0", "text": "/RevenueLineItems/multi-quote POST\nConvert Multiple Revenue Line Item to a quote.\nSummary:\n     This endpoint is used to convert multiple Revenue Line Items to a single quote\nQuery Parameters:\nParam\nDescription\nOptional\nValid Urls:\nPOST: /rest/v10/RevenueLineItems/multi-quote\nInput Example:\n        {\n            records : [\n                'id_1',\n                'id_2',\n            ]\n            opportunity_id:\"123-456-789-0\",\n            account_id:\"12-3-4-5\"\n        }\n    \nOutput Example:\n        {\n            id:\"123-456-789-0\",\n            name:\"My Test Quote\"\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/RevenueLineItemsmulti-quote_POST/index.html"}
{"id": "35b973280bbf-0", "text": "/integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value PUT\nOverview\nSets a sync key value for a record. Note that the PATCH method is recommended over the PUT method.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule\nString\nThe module the record belongs to\nTrue\nrecord_id\nString\nThe ID of the record whose sync key will be set\nTrue\nsync_key_field_name\nString\nThe name of the field that contains sync_key_field_value (the default field is named\u00c2\u00a0sync_key but can be renamed via code customization)\nTrue\nsync_key_field_value\nString\nA unique ID for the record identifying it in an external system\nTrue\nRequest\n/integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value\nResponse\n{\"success\": true}\nChange Log\nVersion\nChange\nv11_10\nAdded /integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value\u00c2\u00a0PUT endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulerecord_idsync_key_field_namesync_key_field_value_PUT/index.html"}
{"id": "eb0e5b4e04e2-0", "text": "/CommentLog/:record GET\nOverview\n    Retrieves a record.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            <record field>\n        \n            <record field type>\n        \n            Returns the fields for the selected record.\n        \nResponse\n{\n   \"id\":\"bdd59d85-687b-1739-b00a-512d09f6db9e\",\n   \"name\":\"Insight Marketing Inc\",\n   \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n   \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n   \"modified_user_id\":\"1\",\n   \"modified_by_name\":\"Administrator\",\n   \"created_by\":\"1\",\n   \"created_by_name\":\"Administrator\",\n   \"description\":\"\",\n   \"img\":\"\",\n   \"last_activity_date\":\"2013-02-26T19:12:00+00:00\",\n   \"deleted\":false,\n   \"assigned_user_id\":\"seed_max_id\",\n   \"assigned_user_name\":\"Max Jensen\",\n   \"team_name\":[\n      {\n         \"id\":\"East\",\n         \"name\":\"East\",\n         \"name_2\":\"\",\n         \"primary\":false\n      },\n      {\n         \"id\":1,\n         \"name\":\"Global\",\n         \"name_2\":\"\",\n         \"primary\":false\n      },\n      {\n         \"id\":\"West\",\n         \"name\":\"West\",\n         \"name_2\":\"\",\n         \"primary\":true\n      }\n   ],\n   \"linkedin\":\"\",\n   \"facebook\":\"\",\n   \"twitter\":\"\",\n   \"googleplus\":\"\",\n   \"account_type\":\"Customer\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/CommentLogrecord_GET/index.html"}
{"id": "eb0e5b4e04e2-1", "text": "\"googleplus\":\"\",\n   \"account_type\":\"Customer\",\n   \"industry\":\"Electronics\",\n   \"annual_revenue\":\"\",\n   \"phone_fax\":\"\",\n   \"billing_address_street\":\"345 Sugar Blvd.\",\n   \"billing_address_street_2\":\"\",\n   \"billing_address_street_3\":\"\",\n   \"billing_address_street_4\":\"\",\n   \"billing_address_city\":\"San Mateo\",\n   \"billing_address_state\":\"CA\",\n   \"billing_address_postalcode\":\"56019\",\n   \"billing_address_country\":\"USA\",\n   \"rating\":\"\",\n   \"phone_office\":\"(927) 136-9572\",\n   \"phone_alternate\":\"\",\n   \"website\":\"www.sectionvegan.de\",\n   \"ownership\":\"\",\n   \"employees\":\"\",\n   \"ticker_symbol\":\"\",\n   \"shipping_address_street\":\"345 Sugar Blvd.\",\n   \"shipping_address_street_2\":\"\",\n   \"shipping_address_street_3\":\"\",\n   \"shipping_address_street_4\":\"\",\n   \"shipping_address_city\":\"San Mateo\",\n   \"shipping_address_state\":\"CA\",\n   \"shipping_address_postalcode\":\"56019\",\n   \"shipping_address_country\":\"USA\",\n   \"email1\":\"kid.support.vegan@example.info\",\n   \"parent_id\":\"\",\n   \"sic_code\":\"\",\n   \"parent_name\":\"\",\n   \"email_opt_out\":false,\n   \"invalid_email\":false,\n   \"email\":[\n      {\n         \"email_address\":\"kid.support.vegan@example.info\",\n         \"opt_out\":\"0\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"1\"\n      },\n      {\n         \"email_address\":\"phone.kid@example.cn\",\n         \"opt_out\":\"0\",\n         \"invalid_email\":\"0\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/CommentLogrecord_GET/index.html"}
{"id": "eb0e5b4e04e2-2", "text": "\"opt_out\":\"0\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"0\"\n      }\n   ],\n   \"campaign_id\":\"\",\n   \"campaign_name\":\"\",\n   \"my_favorite\":false,\n   \"_acl\":{\n      \"fields\":{\n      }\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/CommentLogrecord_GET/index.html"}
{"id": "4a7315a673f7-0", "text": "/pmse_Inbox/AdhocReassign/:data/:flowId GET\nOverview\n    Deprecated endpoint.\nSummary\nThis endpoint is deprecated and will be removed in a future release.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxAdhocReassigndataflowId_GET/index.html"}
{"id": "ff6744f3d102-0", "text": "/oauth2/sudo/:user_name POST\nOverview\n    Get an access token as another user. The current user must be an admin in order to access this endpoint. This method is useful for integrations in order to be able to access the system with the same permission restrictions as a specified user. The calling user does not lose their existing token, this one is granted in addition.\nRequest Arguments\nName\nType\nDescription\nRequired\n                platform\n            \n                String\n            \n                Which platform on the session, defaults to \"base\"\n            \n                False\n            \n                client_id\n            \n                String\n            \n               The client id for the session, defaults to \"sugar\"\n            \n                False\n            \nRequest\n{\n   \"client_id\":\"sugar\",\n   \"platform\":\"base\"\n}\nResponse Arguments\nName\nType\nDescription\n                access_token\n            \n                String\n            \n                The access token needed to authenticate for other methods.\n            \n                expires_in\n            \n                Integer\n            \n                The length of time until the access_token expires.\n            \n                token_type\n            \n                String\n            \n                Should always be bearer.\n            \n                scope\n            \n                String\n            \n                There is no scope implementation in the current release of Sugar.\n            \nResponse\n{\n   \"access_token\":\"c19fff9b-b767-233e-ebb4-512e369d3e39\",\n   \"expires_in\":3600,\n   \"token_type\":\"bearer\",\n   \"scope\":null\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /oauth2/token/sudo/:user POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/oauth2sudouser_name_POST/index.html"}
{"id": "46c6e9b73774-0", "text": "/Administration/license/limits GET\nOverview\n[ADMIN] Get License Limits.\nSummary\nThis endpoint gets the license limits, the number of unused licensed seats for each license type. This endpoint is only available to administrators.\nRequest Arguments\nThis endpoint does not accept any arguments.\nResponse\n{\n  \"default_limit\": 100,\n  \"limit_enforced\": 1,\n  \"default_license_type\" : \"CURRENT\",\n  \"seats\": {\n    \"CURRENT\": 100,\n    \"SUGAR_SERVE\": 10\n  },\n  \"available_seats\": {\n    \"CURRENT\": 25,\n    \"SUGAR_SERVE\": 1,\n    \"SUGAR_SELL\": 0\n  }\n}\nChange Log\nVersion\nChange\nv11_2\nAdded /Administration/license/limits GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationlicenselimits_GET/index.html"}
{"id": "2b4e317cd747-0", "text": "/<module>/duplicateCheck POST\nOverview\n    Runs a duplicate check against specified data.\nRequest Arguments\nName\nType\nDescription\nRequired\n            <record field>\n        \n            <record field type>\n        \n            The name value list of fields to populate.\n        \n            True\n        \nRequest\n{\n    \"name\":\"Airline\"\n}\nResponse Arguments\nName\nType\nDescription\n            <record field>\n        \n            <record field type>\n        \n            Returns the potential duplicate records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"c4c26496-5dbc-67dd-bf5c-512d0923889e\",\n         \"name\":\"Airline Maintenance Co\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"last_activity_date\":\"2013-02-26T19:12:00+00:00\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleduplicateCheck_POST/index.html"}
{"id": "2b4e317cd747-1", "text": "\"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"account_type\":\"Customer\",\n         \"industry\":\"Other\",\n         \"annual_revenue\":\"\",\n         \"phone_fax\":\"\",\n         \"billing_address_street\":\"123 Anywhere Street\",\n         \"billing_address_street_2\":\"\",\n         \"billing_address_street_3\":\"\",\n         \"billing_address_street_4\":\"\",\n         \"billing_address_city\":\"Sunnyvale\",\n         \"billing_address_state\":\"CA\",\n         \"billing_address_postalcode\":\"48566\",\n         \"billing_address_country\":\"USA\",\n         \"rating\":\"\",\n         \"phone_office\":\"(648) 452-3486\",\n         \"phone_alternate\":\"\",\n         \"website\":\"www.kidqa.it\",\n         \"ownership\":\"\",\n         \"employees\":\"\",\n         \"ticker_symbol\":\"\",\n         \"shipping_address_street\":\"123 Anywhere Street\",\n         \"shipping_address_street_2\":\"\",\n         \"shipping_address_street_3\":\"\",\n         \"shipping_address_street_4\":\"\",\n         \"shipping_address_city\":\"Sunnyvale\",\n         \"shipping_address_state\":\"CA\",\n         \"shipping_address_postalcode\":\"48566\",\n         \"shipping_address_country\":\"USA\",\n         \"email1\":\"vegan.im@example.tw\",\n         \"parent_id\":\"\",\n         \"sic_code\":\"\",\n         \"parent_name\":\"\",\n         \"email_opt_out\":false,\n         \"invalid_email\":false,\n         \"email\":[\n            {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleduplicateCheck_POST/index.html"}
{"id": "2b4e317cd747-2", "text": "\"invalid_email\":false,\n         \"email\":[\n            {\n               \"email_address\":\"vegan.im@example.tw\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            },\n            {\n               \"email_address\":\"phone85@example.tv\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            }\n         ],\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"duplicate_check_rank\":0\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/duplicateCheck POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleduplicateCheck_POST/index.html"}
{"id": "34e5b48be8dc-0", "text": "/integrate/<module>/:sync_key_field_name/:sync_key_field_value PATCH\nOverview\nUpserts based on sync_key_field_name. If a record can be found with sync_key_field_name, then update. If the record does not exist, then create it.\nNote:\u00c2\u00a0This endpoint cannot be used to set the sync_key_field_name for an existing Sugar record. To do so, it is recommended to use the set sync key endpoint to update the matching Sugar record ID. Once the sync_key is set for the record, then it is possible to leverage this endpoint.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule\nString\nThe module the record belongs to\nTrue\nsync_key_field_name\nString\nThe name of the field that contains sync_key_field_value (the default field is named\u00c2\u00a0sync_key but can be renamed via code customization)\nTrue\nsync_key_field_value\nString\nA unique ID for the record identifying it in an external system\nTrue\nRequest\n/integrate/<module>/:sync_key_field_name/:sync_key_field_value\nResponse Arguments\nName\nType\nDescription\nrecord\nString\nThe ID of the record that was upserted.\nResponse\nStatus 201: For a created record\nStatus 200: For an updated record\n{    record: \"a0328573-a252-a27c-3530-4e4297d4c9e1\"} \nChange Log\nVersion\nChange\nv11_10\nAdded /integrate/<module>/:sync_key_field_name/:sync_key_field_value\u00c2\u00a0PATCH endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulesync_key_field_namesync_key_field_value_PATCH/index.html"}
{"id": "c18259ae4aab-0", "text": "/pmse_Inbox/AdhocReassign PUT\nOverview\n    Deprecated endpoint.\nSummary\nThis endpoint is deprecated and will be removed in a future release.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxAdhocReassign_PUT/index.html"}
{"id": "b4a95edf69ac-0", "text": "/Currencies GET\nReturns a collection of Currency models\nSummary:\nThis end point is used to return the Currencies defined in the application\nUrl Parameters:\nParam\nDescription\nOptional\nPossible Errors\nError\nDescription\nUrl Example:\n        /rest/v10/Currencies\n    \nOutput Example:\n        {\n        \"next_offset\": -1,\n        \"records\": [\n        {\n        \"id\": \"-99\",\n        \"name\": \"US Dollars\",\n        \"symbol\": \"$\",\n        \"iso4217\": \"USD\",\n        \"conversion_rate\": 1,\n        \"status\": \"Active\",\n        \"_acl\": {\n        \"fields\": {}\n        },\n        \"_module\": \"Currencies\"\n        },\n        {\n        \"id\": \"a3cba348-756c-935c-66ad-55d772c7960f\",\n        \"name\": \"Euro\",\n        \"symbol\": \"\u00e2\u0082\u00ac\",\n        \"iso4217\": \"EUR\",\n        \"conversion_rate\": 0.9,\n        \"status\": \"Active\",\n        \"date_modified\": \"2015-08-21T11:47:51-07:00\",\n        \"created_by\": \"1\",\n        \"_acl\": {\n        \"fields\": {}\n        },\n        \"_module\": \"Currencies\"\n        }\n        ]\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Currencies_GET/index.html"}
{"id": "918b55d35378-0", "text": "/<module>/:record/next GET\nOverview\n    Retrieves next sibling of selected record.\nRequest Arguments\nName\nType\nDescription\nRequired\n                module\n            \n                String\n            \n                The name of sugar module that contains a nested set data and implements the NestedSetInterface.\n            \n                True\n            \n                :record\n            \n                String\n            \n                The ID of record\n            \n                True\n            \nResponse Arguments\n    This endpoint does not return any response arguments.\nResponse\n{\n    id: \"e1ae8646-ac90-104a-59d6-5412cf5009b2\"\n    name: \"SugarCategoryExample\"\n    date_entered: \"2014-09-12 10:47:46\"\n    date_modified: \"2014-09-12 10:47:46\"\n    modified_user_id: \"9c9ad14e-1789-3340-f88d-5412cf551d3b\"\n    created_by: \"9c9ad14e-1789-3340-f88d-5412cf551d3b\"\n    description: null\n    deleted: \"0\"\n    source_id: null\n    source_type: null\n    source_meta: null\n    root: \"e1ae8646-ac90-104a-59d6-5412cf5009b2\"\n    lft: \"6\"\n    rgt: \"11\"\n    level: \"1\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/next GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordnext_GET/index.html"}
{"id": "9d415d5161ff-0", "text": "/<module>/:record/link/:link_name/:remote_id GET\nOverview\n    Retrieves a related record with relationship role information.\nRequest Arguments\n    This endpoint does not accept any arguments.\nResponse Arguments\nName\nType\nDescription\n            <record field>\n        \n            <record field type>\n        \n            Returns the fields for the newly created record.\n        \nResponse\n{\n   \"id\":\"e689173e-c953-1e14-c215-512d0927e7a2\",\n   \"name\":\"Gus Dales\",\n   \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n   \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n   \"modified_user_id\":\"1\",\n   \"modified_by_name\":\"Administrator\",\n   \"created_by\":\"1\",\n   \"created_by_name\":\"Administrator\",\n   \"description\":\"\",\n   \"img\":\"\",\n   \"deleted\":false,\n   \"assigned_user_id\":\"seed_sally_id\",\n   \"assigned_user_name\":\"Sally Bronsen\",\n   \"team_name\":[\n      {\n         \"id\":\"West\",\n         \"name\":\"West\",\n         \"name_2\":\"\",\n         \"primary\":true\n      }\n   ],\n   \"salutation\":\"\",\n   \"first_name\":\"Gus\",\n   \"last_name\":\"Dales\",\n   \"full_name\":\"Gus Dales\",\n   \"title\":\"Director Operations\",\n   \"linkedin\":\"\",\n   \"facebook\":\"\",\n   \"twitter\":\"\",\n   \"googleplus\":\"\",\n   \"department\":\"\",\n   \"do_not_call\":false,\n   \"phone_home\":\"(661) 120-2292\",\n   \"email\":[\n      {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_GET/index.html"}
{"id": "9d415d5161ff-1", "text": "\"email\":[\n      {\n         \"email_address\":\"section.sugar.section@example.it\",\n         \"opt_out\":\"1\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"0\"\n      },\n      {\n         \"email_address\":\"support.qa.kid@example.co.uk\",\n         \"opt_out\":\"0\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"1\"\n      }\n   ],\n   \"phone_mobile\":\"(294) 447-9707\",\n   \"phone_work\":\"(036) 840-3216\",\n   \"phone_other\":\"\",\n   \"phone_fax\":\"\",\n   \"email1\":\"support.qa.kid@example.co.uk\",\n   \"email2\":\"section.sugar.section@example.it\",\n   \"invalid_email\":false,\n   \"email_opt_out\":false,\n   \"primary_address_street\":\"48920 San Carlos Ave\",\n   \"primary_address_street_2\":\"\",\n   \"primary_address_street_3\":\"\",\n   \"primary_address_city\":\"Persistance\",\n   \"primary_address_state\":\"CA\",\n   \"primary_address_postalcode\":\"54556\",\n   \"primary_address_country\":\"USA\",\n   \"alt_address_street\":\"\",\n   \"alt_address_street_2\":\"\",\n   \"alt_address_street_3\":\"\",\n   \"alt_address_city\":\"\",\n   \"alt_address_state\":\"\",\n   \"alt_address_postalcode\":\"\",\n   \"alt_address_country\":\"\",\n   \"assistant\":\"\",\n   \"assistant_phone\":\"\",\n   \"picture\":\"\",\n   \"email_and_name1\":\"\",\n   \"lead_source\":\"Support Portal User Registration\",\n   \"account_name\":\"Arts & Crafts Inc\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_GET/index.html"}
{"id": "9d415d5161ff-2", "text": "\"account_name\":\"Arts & Crafts Inc\",\n   \"account_id\":\"d43243c6-9b8e-2973-aee2-512d09bc34b4\",\n   \"opportunity_role_fields\":\"\",\n   \"opportunity_role_id\":\"\",\n   \"opportunity_role\":\"Technical Advisor\",\n   \"reports_to_id\":\"\",\n   \"report_to_name\":\"\",\n   \"portal_name\":\"GusDales145\",\n   \"portal_active\":true,\n   \"portal_password\":\"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0\",\n   \"portal_password1\":\"\",\n   \"portal_app\":\"\",\n   \"preferred_language\":\"en_us\",\n   \"campaign_id\":\"\",\n   \"campaign_name\":\"\",\n   \"c_accept_status_fields\":\"\",\n   \"m_accept_status_fields\":\"\",\n   \"accept_status_id\":\"\",\n   \"accept_status_name\":\"\",\n   \"sync_contact\":\"\",\n   \"my_favorite\":false,\n   \"_acl\":{\n      \"fields\":{\n      }\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/link/:link_name/:remote_id GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_GET/index.html"}
{"id": "8c1049221ad8-0", "text": "/Emails/filter/count POST\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n        \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. The field date_modified will always be returned.\n            \n            Example: name,account_type,description\n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_POST/index.html"}
{"id": "8c1049221ad8-1", "text": "constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example\n    you would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_POST/index.html"}
{"id": "8c1049221ad8-2", "text": "Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\nThere are two module expressions, they operate on modules instead of fields. The current module can be specified by\neither using the module name \"_this\" or by leaving the module name as a blank string. The example expression would", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_POST/index.html"}
{"id": "8c1049221ad8-3", "text": "filter the records in the current module to only your favorites. The only currently accepted module expressions are\n\"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_POST/index.html"}
{"id": "8c1049221ad8-4", "text": "\"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",\n         \"full_name\":\"Dale Spivey\",\n         \"title\":\"VP Operations\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(523) 825-4311\",\n         \"email\":[\n            {\n               \"email_address\":\"sugar.dev.sugar@example.co.jp\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            },\n            {\n               \"email_address\":\"the.support@example.biz\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            }\n         ],\n         \"phone_mobile\":\"(373) 861-0757\",\n         \"phone_work\":\"(212) 542-9596\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"sugar.dev.sugar@example.co.jp\",\n         \"email2\":\"the.support@example.biz\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"345 Sugar Blvd.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"87261\",\n         \"primary_address_country\":\"USA\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_POST/index.html"}
{"id": "8c1049221ad8-5", "text": "\"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Campaign\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"DaleSpivey97\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\\/\",\n         \"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_POST/index.html"}
{"id": "8c1049221ad8-6", "text": "\"name\":\"Florence Haddock\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Florence\",\n         \"last_name\":\"Haddock\",\n         \"full_name\":\"Florence Haddock\",\n         \"title\":\"Director Sales\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(729) 845-3137\",\n         \"email\":[\n            {\n               \"email_address\":\"dev.vegan@example.de\",\n               \"opt_out\":\"1\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            },\n            {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_POST/index.html"}
{"id": "8c1049221ad8-7", "text": "\"primary_address\":\"0\"\n            },\n            {\n               \"email_address\":\"section71@example.it\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            }\n         ],\n         \"phone_mobile\":\"(246) 233-1382\",\n         \"phone_work\":\"(565) 696-6981\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"section71@example.it\",\n         \"email2\":\"dev.vegan@example.de\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"111 Silicon Valley Road\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"79900\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Support Portal User Registration\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_POST/index.html"}
{"id": "8c1049221ad8-8", "text": "\"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"FlorenceHaddock169\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$nWFhTbK6$JF9BCGSqL\\/NCrbhueX5ia0\",\n         \"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_POST/index.html"}
{"id": "8533c99067da-0", "text": "/ConsoleConfiguration/default-metadata GET\nOverview\nGets the request metadata in JSON format.\nRequest Arguments\nThis endpoint does not accept any request arguments.\nURL Parameters\nParameter\nDescription\nRequired?\nmodules\nString. Comma-separated module names. Example: 'Accounts,Opportunities'.\nYes\ntype\nString. The type of the desired metadata. The following types are supported: 'filter', 'layout', 'menu', 'view'.\nYes\nname\nString. The name of the metadata. Examples: 'list', 'record', or 'multi-line-list'.\nYes\nURL Example\n/rest/v11_9/ConsoleConfiguration/default-metadata?modules=Cases&type=view&name=multi-line-list\nResult Arguments\nResponse\n{\n   \"Cases\":{\n  \t\"panels\":[\n     \t{\n        \t\"label\":\"LBL_PANEL_1\",\n        \t\"fields\":[\n           \t{\n              \t\"name\":\"case_number\",\n              \t\"label\":\"LBL_AGENT_WORKBENCH_NUMBER\",\n              \t\"width\":\"xsmall\",\n              \t\"subfields\":[\n                 \t{\n                    \t\"name\":\"case_number\",\n                    \t\"label\":\"LBL_AGENT_WORKBENCH_NUMBER\",\n                    \t\"default\":true,\n                    \t\"enabled\":true,\n                    \t\"readonly\":true\n                 \t}\n              \t]\n           \t},\n           \t{\n              \t\"name\":\"status\",\n              \t\"label\":\"LBL_AGENT_WORKBENCH_PRIORITY_STATUS\",\n              \t\"width\":\"small\",\n              \t\"subfields\":[\n                 \t{\n                    \t\"name\":\"priority\",\n                    \t\"label\":\"LBL_LIST_PRIORITY\",\n                    \t\"default\":true,\n                    \t\"enabled\":true,\n                    \t\"type\":\"enum\"\n                 \t},\n                 \t{\n                    \t\"name\":\"status\",\n                    \t\"label\":\"LBL_STATUS\",\n                    \t\"default\":true,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationdefault-metadata_GET/index.html"}
{"id": "8533c99067da-1", "text": "\"label\":\"LBL_STATUS\",\n                    \t\"default\":true,\n                    \t\"enabled\":true,\n                    \t\"type\":\"case-status\",\n                    \t\"widget_name\":\"widget_status\"\n                 \t}\n              \t]\n           \t},\n           \t{\n              \t\"name\":\"follow_up_datetime\",\n              \t\"label\":\"LBL_AGENT_WORKBENCH_FOLLOW_UP\",\n              \t\"width\":\"medium\",\n              \t\"subfields\":[\n                 \t{\n                    \t\"name\":\"follow_up_datetime\",\n                    \t\"label\":\"LBL_FOLLOW_UP_DATETIME\",\n                    \t\"default\":true,\n                    \t\"enabled\":true,\n                    \t\"readonly\":true,\n                    \t\"type\":\"follow-up-datetime-colorcoded\",\n                    \t\"widget_name\":\"widget_follow_up_datetime\",\n                    \t\"color_code_classes\":{\n                       \t\"overdue\":\"expired\",\n                       \t\"in_a_day\":\"soon-expired\",\n                       \t\"more_than_a_day\":\"white black-text\"\n                    \t}\n                 \t},\n                 \t{\n                    \t\"name\":\"follow_up_datetime\",\n                    \t\"label\":\"LBL_FOLLOW_UP_DATETIME\",\n                    \t\"default\":true,\n                    \t\"enabled\":true,\n                    \t\"readonly\":true,\n                    \t\"type\":\"datetimecombo\"\n                 \t}\n              \t]\n           \t},\n           \t{\n              \t\"name\":\"name\",\n              \t\"label\":\"LBL_AGENT_WORKBENCH_SUBJECT_DESCRIPTION\",\n              \t\"width\":\"xlarge\",\n              \t\"subfields\":[\n                 \t{\n                    \t\"name\":\"name\",\n                    \t\"label\":\"LBL_LIST_SUBJECT\",\n                    \t\"link\":false,\n                    \t\"default\":true,\n                    \t\"enabled\":true,\n                    \t\"readonly\":true\n                 \t},\n                 \t{\n                    \t\"name\":\"description\",\n                    \t\"default\":true,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationdefault-metadata_GET/index.html"}
{"id": "8533c99067da-2", "text": "{\n                    \t\"name\":\"description\",\n                    \t\"default\":true,\n                    \t\"enabled\":true,\n                    \t\"readonly\":true,\n                    \t\"sortable\":false\n                 \t}\n              \t]\n           \t},\n           \t{\n              \t\"name\":\"business_center\",\n              \t\"label\":\"LBL_BUSINESS_CENTER\",\n              \t\"width\":\"small\",\n              \t\"subfields\":[\n                 \t{\n                    \t\"name\":\"business_center_name\",\n                    \t\"label\":\"LBL_BUSINESS_CENTER\",\n                    \t\"link\":false,\n                    \t\"default\":true,\n                    \t\"enabled\":true,\n                    \t\"readonly\":true\n                 \t}\n              \t]\n           \t},\n           \t{\n              \t\"name\":\"account_name\",\n              \t\"label\":\"LBL_ACCOUNT\",\n              \t\"width\":\"medium\",\n              \t\"subfields\":[\n                 \t{\n                    \t\"name\":\"account_name\",\n                    \t\"label\":\"LBL_LIST_ACCOUNT_NAME\",\n                    \t\"module\":\"Accounts\",\n                    \t\"id\":\"ACCOUNT_ID\",\n                    \t\"ACLTag\":\"ACCOUNT\",\n                    \t\"related_fields\":[\n                       \t\"account_id\"\n                    \t],\n                    \t\"link\":false,\n                    \t\"default\":true,\n                    \t\"enabled\":true\n                 \t},\n                 \t{\n                    \t\"name\":\"service_level\",\n                    \t\"label\":\"LBL_SERVICE_LEVEL\",\n                    \t\"type\":\"enum\",\n                    \t\"enum_module\":\"Accounts\",\n                    \t\"link\":false,\n                    \t\"default\":true,\n                    \t\"enabled\":true,\n                    \t\"readonly\":true\n                 \t}\n              \t]\n           \t},\n           \t{\n              \t\"name\":\"assigned_user_name\",\n              \t\"label\":\"LBL_ASSIGNED_TO_NAME\",\n              \t\"width\":\"small\",\n              \t\"subfields\":[", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationdefault-metadata_GET/index.html"}
{"id": "8533c99067da-3", "text": "\"width\":\"small\",\n              \t\"subfields\":[\n                 \t{\n                    \t\"name\":\"assigned_user_name\",\n                    \t\"label\":\"LBL_ASSIGNED_TO_NAME\",\n                    \t\"id\":\"ASSIGNED_USER_ID\",\n                    \t\"link\":false,\n                    \t\"default\":true,\n                    \t\"enabled\":true\n                 \t}\n              \t]\n           \t}\n        \t]\n     \t}\n  \t],\n  \t\"collectionOptions\":{\n     \t\"limit\":100,\n     \t\"params\":{\n        \t\"max_num\":100,\n        \t\"order_by\":\"follow_up_datetime\",\n        \t\"nulls_last\":true\n     \t}\n  \t},\n  \t\"filterDef\":[\n     \t{\n        \t\"status\":{\n           \t\"$not_in\":[\n              \t\"Closed\",\n              \t\"Rejected\",\n              \t\"Duplicate\"\n           \t]\n        \t},\n        \t\"$owner\":\"\"\n     \t}\n  \t]\n   }\n}\nResponse Codes and Error Messages\nAll successful responses return 200.\nThe following error responses are possible:\n403 (SugarAPIExceptionNotAuthorized)\u00c2\u00a0: Sent if the user attempts to access a module that they are forbidden to access.\n422 (SugarApiExceptionInvalidParameter)\u00c2\u00a0: Sent if the user specifies an invalid type or module.\nChange Log\nVersion\nChange\nv11.9\nAdded /ConsoleConfiguration/default-metadata GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationdefault-metadata_GET/index.html"}
{"id": "77d7d7fbe5b8-0", "text": "/<module>/export/:record_list_id GET\nOverview\n    Returns a record set in CSV format along with HTTP headers to indicate content type.\nRequest Arguments\nName\nType\nDescription\nRequired\n            uid\n        \n            Array\n        \n            A list of bean ids.\n        \n            False\n        \n            filter\n        \n            Array\n        \n            The filter expression. More information on filter expressions can be found in /<module>/filter.\n        \n            False\n        \n            sample\n        \n            Array\n        \n            Indicates whether to download sample data.\n        \n            False\n        \nRequest\nExporting Records by Specific IDs\n{\n   \"uid\":\"d43243c6-9b8e-2973-aee2-512d09bc34b4\"\n}\nExporting Records by a List of IDs\n{\n   \"uid\":[\n      \"d43243c6-9b8e-2973-aee2-512d09bc34b4\",\n      \"b3e87a3f-cd8f-7b86-467a-512d09e8d240\"\n   ]\n}\nExporting Records Using a Filter\n{\n   \"filter\":[\n      {\n         \"name\":\"airline\"\n      }\n   ]\n}\nExporting a Sample Result Set\n{\n    \"sample\":true\n}\nResponse Arguments\nName\nType\nDescription\n            <csv export>\n        \n            String\n        \n            Returns the selected records in CSV format with the content headers.\n        \nResponse\nresult: HTTP/1.1 200 OK\nDate: Fri, 01 Mar 2013 04:05:55 GMT\nServer: Apache/2.2.22 (Unix) DAV/2 PHP/5.3.17", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleexportrecord_list_id_GET/index.html"}
{"id": "77d7d7fbe5b8-1", "text": "X-Powered-By: PHP/5.3.17\nExpires: Mon, 26 Jul 1997 05:00:00 GMT\nCache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0\nPragma: cache\nContent-Disposition: attachment; filename=Accounts.csv\nContent-transfer-encoding: binary\nLast-Modified: Fri, 01 Mar 2013 04:05:55 GMT\nCache-Control: post-check=0, pre-check=0\nContent-Length: 1080\nConnection: close\nContent-Type: application/octet-stream; charset=UTF-8\n\"Name\",\"ID\",\"Website\",\"Email Address\",\"Office Phone\",\"Alternate Phone\",\"Fax\",\"Billing Street\",\"Billing City\",\"Billing State\",\"Billing Postal Code\",\"Billing Country\",\"Shipping Street\",\"Shipping City\",\"Shipping State\",\"Shipping Postal Code\",\"Shipping Country\",\"Description\",\"Type\",\"Industry\",\"Annual Revenue\",\"Employees\",\"SIC Code\",\"Ticker Symbol\",\"Parent Account ID\",\"Ownership\",\"Campaign ID\",\"Rating\",\"Assigned User Name\",\"Assigned To\",\"Team ID\",\"Teams\",\"Team Set ID\",\"Date Created\",\"Date Modified\",\"Modified By\",\"Created By\",\"Deleted\",\"Image\",\"last_activity_date\",\"Linkedin Company ID\",\"Facebook Account\",\"Twitter Account\",\"Google Plus ID\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleexportrecord_list_id_GET/index.html"}
{"id": "77d7d7fbe5b8-2", "text": "\"Arts & Crafts Inc\",\"d43243c6-9b8e-2973-aee2-512d09bc34b4\",\"\",\"\",\"(052) 034-1853\",\"\",\"\",\"777 West Filmore Ln\",\"Santa Monica\",\"CA\",\"35354\",\"USA\",\"777 West Filmore Ln\",\"Santa Monica\",\"CA\",\"35354\",\"USA\",\"\",\"Customer\",\"Transportation\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"sally\",\"seed_sally_id\",\"West\",\"West\",\"West\",\"02/26/2013 07:12 pm\",\"02/26/2013 07:12 pm\",\"1\",\"1\",\"0\",\"\",\"02/26/2013 07:12 pm\",\"\",\"\",\"\",\"\"\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/export GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleexportrecord_list_id_GET/index.html"}
{"id": "8e144bbb09f0-0", "text": "/<module>/:record/parent GET\nOverview\n    Retrieves parent node for selected record.\nRequest Arguments\nName\nType\nDescription\nRequired\n                module\n            \n                String\n            \n                The name of sugar module that contains a nested set data and implements the NestedSetInterface.\n            \n                True\n            \n                :record\n            \n                String\n            \n                The ID of record\n            \n                True\n            \nResponse Arguments\n    This endpoint does not return any response arguments.\nResponse\n{\n    id: \"e1ae8646-ac90-104a-59d6-5412cf5009b2\"\n    name: \"SugarCategoryExample\"\n    date_entered: \"2014-09-12 10:47:46\"\n    date_modified: \"2014-09-12 10:47:46\"\n    modified_user_id: \"9c9ad14e-1789-3340-f88d-5412cf551d3b\"\n    created_by: \"9c9ad14e-1789-3340-f88d-5412cf551d3b\"\n    description: null\n    deleted: \"0\"\n    source_id: null\n    source_type: null\n    source_meta: null\n    root: \"e1ae8646-ac90-104a-59d6-5412cf5009b2\"\n    lft: \"6\"\n    rgt: \"11\"\n    level: \"1\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/parent GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordparent_GET/index.html"}
{"id": "a602fab375aa-0", "text": "/<module>/:record/link/:link_name POST\nOverview\n    Creates a related record.\nRequest Arguments\nName\nType\nDescription\nRequired\n            <record field>\n        \n            <record field type>\n        \n            The name value list of fields to populate.\n        \n            True\n        \nRequest\n{\n    \"first_name\":\"Bill\",\n    \"last_name\":\"Edwards\"\n}\nResponse Arguments\nName\nType\nDescription\n            record\n        \n            Array\n        \n            The record associated to the newly created record.\n        \n            related_record\n        \n            Array\n        \n            The record that was created and associated.\n        \nResponse\n{\n   \"record\":{\n      \"id\":\"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n      \"name\":\"Slender Broadband Inc - 1000 units\",\n      \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n      \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n      \"modified_user_id\":\"1\",\n      \"modified_by_name\":\"Administrator\",\n      \"created_by\":\"1\",\n      \"created_by_name\":\"Administrator\",\n      \"description\":\"\",\n      \"img\":\"\",\n      \"deleted\":false,\n      \"assigned_user_id\":\"seed_max_id\",\n      \"assigned_user_name\":\"Max Jensen\",\n      \"team_name\":[\n         {\n            \"id\":\"East\",\n            \"name\":\"East\",\n            \"name_2\":\"\",\n            \"primary\":false\n         },\n         {\n            \"id\":\"West\",\n            \"name\":\"West\",\n            \"name_2\":\"\",\n            \"primary\":true\n         }\n      ],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_POST/index.html"}
{"id": "a602fab375aa-1", "text": "\"name_2\":\"\",\n            \"primary\":true\n         }\n      ],\n      \"opportunity_type\":\"\",\n      \"account_name\":\"Slender Broadband Inc\",\n      \"account_id\":\"181461c6-dc81-1115-1fe0-512d092e8f15\",\n      \"campaign_id\":\"\",\n      \"campaign_name\":\"\",\n      \"lead_source\":\"Campaign\",\n      \"amount\":\"25000\",\n      \"base_rate\":\"1\",\n      \"amount_usdollar\":\"25000\",\n      \"currency_id\":\"-99\",\n      \"currency_name\":\"\",\n      \"currency_symbol\":\"\",\n      \"date_closed\":\"2013-02-27\",\n      \"date_closed_timestamp\":\"1361992480\",\n      \"next_step\":\"\",\n      \"sales_stage\":\"Needs Analysis\",\n      \"sales_status\":\"New\",\n      \"probability\":\"90\",\n      \"best_case\":\"25000\",\n      \"worst_case\":\"25000\",\n      \"commit_stage\":\"include\",\n      \"my_favorite\":false,\n      \"_acl\":{\n         \"fields\":{\n         }\n      }\n   },\n   \"related_record\":{\n      \"id\":\"e1c495cb-af17-1b37-dd66-512f934fe155\",\n      \"name\":\"Bill Edwards\",\n      \"date_entered\":\"2013-02-28T17:25:00+00:00\",\n      \"date_modified\":\"2013-02-28T17:25:00+00:00\",\n      \"modified_user_id\":\"1\",\n      \"modified_by_name\":\"Administrator\",\n      \"created_by\":\"1\",\n      \"created_by_name\":\"Administrator\",\n      \"description\":\"\",\n      \"img\":\"\",\n      \"deleted\":false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_POST/index.html"}
{"id": "a602fab375aa-2", "text": "\"description\":\"\",\n      \"img\":\"\",\n      \"deleted\":false,\n      \"assigned_user_id\":\"\",\n      \"assigned_user_name\":\"\",\n      \"team_name\":[\n         {\n            \"id\":1,\n            \"name\":\"Global\",\n            \"name_2\":\"\",\n            \"primary\":true\n         }\n      ],\n      \"salutation\":\"\",\n      \"first_name\":\"Bill\",\n      \"last_name\":\"Edwards\",\n      \"full_name\":\"Bill Edwards\",\n      \"title\":\"\",\n      \"linkedin\":\"\",\n      \"facebook\":\"\",\n      \"twitter\":\"\",\n      \"googleplus\":\"\",\n      \"department\":\"\",\n      \"do_not_call\":false,\n      \"phone_home\":\"\",\n      \"email\":[\n      ],\n      \"phone_mobile\":\"\",\n      \"phone_work\":\"\",\n      \"phone_other\":\"\",\n      \"phone_fax\":\"\",\n      \"email1\":\"\",\n      \"email2\":\"\",\n      \"invalid_email\":\"\",\n      \"email_opt_out\":\"\",\n      \"primary_address_street\":\"\",\n      \"primary_address_street_2\":\"\",\n      \"primary_address_street_3\":\"\",\n      \"primary_address_city\":\"\",\n      \"primary_address_state\":\"\",\n      \"primary_address_postalcode\":\"\",\n      \"primary_address_country\":\"\",\n      \"alt_address_street\":\"\",\n      \"alt_address_street_2\":\"\",\n      \"alt_address_street_3\":\"\",\n      \"alt_address_city\":\"\",\n      \"alt_address_state\":\"\",\n      \"alt_address_postalcode\":\"\",\n      \"alt_address_country\":\"\",\n      \"assistant\":\"\",\n      \"assistant_phone\":\"\",\n      \"picture\":\"\",\n      \"email_and_name1\":\"\",\n      \"lead_source\":\"\",\n      \"account_id\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_POST/index.html"}
{"id": "a602fab375aa-3", "text": "\"lead_source\":\"\",\n      \"account_id\":\"\",\n      \"opportunity_role_fields\":\"\",\n      \"opportunity_role_id\":\"\",\n      \"opportunity_role\":\"\",\n      \"reports_to_id\":\"\",\n      \"report_to_name\":\"\",\n      \"portal_name\":\"\",\n      \"portal_active\":false,\n      \"portal_password\":\"\",\n      \"portal_password1\":\"\",\n      \"portal_app\":\"\",\n      \"preferred_language\":\"en_us\",\n      \"campaign_id\":\"\",\n      \"campaign_name\":\"\",\n      \"c_accept_status_fields\":\"\",\n      \"m_accept_status_fields\":\"\",\n      \"accept_status_id\":\"\",\n      \"accept_status_name\":\"\",\n      \"sync_contact\":\"\",\n      \"my_favorite\":false,\n      \"_acl\":{\n         \"fields\":{\n         }\n      }\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/link/:link_name POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_POST/index.html"}
{"id": "a5d3f3b6f705-0", "text": "/ForecastManagerWorksheets/filter POST\nReturns a collection of ForecastManagerWorksheet models\nSummary:\nThis end point is used to return selective ManagerWorksheets with the optional filter parameter.\nQuery Parameters:\nParam\nDescription\nOptional\nfilter\nWhat you want to filter on\nOptional\nPossible Errors\nError\nDescription\n412 - Invalid Parameter\nWhen the passed in timeperiod and/or user can not be found\n403 - Not Authorized\nIf you are not an administrator, but you are trying to view another managers forecast manager worksheet, you will receive a 403 Not Authorized Error\nUrl Example:\n        /rest/v10/ForecastManagerWorksheets/filter\n{\n  \"filter\":[\n      {\"assigned_user_id\" : \"seed_jim_id\"},\n      {\"timeperiod_id\":\"e546185a-5889-ea75-84c8-511178d1a5ba\"}\n  ],\n}\n    \nOutput Example:\n        { \"next_offset\": -1,\n        \"records\": [\n            {\n                \"id\": \"ad3908c7-83a3-f360-c223-51117844c208\",\n                \"name\": \"Grow-Fast Inc - 1000 units\",\n                \"date_entered\": \"2013-02-05T21:22:00+00:00\",\n                \"date_modified\": \"2013-02-05T21:22:00+00:00\",\n                \"modified_user_id\": \"1\",\n                \"modified_by_name\": \"Administrator\",\n                \"created_by\": \"1\",\n                \"created_by_name\": \"Administrator\",\n                \"description\": \"\",\n                \"img\": \"\",\n                \"deleted\": \"0\",\n                \"assigned_user_id\": \"seed_jim_id\",\n                \"assigned_user_name\": \"Jim Brennan\",\n                \"team_name\": [\n                    {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsfilter_POST/index.html"}
{"id": "a5d3f3b6f705-1", "text": "\"team_name\": [\n                    {\n                        \"id\": \"East\",\n                        \"name\": \"East\",\n                        \"name_2\": \"\",\n                        \"primary\": true\n                    }\n                ],\n                \"parent_id\": \"50b90565-e748-ed77-d9d7-511178f5acae\",\n                \"parent_type\": \"Opportunities\",\n                \"account_name\": \"\",\n                \"account_id\": \"\",\n                \"likely_case\": \"75000\",\n                \"best_case\": \"75000\",\n                \"worst_case\": \"75000\",\n                \"base_rate\": \"1\",\n                \"currency_id\": \"-99\",\n                \"currency_name\": \"\",\n                \"currency_symbol\": \"\",\n                \"date_closed\": \"2013-02-10\",\n                \"date_closed_timestamp\": \"1360531443\",\n                \"sales_stage\": \"Perception Analysis\",\n                \"probability\": \"70\",\n                \"commit_stage\": \"include\",\n                \"draft\": \"1\",\n                \"my_favorite\": false,\n                \"_acl\": {\n                    \"fields\": {}\n                }\n            }]\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsfilter_POST/index.html"}
{"id": "57196a035d2a-0", "text": "/<module>/:record/favorite DELETE\nOverview\n    Removes a record of a specified type as a favorite for the current user.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            <record field>\n        \n            <record field type>\n        \n            Returns the fields for the selected record.\n        \nResponse\n{\n   \"id\":\"bdd59d85-687b-1739-b00a-512d09f6db9e\",\n   \"name\":\"Insight Marketing Inc\",\n   \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n   \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n   \"modified_user_id\":\"1\",\n   \"modified_by_name\":\"Administrator\",\n   \"created_by\":\"1\",\n   \"created_by_name\":\"Administrator\",\n   \"description\":\"\",\n   \"img\":\"\",\n   \"last_activity_date\":\"2013-02-26T19:12:00+00:00\",\n   \"deleted\":false,\n   \"assigned_user_id\":\"seed_max_id\",\n   \"assigned_user_name\":\"Max Jensen\",\n   \"team_name\":[\n      {\n         \"id\":\"East\",\n         \"name\":\"East\",\n         \"name_2\":\"\",\n         \"primary\":false\n      },\n      {\n         \"id\":1,\n         \"name\":\"Global\",\n         \"name_2\":\"\",\n         \"primary\":false\n      },\n      {\n         \"id\":\"West\",\n         \"name\":\"West\",\n         \"name_2\":\"\",\n         \"primary\":true\n      }\n   ],\n   \"linkedin\":\"\",\n   \"facebook\":\"\",\n   \"twitter\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_DELETE/index.html"}
{"id": "57196a035d2a-1", "text": "\"linkedin\":\"\",\n   \"facebook\":\"\",\n   \"twitter\":\"\",\n   \"googleplus\":\"\",\n   \"account_type\":\"Customer\",\n   \"industry\":\"Electronics\",\n   \"annual_revenue\":\"\",\n   \"phone_fax\":\"\",\n   \"billing_address_street\":\"345 Sugar Blvd.\",\n   \"billing_address_street_2\":\"\",\n   \"billing_address_street_3\":\"\",\n   \"billing_address_street_4\":\"\",\n   \"billing_address_city\":\"San Mateo\",\n   \"billing_address_state\":\"CA\",\n   \"billing_address_postalcode\":\"56019\",\n   \"billing_address_country\":\"USA\",\n   \"rating\":\"\",\n   \"phone_office\":\"(927) 136-9572\",\n   \"phone_alternate\":\"\",\n   \"website\":\"www.sectionvegan.de\",\n   \"ownership\":\"\",\n   \"employees\":\"\",\n   \"ticker_symbol\":\"\",\n   \"shipping_address_street\":\"345 Sugar Blvd.\",\n   \"shipping_address_street_2\":\"\",\n   \"shipping_address_street_3\":\"\",\n   \"shipping_address_street_4\":\"\",\n   \"shipping_address_city\":\"San Mateo\",\n   \"shipping_address_state\":\"CA\",\n   \"shipping_address_postalcode\":\"56019\",\n   \"shipping_address_country\":\"USA\",\n   \"email1\":\"kid.support.vegan@example.info\",\n   \"parent_id\":\"\",\n   \"sic_code\":\"\",\n   \"parent_name\":\"\",\n   \"email_opt_out\":false,\n   \"invalid_email\":false,\n   \"email\":[\n      {\n         \"email_address\":\"kid.support.vegan@example.info\",\n         \"opt_out\":\"0\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"1\"\n      },\n      {\n         \"email_address\":\"phone.kid@example.cn\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_DELETE/index.html"}
{"id": "57196a035d2a-2", "text": "},\n      {\n         \"email_address\":\"phone.kid@example.cn\",\n         \"opt_out\":\"0\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"0\"\n      }\n   ],\n   \"campaign_id\":\"\",\n   \"campaign_name\":\"\",\n   \"my_favorite\":false,\n   \"_acl\":{\n      \"fields\":{\n      }\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/favorite DELETE endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_DELETE/index.html"}
{"id": "8343803660c3-0", "text": "/Administration/settings/auth GET\nOverview\n    [ADMIN] Fetch auth settings.\nSummary\n    This endpoint will return auth settings. This endpoint is only available to administrators when IDM migration is turned on.\nResponse if enabled only local auth provider\n{\n  \"enabledProviders\": [\n    \"local\"\n  ],\n  \"local\": {\n        \"password_requirements\": {\n            \"minimum_length\": 6,\n            \"maximum_length\": 0,\n            \"require_upper\": true,\n            \"require_lower\": true,\n            \"require_number\": true,\n            \"require_special\": false,\n            \"password_regex\": \"\",\n            \"regex_description\": \"\"\n        },\n        \"password_expiration\": {\n            \"time\": 0,\n            \"attempt\": 0\n        }\n    }\n}\nResponse if enabled local and ldap auth providers\n{\n    \"enabledProviders\": [\n        \"local\",\n        \"ldap\"\n    ],\n    \"local\": {\n        \"password_requirements\": {\n            \"minimum_length\": 6,\n            \"maximum_length\": 0,\n            \"require_upper\": true,\n            \"require_lower\": true,\n            \"require_number\": true,\n            \"require_special\": false,\n            \"password_regex\": \"\",\n            \"regex_description\": \"\"\n        },\n        \"password_expiration\": {\n            \"time\": 0,\n            \"attempt\": 0\n        }\n    },\n    \"ldap\": {\n        \"user\": {\n            \"mapping\": {\n                \"givenName\": \"first_name\",\n                \"sn\": \"last_name\",\n                \"mail\": \"email1\",\n                \"telephoneNumber\": \"phone_work\",\n                \"facsimileTelephoneNumber\": \"phone_fax\",\n                \"mobile\": \"phone_mobile\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationsettingsauth_GET/index.html"}
{"id": "8343803660c3-1", "text": "\"mobile\": \"phone_mobile\",\n                \"street\": \"address_street\",\n                \"l\": \"address_city\",\n                \"st\": \"address_state\",\n                \"postalCode\": \"address_postalcode\",\n                \"c\": \"address_country\"\n            }\n        },\n        \"adapter_config\": {\n            \"host\": \"127.0.0.1\",\n            \"port\": \"389\",\n            \"options\": {\n                \"network_timeout\": 60,\n                \"timelimit\": 60\n            },\n            \"encryption\": \"none\"\n        },\n        \"adapter_connection_protocol_version\": 3,\n        \"baseDn\": \"dc=openldap,dc=com\",\n        \"uidKey\": \"uid\",\n        \"filter\": \"({uid_key}={username})\",\n        \"dnString\": null,\n        \"entryAttribute\": null,\n        \"autoCreateUser\": \"1\",\n        \"searchDn\": \"cn=admin,ou=admins,dc=openldap,dc=com\",\n        \"searchPassword\": \"admin&password\"\n    }\n}\nResponse if enabled local and saml auth providers\n{\n    \"enabledProviders\": [\n        \"local\",\n        \"saml\"\n    ],\n    \"local\": {\n        \"password_requirements\": {\n            \"minimum_length\": 6,\n            \"maximum_length\": 0,\n            \"require_upper\": true,\n            \"require_lower\": true,\n            \"require_number\": true,\n            \"require_special\": false,\n            \"password_regex\": \"\",\n            \"regex_description\": \"\"\n        },\n        \"password_expiration\": {\n            \"time\": 0,\n            \"attempt\": 0\n        }\n    },\n    \"saml\": {\n        \"strict\": true,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationsettingsauth_GET/index.html"}
{"id": "8343803660c3-2", "text": "}\n    },\n    \"saml\": {\n        \"strict\": true,\n        \"debug\": false,\n        \"sp\": {\n            \"entityId\": \"logoutFlowWithRedirectBinding\",\n            \"assertionConsumerService\": {\n                \"url\": \"http://localhost/index.php?module=Users&action=Authenticate\",\n                \"binding\": \"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\"\n            },\n            \"singleLogoutService\": {\n                \"url\": \"http://localhost/index.php?module=Users&action=Logout\",\n                \"binding\": \"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\"\n            },\n            \"NameIDFormat\": \"urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress\",\n            \"x509cert\": \"\",\n            \"privateKey\": \"\",\n            \"provisionUser\": true,\n            \"sugarCustom\": []\n        },\n        \"idp\": {\n            \"entityId\": \"http://localhost:8080/simplesaml/saml2/idp/metadata.php\",\n            \"singleSignOnService\": {\n                \"url\": \"http://localhost:8080/simplesaml/saml2/idp/SSOService.php\",\n                \"binding\": \"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\"\n            },\n            \"singleLogoutService\": {\n                \"url\": \"http://localhost:8080/simplesaml/saml2/idp/SingleLogoutService.php\",\n                \"binding\": \"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\"\n            },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationsettingsauth_GET/index.html"}
{"id": "8343803660c3-3", "text": "},\n            \"x509cert\": \"-----BEGIN CERTIFICATE-----\\n --x509cert-- \\n-----END CERTIFICATE-----\"\n        },\n        \"security\": {\n            \"authnRequestsSigned\": false,\n            \"logoutRequestSigned\": false,\n            \"logoutResponseSigned\": false,\n            \"signatureAlgorithm\": \"http://www.w3.org/2001/04/xmldsig-more#rsa-sha256\",\n            \"validateRequestId\": false\n        }\n    }\n}\nChange Log\nVersion\nChange\n            v11_2\n        \n            Added /Administration/settings/auth GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationsettingsauth_GET/index.html"}
{"id": "7ceccbcb7a56-0", "text": "/Users/:record/link POST\nOverview\n    Creates relationships to a pre-existing record.\nRequest Arguments\nName\nType\nDescription\nRequired\n            <relationship link>\n        \n            <string>\n        \n            Link between targeted and related records.\n        \n            True\n        \n            <record ID>\n        \n            <string>\n        \n            The name value list of related records. Each item of the list may be either string equal to related item ID,\n            or map containing record ID (\"id\" key is required in this case)\n            and addition relationship properties.\n        \n            True\n        \nRequest\n{\n    link_name: \"accounts\"\n    ids: [\n        \"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n        {\n            \"id\": \"e689173e-c953-1e14-c215-512d0927e7a2\",\n            \"role\": \"owner\"\n        }\n    ]\n}\nResponse Arguments\nName\nType\nDescription\n            record\n        \n            Array\n        \n            The record linked to related records.\n        \n            related_records\n        \n            Array\n        \n            Records that were associated.\n        \nResponse\n    \"record\": {\n        \"id\": \"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n        \"name\": \"Slender Broadband Inc - 1000 units\",\n        \"date_entered\": \"2013-02-26T19:12:00+00:00\",\n        \"date_modified\": \"2013-02-26T19:12:00+00:00\",\n        \"modified_user_id\": \"1\",\n        \"modified_by_name\": \"Administrator\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html"}
{"id": "7ceccbcb7a56-1", "text": "\"modified_user_id\": \"1\",\n        \"modified_by_name\": \"Administrator\",\n        \"created_by\": \"1\",\n        \"created_by_name\": \"Administrator\",\n        \"description\": \"\",\n        \"img\": \"\",\n        \"last_activity_date\": \"2013-02-28T18:21:00+00:00\",\n        \"deleted\": false,\n        \"assigned_user_id\": \"seed_max_id\",\n        \"assigned_user_name\": \"Max Jensen\",\n        \"team_name\": [\n            {\n                \"id\": \"East\",\n                \"name\": \"East\",\n                \"name_2\": \"\",\n                \"primary\": false\n            },\n            {\n                \"id\": \"West\",\n                \"name\": \"West\",\n                \"name_2\": \"\",\n                \"primary\": true\n            }\n        ],\n        \"opportunity_type\": \"\",\n        \"account_name\": \"Slender Broadband Inc\",\n        \"account_id\": \"181461c6-dc81-1115-1fe0-512d092e8f15\",\n        \"campaign_id\": \"\",\n        \"campaign_name\": \"\",\n        \"lead_source\": \"Campaign\",\n        \"amount\": \"25000\",\n        \"base_rate\": \"1\",\n        \"amount_usdollar\": \"25000\",\n        \"currency_id\": \"-99\",\n        \"currency_name\": \"\",\n        \"currency_symbol\": \"\",\n        \"date_closed\": \"2013-02-27\",\n        \"date_closed_timestamp\": \"1361992480\",\n        \"next_step\": \"\",\n        \"sales_stage\": \"Needs Analysis\",\n        \"sales_status\": \"New\",\n        \"probability\": \"90\",\n        \"best_case\": \"25000\",\n        \"worst_case\": \"25000\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html"}
{"id": "7ceccbcb7a56-2", "text": "\"worst_case\": \"25000\",\n        \"commit_stage\": \"include\",\n        \"my_favorite\": false,\n        \"_acl\": {\n            \"fields\": {\n            }\n        }\n    },\n    \"related_records\": [\n        {\n            \"id\": \"e689173e-c953-1e14-c215-512d0927e7a2\",\n            \"name\": \"Gus Dales\",\n            \"date_entered\": \"2013-02-26T19:12:00+00:00\",\n            \"date_modified\": \"2013-02-26T19:12:00+00:00\",\n            \"modified_user_id\": \"1\",\n            \"modified_by_name\": \"Administrator\",\n            \"created_by\": \"1\",\n            \"created_by_name\": \"Administrator\",\n            \"description\": \"\",\n            \"img\": \"\",\n            \"deleted\": false,\n            \"assigned_user_id\": \"seed_sally_id\",\n            \"assigned_user_name\": \"Sally Bronsen\",\n            \"team_name\": [\n                {\n                    \"id\": \"West\",\n                    \"name\": \"West\",\n                    \"name_2\": \"\",\n                    \"primary\": true\n                }\n            ],\n            \"salutation\": \"\",\n            \"first_name\": \"Gus\",\n            \"last_name\": \"Dales\",\n            \"full_name\": \"Gus Dales\",\n            \"title\": \"Director Operations\",\n            \"linkedin\": \"\",\n            \"facebook\": \"\",\n            \"twitter\": \"\",\n            \"googleplus\": \"\",\n            \"department\": \"\",\n            \"do_not_call\": false,\n            \"phone_home\": \"(661) 120-2292\",\n            \"email\": [\n                {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html"}
{"id": "7ceccbcb7a56-3", "text": "\"email\": [\n                {\n                    \"email_address\": \"section.sugar.section@example.it\",\n                    \"opt_out\": \"1\",\n                    \"invalid_email\": \"0\",\n                    \"primary_address\": \"0\"\n                },\n                {\n                    \"email_address\": \"support.qa.kid@example.co.uk\",\n                    \"opt_out\": \"0\",\n                    \"invalid_email\": \"0\",\n                    \"primary_address\": \"1\"\n                }\n            ],\n            \"phone_mobile\": \"(294) 447-9707\",\n            \"phone_work\": \"(036) 840-3216\",\n            \"phone_other\": \"\",\n            \"phone_fax\": \"\",\n            \"email1\": \"support.qa.kid@example.co.uk\",\n            \"email2\": \"section.sugar.section@example.it\",\n            \"invalid_email\": false,\n            \"email_opt_out\": false,\n            \"primary_address_street\": \"48920 San Carlos Ave\",\n            \"primary_address_street_2\": \"\",\n            \"primary_address_street_3\": \"\",\n            \"primary_address_city\": \"Persistance\",\n            \"primary_address_state\": \"CA\",\n            \"primary_address_postalcode\": \"54556\",\n            \"primary_address_country\": \"USA\",\n            \"alt_address_street\": \"\",\n            \"alt_address_street_2\": \"\",\n            \"alt_address_street_3\": \"\",\n            \"alt_address_city\": \"\",\n            \"alt_address_state\": \"\",\n            \"alt_address_postalcode\": \"\",\n            \"alt_address_country\": \"\",\n            \"assistant\": \"\",\n            \"assistant_phone\": \"\",\n            \"picture\": \"\",\n            \"email_and_name1\": \"\",\n            \"lead_source\": \"Support Portal User Registration\",\n            \"account_name\": \"Arts & Crafts Inc\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html"}
{"id": "7ceccbcb7a56-4", "text": "\"account_name\": \"Arts & Crafts Inc\",\n            \"account_id\": \"d43243c6-9b8e-2973-aee2-512d09bc34b4\",\n            \"opportunity_role_fields\": \"\",\n            \"opportunity_role_id\": \"\",\n            \"opportunity_role\": \"Technical Advisor\",\n            \"reports_to_id\": \"\",\n            \"report_to_name\": \"\",\n            \"portal_name\": \"GusDales145\",\n            \"portal_active\": true,\n            \"portal_password\": \"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0\",\n            \"portal_password1\": \"\",\n            \"portal_app\": \"\",\n            \"preferred_language\": \"en_us\",\n            \"campaign_id\": \"\",\n            \"campaign_name\": \"\",\n            \"c_accept_status_fields\": \"\",\n            \"m_accept_status_fields\": \"\",\n            \"accept_status_id\": \"\",\n            \"accept_status_name\": \"\",\n            \"sync_contact\": \"\",\n            \"my_favorite\": false,\n            \"_acl\": {\n                \"fields\": {\n                }\n            }\n        },\n        {\n            \"id\": \"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n            \"name\": \"Slender Broadband Inc - 1000 units\",\n            \"date_entered\": \"2013-02-26T19:12:00+00:00\",\n            \"date_modified\": \"2013-02-26T19:12:00+00:00\",\n            \"modified_user_id\": \"1\",\n            \"modified_by_name\": \"Administrator\",\n            \"created_by\": \"1\",\n            \"created_by_name\": \"Administrator\",\n            \"description\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html"}
{"id": "7ceccbcb7a56-5", "text": "\"created_by_name\": \"Administrator\",\n            \"description\": \"\",\n            \"img\": \"\",\n            \"last_activity_date\": \"2013-02-28T18:36:00+00:00\",\n            \"deleted\": false,\n            \"assigned_user_id\": \"seed_max_id\",\n            \"assigned_user_name\": \"Max Jensen\",\n            \"team_name\": [\n                {\n                    \"id\": \"East\",\n                    \"name\": \"East\",\n                    \"name_2\": \"\",\n                    \"primary\": false\n                },\n                {\n                    \"id\": \"West\",\n                    \"name\": \"West\",\n                    \"name_2\": \"\",\n                    \"primary\": true\n                }\n            ],\n            \"opportunity_type\": \"\",\n            \"account_name\": \"Slender Broadband Inc\",\n            \"account_id\": \"181461c6-dc81-1115-1fe0-512d092e8f15\",\n            \"campaign_id\": \"\",\n            \"campaign_name\": \"\",\n            \"lead_source\": \"Campaign\",\n            \"amount\": \"25000\",\n            \"base_rate\": \"1\",\n            \"amount_usdollar\": \"25000\",\n            \"currency_id\": \"-99\",\n            \"currency_name\": \"\",\n            \"currency_symbol\": \"\",\n            \"date_closed\": \"2013-02-27\",\n            \"date_closed_timestamp\": \"1361992480\",\n            \"next_step\": \"\",\n            \"sales_stage\": \"Needs Analysis\",\n            \"sales_status\": \"New\",\n            \"probability\": \"90\",\n            \"best_case\": \"25000\",\n            \"worst_case\": \"25000\",\n            \"commit_stage\": \"include\",\n            \"my_favorite\": false,\n            \"_acl\": {\n                \"fields\": {\n                }", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html"}
{"id": "7ceccbcb7a56-6", "text": "\"_acl\": {\n                \"fields\": {\n                }\n            }\n        }\n    ]\n}\nChange Log\nVersion\nChange\n            v10 (7.6.0)\n        \n            Added support for additional relationship values.\n        \n            v10 (7.1.5)\n        \n            Added /<module>/:record/link POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html"}
{"id": "90e32bf5eb4a-0", "text": "/lang/labels/dropdown PUT\nOverview\nUpdate display labels of dropdown items for dropdowns under different languages.\nSummary\nThis endpoint is used to update display labels of dropdown items in dropdowns under different languages.\nRequest Arguments\nName\nType\nDescription\nRequired\nname\nstring\nThe dropdown name.\nTrue\nlabels\narray\nThe new labels grouped by language keys.\nTrue\nRequest\n[\n  {\n    \"type\": \"dropdown\",\n    \"dropdown\": \"ai_conv_score_classification_dropdown\",\n    \"labels\": {\n      \"de_DE\": {\n        \"not_likely\": \"Unwahrscheinlich\",\n        \"less_likely\": \"Weniger wahrscheinlich\"\n      },\n      \"ja_JP\": {\n        \"not_likely\": \"\u00e3\u0081\u0082\u00e3\u0082\u008a\u00e3\u0081\u009d\u00e3\u0081\u0086\u00e3\u0082\u0082\u00e3\u0081\u00aa\u00e3\u0081\u0084\",\n        \"less_likely\": \"\u00e5\u008f\u00af\u00e8\u0083\u00bd\u00e6\u0080\u00a7\u00e3\u0081\u008c\u00e4\u00bd\u008e\u00e3\u0081\u0084\"\n      }\n    }\n  }\n]\n\u00c2\u00a0\nResponse Example\n[\n    {\n        \"name\": \"ai_conv_score_classification_dropdown\",\n        \"labels\": {\n            \"de_DE\": {\n                \"not_likely\": \"Unwahrscheinlich\",\n                \"less_likely\": \"Weniger wahrscheinlich\"\n            },\n            \"ja_JP\": {\n                \"not_likely\": \"\u00e3\u0081\u0082\u00e3\u0082\u008a\u00e3\u0081\u009d\u00e3\u0081\u0086\u00e3\u0082\u0082\u00e3\u0081\u00aa\u00e3\u0081\u0084\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/langlabelsdropdown_PUT/index.html"}
{"id": "90e32bf5eb4a-1", "text": "\"less_likely\": \"\u00e5\u008f\u00af\u00e8\u0083\u00bd\u00e6\u0080\u00a7\u00e3\u0081\u008c\u00e4\u00bd\u008e\u00e3\u0081\u0084\"\n            }\n        }\n    },\n    {\n        \"name\": \"account_type_dom\",\n        \"labels\": {\n            \"de_DE\": {\n                \"Analyst\": \"Analytiker\",\n                \"Competitor\": \"Wettbewerber\"\n            },\n            \"ja_JP\": {\n                \"Analyst\": \"\u00e3\u0082\u00a2\u00e3\u0083\u008a\u00e3\u0083\u00aa\u00e3\u0082\u00b9\u00e3\u0083\u0088\",\n                \"Competitor\": \"\u00e7\u00ab\u00b6\u00e5\u0090\u0088\u00e4\u00bb\u0096\u00e7\u00a4\u00be\u00e9\u0081\u00b8\u00e6\u0089\u008b\"\n            }\n        }\n    }\n]\nChange Log\nVersion\nChange\nv11.13\nAdded\u00c2\u00a0/lang/labels/dropdown/\u00c2\u00a0PUT endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/langlabelsdropdown_PUT/index.html"}
{"id": "c2c8db909c25-0", "text": "/<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value DELETE\nOverview\nRemoves a relationship based on sync_key. If both the LHS and RHS records can be found with the respective fields, and those records are related, then remove the relationship of the RHS record to the LHS record.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule\nString\nThe module the record belongs to\nTrue\nlhs_sync_key_field_value\nString\nA unique ID for the LHS record identifying it in an external system\nTrue\nlink_name\nString\nA name for the link\nTrue\nrhs_sync_key_field_value\nString\nA unique ID for the RHS record identifying it in an external system\nTrue\nRequest\n/<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value\nResponse Arguments\nName\nType\nDescription\nrecord\nString\nThe ID of the record.\nrelated_record\nString\nThe ID of the related record.\nResponse\nStatus 200\n{\n    \"record\": \"a0328573-a252-a27c-3530-4e4297d4c9e1\",\n    \"related_record\": \"a0328573-bc54-a554-3530-4e4297d4c9e1\"\n}\nStatus 422\n{\n    \"error\": \"invalid_parameter\",\n    \"error_message\": \"Could not find record with :xhs_sync_key_field_value in module: <module>\"\n}\nChange Log\nVersion\nChange\nv11_10\nAdded /<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value\u00c2\u00a0DELETE endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulelhs_sync_key_field_valuelink_by_sync_keyslink_namerhs_sync_key_field_value_DELETE/index.html"}
{"id": "88e054258c43-0", "text": "/Administration/elasticsearch/refresh/status GET\nOverview\n    [ADMIN] Elasticsearch index refresh interval status\nSummary\n    This endpoint returns the current refresh_interval for every index managed by SugarCRM. This endpoint is only\n    available to administrators.\nResponse\n{\n  \"aabbcc_contactsleads\": \"1s\",\n  \"aabbcc_accountsonly\": \"1s\",\n  \"aabbcc_shared\": \"1s\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Administration/elasticsearch/refresh/status GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchrefreshstatus_GET/index.html"}
{"id": "7e2f9a8417e3-0", "text": "/<module>/:record/collection/:collection_name GET\nOverview\n    Lists related records from multiple links at a time.\nSummary\n    This endpoint will return a set of related records fetched from multiple links defined by :collection_name.\n    The records will be filtered, sorted and truncated to max_num as a single collection.\n    Collections may use a field mapping. For instance, the due_date of Tasks may be referred to as date_end.\n    In this case the alias (date_end) should be used in filter and order_by expressions instead of real field name.\n    Note that response data still contains the original fields for the module.\nRequest Arguments\nName\nType\nDescription\nRequired\nfields\nString\n            See Filter API. If collection definition uses aliases, then aliases should be used instead of real field names.\n        \nFalse\nview\nString\n            See Filter API.\n        \nFalse\nmax_num\nInteger\n            See Filter API.\n        \nFalse\nfilter\nString\n            See Filter API. If collection definition uses aliases, then aliases should be used instead of real field names.\n        \nFalse\norder_by\nString\n            See Filter API. If collection definition uses aliases, then aliases should be used instead of real field names.\n        \nFalse\noffset\nMap\n            Individual offset for each link which the collection consists of.\n            -1 (or any negative value) denotes that the link should be skipped.\n            If link offset is not specified, it defaults to 0.\n        \nFalse\nResponse Arguments\nName\nType\nDescription\nnext_offset\nMap\n            The next offset to retrieve records. -1 will be returned for the given link when there are no more records.\n        \nrecords\nArray\nThe record result set.\nerrors\nMap", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordcollectioncollection_name_GET/index.html"}
{"id": "7e2f9a8417e3-1", "text": "records\nArray\nThe record result set.\nerrors\nMap\nErrors encountered while making requests for the individual links. These errors are returned for the client to consume, but do not affect the response status of the request.\nResponse\n{\n    \"next_offset\": {\n        \"calls\": 1,\n        \"meetings\": -1,\n        \"tasks\": -1,\n    },\n    \"records\": [\n        {\n            \"_module\": \"Calls\",\n            \"_link\": \"calls\",\n            \"id\": \"8703fbf3-0ffa-c288-8d2c-512f943ecdc3\",\n            \"name\": \"Discuss review process\",\n            \"date_end\": \"2014-02-26T19:12:00+00:00\"\n        },\n        {\n            \"_module\": \"Tasks\",\n            \"_link\": \"tasks\",\n            \"id\": \"e1c495cb-af17-1b37-dd66-512f934fe155\",\n            \"name\": \"Introduce all players\",\n            \"due_date\": \"2014-02-26T19:12:00+00:00\"\n        },\n        {\n            \"_module\": \"Tasks\",\n            \"_link\": \"tasks\",\n            \"id\": \"456b7848-9959-5a64-cd34-512d0938addd\",\n            \"name\": \"Follow-up on proposal\",\n            \"due_date\": \"2014-02-26T19:12:00+00:00\"\n        }\n    ],\n    \"errors\": {\n        \"meetings\": {\n            \"code\": 403,\n            \"error\": \"not_authorized\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordcollectioncollection_name_GET/index.html"}
{"id": "7e2f9a8417e3-2", "text": "\"code\": 403,\n            \"error\": \"not_authorized\",\n            \"error_message\": \"You are not authorized to perform this action. Contact your administrator if you need access.\"\n        }\n    }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/collection/:collection_name GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordcollectioncollection_name_GET/index.html"}
{"id": "2cb1dd7b8b4d-0", "text": "/Administration/packages/installed GET\nOverview\n[ADMIN] PackageManager lists installed packages.\nSummary\nLists installed packages in the system.\nResponse\n{\n    \"packages\": [\n        {\n            \"name\": \"project_P3\",\n            \"version\": \"1580885734\",\n            \"type\": \"module\",\n            \"published_date\": \"2020-02-06 12:51:17\",\n            \"description\": \"\",\n            \"uninstallable\": true,\n            \"file_install\": \"cd590eb069a73b2eeb6c107776fd60dc\",\n            \"file\": \"cd590eb069a73b2eeb6c107776fd60dc\",\n            \"enabled\": \"ENABLED\",\n            \"id\": \"66172e0e-48df-11ea-9f1f-acde48001122\"\n        }\n    ]\n}\nChange Log\nVersion\nChange\nv11.8\nAdded /Administration/packages/installed\u00c2\u00a0GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationpackagesinstalled_GET/index.html"}
{"id": "68982ef39299-0", "text": "/<module>/:record PUT\nOverview\n    Update a record of the specified type.\nRequest Arguments\nName\nType\nDescription\nRequired\n            <record field>\n        \n            <record field type>\n        \n            The name value list of fields to populate.\n        \n            True\n        \nRequest\n{\n    \"name\":\"New Account Name\",\n    \"phone_office\":\"(555) 888-5555\",\n    \"website\":\"www.newsite.com\",\n    \"meetings\": {\n    {\n        \"add\": [\"21e3385e-404f-b470-407e-54044e3d8024\"],\n        \"delete\": [\"21e3385e-404f-b470-407e-54044e3d8023\"],\n        \"create\": [\n        {\n            \"name\": \"Test Meeting\"\n        }\n      ]\n    }\n}\nLink fields\n    It is possible to add or delete record relations to other records and create new related records.\nAction\nType\nDescription\nadd\n            List\n        \n            List of related records ID. See RelateRecordApi\n            for details.\n        \ndelete\n            List\n        \n            List of related records ID.\n        \ncreate\n            List\n        \n            List of name to value arrays of related records.\n        \nResponse Arguments\nName\nType\nDescription\n            <record field>\n        \n            <record field type>\n        \n            Returns the fields for the updated record.\n        \nResponse\n{\n   \"id\":\"f222265a-b755-da89-0bc7-512d09b800b6\",\n   \"name\":\"New Account Name\",\n   \"date_entered\":\"2013-02-26T19:12:00+00:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_PUT/index.html"}
{"id": "68982ef39299-1", "text": "\"date_modified\":\"2013-02-27T22:49:00+00:00\",\n   \"modified_user_id\":\"1\",\n   \"modified_by_name\":\"Administrator\",\n   \"created_by\":\"1\",\n   \"created_by_name\":\"Administrator\",\n   \"description\":\"\",\n   \"img\":\"\",\n   \"last_activity_date\":\"2013-02-26T19:12:00+00:00\",\n   \"deleted\":false,\n   \"assigned_user_id\":\"seed_sarah_id\",\n   \"assigned_user_name\":\"Sarah Smith\",\n   \"team_name\":[\n      {\n         \"id\":1,\n         \"name\":\"Global\",\n         \"name_2\":\"\",\n         \"primary\":false\n      },\n      {\n         \"id\":\"West\",\n         \"name\":\"West\",\n         \"name_2\":\"\",\n         \"primary\":true\n      }\n   ],\n   \"linkedin\":\"\",\n   \"facebook\":\"\",\n   \"twitter\":\"\",\n   \"googleplus\":\"\",\n   \"account_type\":\"Customer\",\n   \"industry\":\"Hospitality\",\n   \"annual_revenue\":\"\",\n   \"phone_fax\":\"\",\n   \"billing_address_street\":\"9 IBM Path\",\n   \"billing_address_street_2\":\"\",\n   \"billing_address_street_3\":\"\",\n   \"billing_address_street_4\":\"\",\n   \"billing_address_city\":\"San Francisco\",\n   \"billing_address_state\":\"CA\",\n   \"billing_address_postalcode\":\"43635\",\n   \"billing_address_country\":\"USA\",\n   \"rating\":\"\",\n   \"phone_office\":\"(555) 888-5555\",\n   \"phone_alternate\":\"\",\n   \"website\":\"www.newsite.com\",\n   \"ownership\":\"\",\n   \"employees\":\"\",\n   \"ticker_symbol\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_PUT/index.html"}
{"id": "68982ef39299-2", "text": "\"ownership\":\"\",\n   \"employees\":\"\",\n   \"ticker_symbol\":\"\",\n   \"shipping_address_street\":\"9 IBM Path\",\n   \"shipping_address_street_2\":\"\",\n   \"shipping_address_street_3\":\"\",\n   \"shipping_address_street_4\":\"\",\n   \"shipping_address_city\":\"San Francisco\",\n   \"shipping_address_state\":\"CA\",\n   \"shipping_address_postalcode\":\"43635\",\n   \"shipping_address_country\":\"USA\",\n   \"email1\":\"kid86@example.net\",\n   \"parent_id\":\"\",\n   \"sic_code\":\"\",\n   \"parent_name\":\"\",\n   \"email_opt_out\":false,\n   \"invalid_email\":false,\n   \"email\":[\n      {\n         \"email_address\":\"kid86@example.net\",\n         \"opt_out\":\"0\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"1\"\n      },\n      {\n         \"email_address\":\"the.dev@example.name\",\n         \"opt_out\":\"0\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"0\"\n      }\n   ],\n   \"campaign_id\":\"\",\n   \"campaign_name\":\"\",\n   \"my_favorite\":false,\n   \"_acl\":{\n      \"fields\":{\n      }\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_PUT/index.html"}
{"id": "793d2bfab9aa-0", "text": "/pmse_Inbox/ReassignForm/:data/:flowId GET\nOverview\n    Deprecated endpoint.\nSummary\nThis endpoint is deprecated and will be removed in a future release.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxReassignFormdataflowId_GET/index.html"}
{"id": "32dabcf84e90-0", "text": "/<module>/:record/collection/:collection_name/count GET\nOverview\n    Counts related records from multiple links at a time.\nSummary\n    This endpoint will return count of records related by multiple links defined by :collection_name.\n    The records may be filtered.\nRequest Arguments\nName\nType\nDescription\nRequired\nfilter\nString\n            See Filter API. If collection definition uses aliases, then aliases should be used instead of real field names.\n        \nFalse\nResponse Arguments\nName\nType\nDescription\nrecord_count\nMap\n            Count of related records.\n        \nResponse\n{\n   \"record_count\": {\n      \"calls\": 1,\n      \"meetings\": 2,\n      \"tasks\": 3\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/collection/:collection_name/count GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordcollectioncollection_namecount_GET/index.html"}
{"id": "74f6f59880f5-0", "text": "/<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value POST\nOverview\nCreates a relationship based on sync_key. If both the LHS and RHS records can be found with the respective fields, then relate the RHS record to the LHS record.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule\nString\nThe module the record belongs to\nTrue\nlhs_sync_key_field_value\nString\nA unique ID for the LHS record identifying it in an external system\nTrue\nlink_name\nString\nA name for the link\nTrue\nrhs_sync_key_field_value\nString\nA unique ID for the RHS record identifying it in an external system\nTrue\nRequest\n/<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value\nResponse Arguments\nName\nType\nDescription\nrecord\nString\nThe ID of the record.\nrelated_record\nString\nThe ID of the related record.\nResponse\nStatus 200\n{\n    \"record\": \"a0328573-a252-a27c-3530-4e4297d4c9e1\",\n    \"related_record\": \"a0328573-bc54-a554-3530-4e4297d4c9e1\"\n}\nStatus 422\n{\n    \"error\": \"invalid_parameter\",\n    \"error_message\": \"Could not find record with :xhs_sync_key_field_value in module: <module>\"\n}\nChange Log\nVersion\nChange\nv11_10\nAdded /<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value\u00c2\u00a0POST endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulelhs_sync_key_field_valuelink_by_sync_keyslink_namerhs_sync_key_field_value_POST/index.html"}
{"id": "d85abe153009-0", "text": "/<module>/enum/:field GET\nOverview\n    Retrieves the enum values for a specific field.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            <list values>\n        \n           Array\n        \n            Returns the enum values for a field.\n        \nResponse\n{\n   \"\":\"\",\n   \"Analyst\":\"Analyst\",\n   \"Competitor\":\"Competitor\",\n   \"Customer\":\"Customer\",\n   \"Integrator\":\"Integrator\",\n   \"Investor\":\"Investor\",\n   \"Partner\":\"Partner\",\n   \"Press\":\"Press\",\n   \"Prospect\":\"Prospect\",\n   \"Reseller\":\"Reseller\",\n   \"Other\":\"Other\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/enum/:field GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleenumfield_GET/index.html"}
{"id": "b39a013ee391-0", "text": "/pmse_Inbox/cancelCases PUT\nOverview\n    Call methods to cancel a process \nSummary\n    This endpoint cancels one or more processes.\nRequest Arguments\nName\nType\nDescription\nRequired\ncas_id\narray\nCollection of process trigger sequence ids\ntrue\nResponse Arguments\nName\nType\nDescription\nsuccess\nboolean\nResult of the cancel operation\nResponse\n{\n    \"success\":true\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxcancelCases_PUT/index.html"}
{"id": "c751dd636e2a-0", "text": "/ForecastWorksheets/filter POST\nReturns a collection of ForecastWorksheet models\nSummary:\nThis end point is used to return the Worksheets for a user at a given timeperiod.  If no timeperiod is provide it\n    will use the default timeperiod, likewise if no user is provided, it will default to the logged in user.\nAlso this end points use the visibility requirements set forth by the application, that if the records being requested\n    belong to you, you will get the draft version,  If the worksheet is not yours, you will only see the committed version.\nQuery Parameters:\nParam\nDescription\nOptional\nfilter\nWhat you want to filter on\nOptional\ntype\nWhich type to return, currently the ones that are supported are, opportunity and product\nOptional\nPossible Errors\nError\nDescription\n412 - Invalid Parameter\nWhen the passed in timeperiod and/or user can not be found\n403 - Not Authorized\nIf you are not a manager, but you are tyring to view another sales rep forecast worksheet, you will receive a 403 Not Authorized Error\nUrl Example:\n        /rest/v10/ForecastWorksheets/:timeperiod_id/:user_id\n{\n  \"filter\":[\n      {\"assigned_user_id\" : \"seed_jim_id\"},\n      {\"timeperiod_id\":\"e546185a-5889-ea75-84c8-511178d1a5ba\"}\n  ],\n}\n    \nOutput Example:\n        { \"next_offset\": -1,\n        \"records\": [\n            {\n                \"id\": \"ad3908c7-83a3-f360-c223-51117844c208\",\n                \"name\": \"Grow-Fast Inc - 1000 units\",\n                \"date_entered\": \"2013-02-05T21:22:00+00:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsfilter_POST/index.html"}
{"id": "c751dd636e2a-1", "text": "\"date_modified\": \"2013-02-05T21:22:00+00:00\",\n                \"modified_user_id\": \"1\",\n                \"modified_by_name\": \"Administrator\",\n                \"created_by\": \"1\",\n                \"created_by_name\": \"Administrator\",\n                \"description\": \"\",\n                \"img\": \"\",\n                \"deleted\": \"0\",\n                \"assigned_user_id\": \"seed_jim_id\",\n                \"assigned_user_name\": \"Jim Brennan\",\n                \"team_name\": [\n                    {\n                        \"id\": \"East\",\n                        \"name\": \"East\",\n                        \"name_2\": \"\",\n                        \"primary\": true\n                    }\n                ],\n                \"parent_id\": \"50b90565-e748-ed77-d9d7-511178f5acae\",\n                \"parent_type\": \"Opportunities\",\n                \"account_name\": \"\",\n                \"account_id\": \"\",\n                \"likely_case\": \"75000\",\n                \"best_case\": \"75000\",\n                \"worst_case\": \"75000\",\n                \"base_rate\": \"1\",\n                \"currency_id\": \"-99\",\n                \"currency_name\": \"\",\n                \"currency_symbol\": \"\",\n                \"date_closed\": \"2013-02-10\",\n                \"date_closed_timestamp\": \"1360531443\",\n                \"sales_stage\": \"Perception Analysis\",\n                \"probability\": \"70\",\n                \"commit_stage\": \"include\",\n                \"draft\": \"1\",\n                \"my_favorite\": false,\n                \"_acl\": {\n                    \"fields\": {}\n                }\n            }]\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsfilter_POST/index.html"}
{"id": "ab0389d8ddb1-0", "text": "/Emails/:record/link/:link_name/add_record_list/:remote_id POST\nOverview\n    Creates relationships to a pre-existing email from a record list.\nSummary\n    Cannot link existing Notes records as attachments (link: attachments) and existing EmailParticipants records\n    as a sender (link: from) or recipients(links: to, cc, bcc). All other operations\n    described in Relate Record API are supported.\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Emails/:record/link/:link_name/add_record_list/:remote_id POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecordlinklink_nameadd_record_listremote_id_POST/index.html"}
{"id": "4e43aad479a9-0", "text": "/Reports/:record/records GET\nOverview\n    An API to deliver filtered records from a saved report.\nSummary\n    This endpoint will return a list of records from a saved report filtered by an expression.\nRequest Arguments\nName\nType\nDescription\nRequired\n            group_filters\n        \n            String\n        \n            The group filter expression. Filter expressions are explained below.\n            Note that JSON-encoded filters can be specified as query parameters\n            in one of two ways for GET requests:\n            \n                    By specifying individual filter arguments as distinct parameters.\n                    Example: group_filters[0][name]=value.\n                \n                    By specifying the whole filter as a single JSON-encoded string.\n                    Example: group_filters=[{\"name\":\"value\"}].\n                \n            Example: group_filters[0][industry]=Engineering.\n        \n            False\n        \n            use_saved_filters\n        \n            Boolean\n        \n            Flag to indicate whether or not to apply saved runtime filters if exists. The default value is false.\n            Example: use_saved_filters=true.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \nRequest Example\nGET /rest/v10/Reports/:id/records?group_filters[0][industry]=Engineering&use_saved_filters=true&offset=0&max_num=20\nResponse Arguments\nName\nType\nDescription\n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Reportsrecordrecords_GET/index.html"}
{"id": "4e43aad479a9-1", "text": "records.\n        \nResponse\n{\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"description\":\"\",\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"description\":\"\",\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      }\n   ],\n   \"next_offset\": -1\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Reportsrecordrecords_GET/index.html"}
{"id": "298856446166-0", "text": "/pmse_Emails_Templates/:record/etemplate GET\nOverview\n    Exports a .pet file with a Process Email Templates definition\nSummary\n    This endpoint will retrieve a .pet file containing JSON encoded data of a\n    Process Email Templates definition identified by the record input\n    parameter.\nRequest Arguments\nName\nType\nDescription\nRequired\nrecord\nString\nThe Process Email Template record ID\nTrue\nResponse Arguments\nName\nType\nDescription\nN/A\nResponse\nNote: The response is a MIME type application/pet file attachment without any response parameters.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesrecordetemplate_GET/index.html"}
{"id": "1fda1364f1c0-0", "text": "/RevenueLineItems/:record/quote POST\nConvert a Revenue Line Item to a quote.\nSummary:\n     This endpoint is used to convert a single RevenueLineItem to a quote\nQuery Parameters:\nParam\nDescription\nOptional\nrecord\nWhich Revenue Line Item to convert\nfalse\nValid Urls:\n/rest/v10/RevenueLineItems/:record/quote/\nOutput Example:\n        {\n            id:\"123-456-789-0\",\n            name:\"My Test Quote\"\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/RevenueLineItemsrecordquote_POST/index.html"}
{"id": "f3edf29d0082-0", "text": "/pmse_Inbox/getLog GET\nOverview\n    Return the text of the PMSE.log file \nSummary\n    This endpoint gets the contents of the PMSE.log file \nRequest Arguments\nThere are no request arguments for this endpoint\nResponse Arguments\nName\nType\nDescription\nnone\nstring\nLog Entries from PMSE.log\nResponse\n\"Test Log Entry1\\nTest Log Entry2\\n\"\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxgetLog_GET/index.html"}
{"id": "8afcbe06c190-0", "text": "/pmse_Project GET\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n            Note that JSON-encoded filters can be specified as query parameters\n            in one of two ways for GET requests:\n            \n                    By specifying individual filter arguments as distinct parameters.\n                    Example: filter[0][id]=1.\n                \n                    By specifying the whole filter as a single JSON-encoded string.\n                    Note that this syntax is currently not supported on certain modules.\n                    Example: filter=[{\"id\":\"1\"}].\n                \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Project_GET/index.html"}
{"id": "8afcbe06c190-1", "text": "False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. Each field may be represented either by string, or by map\n            containing field name and additional field parameters (applicable to link and collection fields).\n            The fields id and date_modified will always be returned.\n            \n            Example: name,account_type,description,{\"name\":\"opportunities\",\"fields\":[\"id\",\"name\",\"sales_status\"],\"order_by\":\"date_closed:desc\"}\n            For more details on additional field parameters, see\n            Relate API and\n            Collection API.\n        \n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \n            q\n        \n            String\n        \n            A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.\n        \n            False\n        \n            deleted\n        \n            Boolean\n        \n            Boolean to show deleted records in the result set.\n        \n            False\n        \n            nulls_last\n        \n            Boolean", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Project_GET/index.html"}
{"id": "8afcbe06c190-2", "text": "False\n        \n            nulls_last\n        \n            Boolean\n        \n            Boolean to return records with null values in order_by fields last in the result set.\n        \n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\nExample\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Project_GET/index.html"}
{"id": "8afcbe06c190-3", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Project_GET/index.html"}
{"id": "8afcbe06c190-4", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\",\n               \"id\": \"b0701501-1fab-8ae7-3942-540da93f5017\",\n               \"name\": \"360 Vacations - 228 Units\",\n               \"date_modified\": \"2014-09-08T16:05:00+03:00\",\n               \"sales_status\": \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Project_GET/index.html"}
{"id": "8afcbe06c190-5", "text": "{\n               _module: \"Opportunities\"\n               date_modified: \"2014-09-08T16:05:00+03:00\"\n               id: \"9ce7c088-8ee4-7cd3-18f1-540da944d4c0\"\n               name: \"360 Vacations - 312 Units\"\n               sales_status: \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Project_GET/index.html"}
{"id": "d3be89b294c4-0", "text": "/oauth2/logout POST\nOverview\n    Expires the token portion of the OAuth 2.0 specification.\nRequest Arguments\n    This endpoint does not accept any arguments.\nResponse Arguments\nName\nType\nDescription\n                success\n            \n                Boolean\n            \n                The success of the logout.\n            \nResponse\n{\n    \"success\":true\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /oauth2/logout POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/oauth2logout_POST/index.html"}
{"id": "90e06c56e33f-0", "text": "/Mail/address/validate POST\nOverview\n    Validate one or more email addresses.\nRequest Arguments\nType\nDescription\nRequired\n            Array\n        \n            Array of one or more email addresses to validate.\n        \n            True\n        \nRequest\n    [\n        \"a@b.com\",\n        \"c@d.com\",\n        \"invalid-email.com\"\n    ]\nResponse Arguments\nType\nDescription\n            Object\n        \n            Returns an object with each email address as a key and a boolean\n            indicating whether the email address is valid as the value.\n        \nResponse\n{\n    \"a@b.com\": true,\n    \"c@d.com\": true,\n    \"invalid-email.com\": false\n}\nChange Log\nVersion\nChange\n            v11\n        \n            Last version in which /Mail/address/validate POST is available.\n        \n            v10\n        \n            Added /Mail/address/validate POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailaddressvalidate_POST/index.html"}
{"id": "0794be90dae0-0", "text": "/<module>/config POST\nOverview\n    Retrieves the config settings for a given module.\nSummary\n    This endpoint is normally used to manage the forecasting module.\nRequest Arguments\nName\nType\nDescription\nRequired\n            <config field>\n        \n            <config field type>\n        \n            The list of config fields to update.\n        \n            False\n        \nRequest\n{\n    \"MyConfigOption\":\"MyConfigValue\"\n}\nResponse Arguments\nName\nType\nDescription\n            <config field>\n        \n            <config field type>\n        \n            The list of config fields will be returned.\n        \nResponse\n{\n   \"MyConfigOption\":\"MyConfigValue\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/config POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleconfig_POST/index.html"}
{"id": "504e68226326-0", "text": "/pmse_Emails_Templates GET\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n            Note that JSON-encoded filters can be specified as query parameters\n            in one of two ways for GET requests:\n            \n                    By specifying individual filter arguments as distinct parameters.\n                    Example: filter[0][id]=1.\n                \n                    By specifying the whole filter as a single JSON-encoded string.\n                    Note that this syntax is currently not supported on certain modules.\n                    Example: filter=[{\"id\":\"1\"}].\n                \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templates_GET/index.html"}
{"id": "504e68226326-1", "text": "False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. Each field may be represented either by string, or by map\n            containing field name and additional field parameters (applicable to link and collection fields).\n            The fields id and date_modified will always be returned.\n            \n            Example: name,account_type,description,{\"name\":\"opportunities\",\"fields\":[\"id\",\"name\",\"sales_status\"],\"order_by\":\"date_closed:desc\"}\n            For more details on additional field parameters, see\n            Relate API and\n            Collection API.\n        \n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \n            q\n        \n            String\n        \n            A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.\n        \n            False\n        \n            deleted\n        \n            Boolean\n        \n            Boolean to show deleted records in the result set.\n        \n            False\n        \n            nulls_last\n        \n            Boolean", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templates_GET/index.html"}
{"id": "504e68226326-2", "text": "False\n        \n            nulls_last\n        \n            Boolean\n        \n            Boolean to return records with null values in order_by fields last in the result set.\n        \n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\nExample\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templates_GET/index.html"}
{"id": "504e68226326-3", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templates_GET/index.html"}
{"id": "504e68226326-4", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\",\n               \"id\": \"b0701501-1fab-8ae7-3942-540da93f5017\",\n               \"name\": \"360 Vacations - 228 Units\",\n               \"date_modified\": \"2014-09-08T16:05:00+03:00\",\n               \"sales_status\": \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templates_GET/index.html"}
{"id": "504e68226326-5", "text": "{\n               _module: \"Opportunities\"\n               date_modified: \"2014-09-08T16:05:00+03:00\"\n               id: \"9ce7c088-8ee4-7cd3-18f1-540da944d4c0\"\n               name: \"360 Vacations - 312 Units\"\n               sales_status: \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templates_GET/index.html"}
{"id": "253c34b0f050-0", "text": "/EmbeddedFiles/:record/file/:field POST\nOverview\n    Attaches a file to a field on a record.\nRequest Arguments\nName\nType\nDescription\nRequired\n            format\n        \n            String\n        \n            The data format. Currently accepts 'sugar-html-json'.\n        \n            True\n        \n            delete_if_fails\n        \n            Boolean\n        \n            Indicates whether the API is to mark related record deleted if the file upload fails.\n        \n            False\n        \n            oauth_token\n        \n            String\n        \n            The oauth_token value.\n        \n            False - Required if only if delete_if_fails is true.\n        \n            <attachment field>\n        \n            String\n        \n            The field and file to populate.\n            \n            Example: {\"\":\"@\\/path\\/to\\/ExampleDocument.txt\"}\n            True\n        \nRequest\n{\n   \"format\":\"sugar-html-json\",\n   \"delete_if_fails\":true,\n   \"oauth_token\":\"43b6b327-cc70-c301-3299-512ffb99ad97\",\n   \"<attachment field>\":\"@\\/path\\/to\\/ExampleDocument.txt\"\n}\nResponse Arguments\nName\nType\nDescription\n            content-type\n        \n            String\n        \n            The files content type.\n        \n            content-length\n        \n            Integer\n        \n            The files content length.\n        \n            name\n        \n            String\n        \n            The files name.\n        \n            uri\n        \n            String\n        \n            The URI of the file.\n        \nResponse\n{\n   \"content-type\":\"text\\/plain\",\n   \"content-length\":16,\n   \"name\":\"ExampleDocument.txt\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmbeddedFilesrecordfilefield_POST/index.html"}
{"id": "253c34b0f050-1", "text": "\"content-length\":16,\n   \"name\":\"ExampleDocument.txt\",\n   \"uri\":\"http:\\/\\/sugarcrm\\/rest\\/v10\\/Notes\\/ca66c92f-5a8b-28b4-4fc8-512d099b790b\\/file\\/<attachment field>?format=sugar-html-json&delete_if_fails=1&oauth_token=6ec91cf3-1f97-25b9-e0b1-512f8971b2d4\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/file/:field POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmbeddedFilesrecordfilefield_POST/index.html"}
{"id": "554f8cce2d1f-0", "text": "/password/request GET\nOverview\n    Sends an email request to reset a users password.\nRequest Arguments\nName\nType\nDescription\nRequired\n            email\n        \n            String\n        \n            The email of the user.\n        \n            True\n        \n            username\n        \n            String\n        \n            The username of the user.\n        \n            True\n        \nRequest\nhttp://{site_url}/rest/v10/password/request?email=admin%40sugar.crm&username=admin\nNote: GET endpoint parameters are passed in the form of a query string.\nResponse Arguments\nName\nType\nDescription\n            Success\n        \n            boolean\n        \n            Returns the result of sending the email.\n        \nResponse\ntrue\nChange Log\nVersion\nChange\n            v10\n        \n            Added /password/request POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/passwordrequest_GET/index.html"}
{"id": "19c3e1c51e4c-0", "text": "/<module>/filter/count POST\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n        \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. The field date_modified will always be returned.\n            \n            Example: name,account_type,description\n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_POST/index.html"}
{"id": "19c3e1c51e4c-1", "text": "constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example\n    you would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_POST/index.html"}
{"id": "19c3e1c51e4c-2", "text": "Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\nThere are two module expressions, they operate on modules instead of fields. The current module can be specified by\neither using the module name \"_this\" or by leaving the module name as a blank string. The example expression would", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_POST/index.html"}
{"id": "19c3e1c51e4c-3", "text": "filter the records in the current module to only your favorites. The only currently accepted module expressions are\n\"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_POST/index.html"}
{"id": "19c3e1c51e4c-4", "text": "\"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",\n         \"full_name\":\"Dale Spivey\",\n         \"title\":\"VP Operations\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(523) 825-4311\",\n         \"email\":[\n            {\n               \"email_address\":\"sugar.dev.sugar@example.co.jp\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            },\n            {\n               \"email_address\":\"the.support@example.biz\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            }\n         ],\n         \"phone_mobile\":\"(373) 861-0757\",\n         \"phone_work\":\"(212) 542-9596\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"sugar.dev.sugar@example.co.jp\",\n         \"email2\":\"the.support@example.biz\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"345 Sugar Blvd.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"87261\",\n         \"primary_address_country\":\"USA\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_POST/index.html"}
{"id": "19c3e1c51e4c-5", "text": "\"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Campaign\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"DaleSpivey97\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\\/\",\n         \"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_POST/index.html"}
{"id": "19c3e1c51e4c-6", "text": "\"name\":\"Florence Haddock\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Florence\",\n         \"last_name\":\"Haddock\",\n         \"full_name\":\"Florence Haddock\",\n         \"title\":\"Director Sales\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(729) 845-3137\",\n         \"email\":[\n            {\n               \"email_address\":\"dev.vegan@example.de\",\n               \"opt_out\":\"1\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            },\n            {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_POST/index.html"}
{"id": "19c3e1c51e4c-7", "text": "\"primary_address\":\"0\"\n            },\n            {\n               \"email_address\":\"section71@example.it\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            }\n         ],\n         \"phone_mobile\":\"(246) 233-1382\",\n         \"phone_work\":\"(565) 696-6981\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"section71@example.it\",\n         \"email2\":\"dev.vegan@example.de\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"111 Silicon Valley Road\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"79900\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Support Portal User Registration\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_POST/index.html"}
{"id": "19c3e1c51e4c-8", "text": "\"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"FlorenceHaddock169\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$nWFhTbK6$JF9BCGSqL\\/NCrbhueX5ia0\",\n         \"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_POST/index.html"}
{"id": "75b966ba6a7a-0", "text": "/integrate/<module>/:sync_key_field_name/:sync_key_field_value GET\nOverview\nRetrieves the record with the given sync_key_field_name.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule\nString\nThe module the record belongs to\nTrue\nsync_key_field_name\nString\nThe name of the field that contains sync_key_field_value (the default field is named\u00c2\u00a0sync_key but can be renamed via code customization)\nTrue\nsync_key_field_value\nString\nA unique ID for the record identifying it in an external system\nTrue\nRequest\n/integrate/<module>/:sync_key_field_name/:sync_key_field_value\nResponse Arguments\nBody: formatted JSON object.\nResponse\nSuccessful Response\nStatus 200\nFailed Response\nStatus 422\n{\n    \"error\": \"invalid_parameter\",\n    \"error_message\": \"Could not find record with :sync_key_field_name::sync_key_field_value in module: <module>\"\n}\nChange Log\nVersion\nChange\nv11_10\nAdded /integrate/<module>/:sync_key_field_name/:sync_key_field_value\u00c2\u00a0GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulesync_key_field_namesync_key_field_value_GET/index.html"}
{"id": "dc531bc06ff7-0", "text": "/Administration/aws POST\nOverview\n[ADMIN] Set Amazon Web Services configs in Sugar Serve.\nSummary\nThis endpoint sets configuration values for Amazon Web Services. This endpoint is only available to administrators of Sugar Serve.\nRequest Arguments\nName\nType\nDescription\nRequired\naws_connect_instance_name\nString\nThe name of the AWS Connect instance\nFalse\naws_connect_region\nString\nThe region assigned to the AWS Connect instance\nFalse\nResponse\n{\n    \"aws_connect_instance_name\": \"my-aws-instance\",\n    \"aws_connect_region\": \"us-east-2\"\n}\nChange Log\nVersion\nChange\nv11_10\nAdded /Administration/aws\u00c2\u00a0POST endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationaws_POST/index.html"}
{"id": "cf80caae79b5-0", "text": "/Filters GET\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n            Note that JSON-encoded filters can be specified as query parameters\n            in one of two ways for GET requests:\n            \n                    By specifying individual filter arguments as distinct parameters.\n                    Example: filter[0][id]=1.\n                \n                    By specifying the whole filter as a single JSON-encoded string.\n                    Note that this syntax is currently not supported on certain modules.\n                    Example: filter=[{\"id\":\"1\"}].\n                \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Filters_GET/index.html"}
{"id": "cf80caae79b5-1", "text": "False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. Each field may be represented either by string, or by map\n            containing field name and additional field parameters (applicable to link and collection fields).\n            The fields id and date_modified will always be returned.\n            \n            Example: name,account_type,description,{\"name\":\"opportunities\",\"fields\":[\"id\",\"name\",\"sales_status\"],\"order_by\":\"date_closed:desc\"}\n            For more details on additional field parameters, see\n            Relate API and\n            Collection API.\n        \n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \n            q\n        \n            String\n        \n            A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.\n        \n            False\n        \n            deleted\n        \n            Boolean\n        \n            Boolean to show deleted records in the result set.\n        \n            False\n        \n            nulls_last\n        \n            Boolean", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Filters_GET/index.html"}
{"id": "cf80caae79b5-2", "text": "False\n        \n            nulls_last\n        \n            Boolean\n        \n            Boolean to return records with null values in order_by fields last in the result set.\n        \n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\nExample\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Filters_GET/index.html"}
{"id": "cf80caae79b5-3", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Filters_GET/index.html"}
{"id": "cf80caae79b5-4", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\",\n               \"id\": \"b0701501-1fab-8ae7-3942-540da93f5017\",\n               \"name\": \"360 Vacations - 228 Units\",\n               \"date_modified\": \"2014-09-08T16:05:00+03:00\",\n               \"sales_status\": \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Filters_GET/index.html"}
{"id": "cf80caae79b5-5", "text": "{\n               _module: \"Opportunities\"\n               date_modified: \"2014-09-08T16:05:00+03:00\"\n               id: \"9ce7c088-8ee4-7cd3-18f1-540da944d4c0\"\n               name: \"360 Vacations - 312 Units\"\n               sales_status: \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Filters_GET/index.html"}
{"id": "763a393ebf32-0", "text": "/ForecastWorksheets/filter GET\nReturns a collection of ForecastWorksheet models\nSummary:\nThis end point is used to return the Worksheets for a user at a given timeperiod.  If no timeperiod is provide it\n    will use the default timeperiod, likewise if no user is provided, it will default to the logged in user.\nAlso this end points use the visibility requirements set forth by the application, that if the records being requested\n    belong to you, you will get the draft version,  If the worksheet is not yours, you will only see the committed version.\nQuery Parameters:\nParam\nDescription\nOptional\nfilter\nWhat you want to filter on\nOptional\ntype\nWhich type to return, currently the ones that are supported are, opportunity and product\nOptional\nPossible Errors\nError\nDescription\n412 - Invalid Parameter\nWhen the passed in timeperiod and/or user can not be found\n403 - Not Authorized\nIf you are not a manager, but you are tyring to view another sales rep forecast worksheet, you will receive a 403 Not Authorized Error\nUrl Example:\n        /rest/v10/ForecastWorksheets/:timeperiod_id/:user_id\n{\n  \"filter\":[\n      {\"assigned_user_id\" : \"seed_jim_id\"},\n      {\"timeperiod_id\":\"e546185a-5889-ea75-84c8-511178d1a5ba\"}\n  ],\n}\n    \nOutput Example:\n        { \"next_offset\": -1,\n        \"records\": [\n            {\n                \"id\": \"ad3908c7-83a3-f360-c223-51117844c208\",\n                \"name\": \"Grow-Fast Inc - 1000 units\",\n                \"date_entered\": \"2013-02-05T21:22:00+00:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsfilter_GET/index.html"}
{"id": "763a393ebf32-1", "text": "\"date_modified\": \"2013-02-05T21:22:00+00:00\",\n                \"modified_user_id\": \"1\",\n                \"modified_by_name\": \"Administrator\",\n                \"created_by\": \"1\",\n                \"created_by_name\": \"Administrator\",\n                \"description\": \"\",\n                \"img\": \"\",\n                \"deleted\": \"0\",\n                \"assigned_user_id\": \"seed_jim_id\",\n                \"assigned_user_name\": \"Jim Brennan\",\n                \"team_name\": [\n                    {\n                        \"id\": \"East\",\n                        \"name\": \"East\",\n                        \"name_2\": \"\",\n                        \"primary\": true\n                    }\n                ],\n                \"parent_id\": \"50b90565-e748-ed77-d9d7-511178f5acae\",\n                \"parent_type\": \"Opportunities\",\n                \"account_name\": \"\",\n                \"account_id\": \"\",\n                \"likely_case\": \"75000\",\n                \"best_case\": \"75000\",\n                \"worst_case\": \"75000\",\n                \"base_rate\": \"1\",\n                \"currency_id\": \"-99\",\n                \"currency_name\": \"\",\n                \"currency_symbol\": \"\",\n                \"date_closed\": \"2013-02-10\",\n                \"date_closed_timestamp\": \"1360531443\",\n                \"sales_stage\": \"Perception Analysis\",\n                \"probability\": \"70\",\n                \"commit_stage\": \"include\",\n                \"draft\": \"1\",\n                \"my_favorite\": false,\n                \"_acl\": {\n                    \"fields\": {}\n                }\n            }]\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsfilter_GET/index.html"}
{"id": "0f85427e5443-0", "text": "/<module>/:record/link/activities/filter GET\nActivities on a module's list view\nSummary:\n  This endpoint lists activities across a particular module in the system. It does not use a subscription model unlike the other endpoints. It can be queried as a regular bean collection, but without search, ordering or filtering.\nQuery Parameters:\nParamDescriptionOptionalmax_numA maximum number of records to returnOptionaloffsetHow many records to skip over before records are returnedOptional\nInput Example:\nThis endpoint does not accept any input\nOutput Example:\n{\n    \"next_offset\": 20, This will be set to -1 when there are no more records after this \"page\".\n    \"records\": [{\n        \"id\": \"22fb8b16-de1d-f1dc-b15b-51240efde177\",\n        \"date_entered\": \"2013-02-19T23:47:11+00:00\",\n        \"date_modified\": \"2013-02-19T23:47:11+00:00\",\n        \"created_by\": \"1\",\n        \"deleted\": \"0\",\n        \"parent_id\": \"f5bb0331-2c0f-5c7c-b4db-5123caac0056\",\n        \"parent_type\": \"Contacts\",\n        \"activity_type\": \"post\", This will be the type of activity performed.\n        \"data\": {\n            \"value\": \"This is a test post on a contact I'm subscribed to.\"\n        },\n        \"comment_count\": 0, This will be set to the total number of comments on the post.\n        \"last_comment\": { This will be the last comment on the post, which can be used to create a comment model on the frontend.\n            \"deleted\": 0,\n            \"data\": []\n        },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkactivitiesfilter_GET/index.html"}
{"id": "0f85427e5443-1", "text": "\"deleted\": 0,\n            \"data\": []\n        },\n        \"fields\": [],\n        \"first_name\": null,\n        \"last_name\": \"Administrator\",\n        \"created_by_name\": \" Administrator\" This will be the locale-formatted full name of the user.\n    }, ... ]\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkactivitiesfilter_GET/index.html"}
{"id": "7a8abba2bcb5-0", "text": "/Forecasts/:timeperiod_id/progressManager/:user_id GET\nProjected Manager Data\nSummary:\n    This endpoint is used to return the json Data not already in client view for the Forecasts manager projected panel.\nQuery Parameters:\nParam\nDescription\nOptional\nuser_id\nShow for a specific user, defaults to current user if not defined\nOptional\ntimeperiod_id\nShow for a specific time period, defaults to the current time period if one is not passed\nOptional\nInput Example:\n{\n    user_id:seed_sally_id\n    timeperiod_id:36f7085a-5889-ea75-84c8-50f42bd1a5ba\n}\n    \nOutput Example:\n{\n    closed_amount: 0\n    opportunities: 13\n    pipeline_revenue: 470000\n    quota_amount: 382000.000000\n}\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_idprogressManageruser_id_GET/index.html"}
{"id": "6521019b5c28-0", "text": "/<module>/customfield/:field DELETE\nOverview\nDelete a custom field for a specified module.\nSummary\nThis endpoint is used to delete a custom field for a specified module.\nRequest Arguments\nThis endpoint does not accept any request arguments.\nResponse\n{\n    \"name\": \"ai_conv_score_c\"\n}\nResponse Codes and Error Messages\nAll successful responses should return 200.\nThis API returns the following error responses:\n403 (SugarAPIExceptionNotAuthorized): Sent if the user attempts to access a module which they are forbidden to access.\n404 (SugarApiExceptionNot Found): Sent if the requested field is not found.\n422 (SugarApiExceptionInvalidParameter): Sent if the module and/or field are invalid.\n500 (SugarApiExceptionError): Sent if there's an unknown error that causes the custom field to not be deleted in the module.\nChange Log\nVersion\nChange\nv11.11\nAdded /<module>/customfield/:field DELETE endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulecustomfieldfield_DELETE/index.html"}
{"id": "e5b6b9850916-0", "text": "/<module>/:root/tree GET\nOverview\n    Retrieves full tree for selected root record.\nRequest Arguments\nName\nType\nDescription\nRequired\n                module\n            \n                String\n            \n                The name of sugar module that contains a nested set data and implements the NestedSetInterface.\n            \n                True\n            \n                :record\n            \n                String\n            \n                The ID of record\n            \n                True\n            \nResponse Arguments\n    This endpoint does not return any response arguments.\nResponse\n{\n\"next_offset\": -1,\n\"records\": [{\n    \"id\": \"ad4ddf76-327a-11e4-818b-5404a67f3363\",\n    \"name\": \"Documents\",\n    \"date_entered\": null,\n    \"date_modified\": null,\n    \"modified_user_id\": null,\n    \"created_by\": null,\n    \"description\": null,\n    \"deleted\": \"0\",\n    \"source_id\": null,\n    \"source_type\": null,\n    \"source_meta\": null,\n    \"root\": \"935d3e07-327a-11e4-818b-5404a67f3363\",\n    \"lft\": \"2\",\n    \"rgt\": \"9\",\n    \"level\": \"1\",\n    \"children\": {\n        \"next_offset\": -1,\n        \"records\": [{\n            \"id\": \"ad4e03f1-327a-11e4-818b-5404a67f3363\",\n            \"name\": \"Engeneering\",\n            \"date_entered\": null,\n            \"date_modified\": null,\n            \"modified_user_id\": null,\n            \"created_by\": null,\n            \"description\": null,\n            \"deleted\": \"0\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html"}
{"id": "e5b6b9850916-1", "text": "\"description\": null,\n            \"deleted\": \"0\",\n            \"source_id\": null,\n            \"source_type\": null,\n            \"source_meta\": null,\n            \"root\": \"935d3e07-327a-11e4-818b-5404a67f3363\",\n            \"lft\": \"3\",\n            \"rgt\": \"4\",\n            \"level\": \"2\",\n            \"children\": {\n                \"next_offset\": -1,\n                \"records\": []\n            }\n        }, {\n            \"id\": \"f482dd1b-327a-11e4-818b-5404a67f3363\",\n            \"name\": \"Testing\",\n            \"date_entered\": null,\n            \"date_modified\": null,\n            \"modified_user_id\": null,\n            \"created_by\": null,\n            \"description\": null,\n            \"deleted\": \"0\",\n            \"source_id\": null,\n            \"source_type\": null,\n            \"source_meta\": null,\n            \"root\": \"935d3e07-327a-11e4-818b-5404a67f3363\",\n            \"lft\": \"5\",\n            \"rgt\": \"6\",\n            \"level\": \"2\",\n            \"children\": {\n                \"next_offset\": -1,\n                \"records\": []\n            }\n        }, {\n            \"id\": \"f482fb7a-327a-11e4-818b-5404a67f3363\",\n            \"name\": \"Management\",\n            \"date_entered\": null,\n            \"date_modified\": null,\n            \"modified_user_id\": null,\n            \"created_by\": null,\n            \"description\": null,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html"}
{"id": "e5b6b9850916-2", "text": "\"created_by\": null,\n            \"description\": null,\n            \"deleted\": \"0\",\n            \"source_id\": null,\n            \"source_type\": null,\n            \"source_meta\": null,\n            \"root\": \"935d3e07-327a-11e4-818b-5404a67f3363\",\n            \"lft\": \"7\",\n            \"rgt\": \"8\",\n            \"level\": \"2\",\n            \"children\": {\n                \"next_offset\": -1,\n                \"records\": []\n            }\n        }]\n    }\n}, {\n    \"id\": \"045c03b9-327b-11e4-818b-5404a67f3363\",\n    \"name\": \"Audit\",\n    \"date_entered\": null,\n    \"date_modified\": null,\n    \"modified_user_id\": null,\n    \"created_by\": null,\n    \"description\": null,\n    \"deleted\": \"0\",\n    \"source_id\": null,\n    \"source_type\": null,\n    \"source_meta\": null,\n    \"root\": \"935d3e07-327a-11e4-818b-5404a67f3363\",\n    \"lft\": \"10\",\n    \"rgt\": \"19\",\n    \"level\": \"1\",\n    \"children\": {\n        \"next_offset\": -1,\n        \"records\": [{\n            \"id\": \"045c1de6-327b-11e4-818b-5404a67f3363\",\n            \"name\": \"Financial\",\n            \"date_entered\": null,\n            \"date_modified\": null,\n            \"modified_user_id\": null,\n            \"created_by\": null,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html"}
{"id": "e5b6b9850916-3", "text": "\"modified_user_id\": null,\n            \"created_by\": null,\n            \"description\": null,\n            \"deleted\": \"0\",\n            \"source_id\": null,\n            \"source_type\": null,\n            \"source_meta\": null,\n            \"root\": \"935d3e07-327a-11e4-818b-5404a67f3363\",\n            \"lft\": \"11\",\n            \"rgt\": \"14\",\n            \"level\": \"2\",\n            \"children\": {\n                \"next_offset\": -1,\n                \"records\": [{\n                    \"id\": \"0f658847-327b-11e4-818b-5404a67f3363\",\n                    \"name\": \"Invoices\",\n                    \"date_entered\": null,\n                    \"date_modified\": null,\n                    \"modified_user_id\": null,\n                    \"created_by\": null,\n                    \"description\": null,\n                    \"deleted\": \"0\",\n                    \"source_id\": null,\n                    \"source_type\": null,\n                    \"source_meta\": null,\n                    \"root\": \"935d3e07-327a-11e4-818b-5404a67f3363\",\n                    \"lft\": \"12\",\n                    \"rgt\": \"13\",\n                    \"level\": \"3\",\n                    \"children\": {\n                        \"next_offset\": -1,\n                        \"records\": []\n                    }\n                }]\n            }\n        }, {\n            \"id\": \"0f65a6c7-327b-11e4-818b-5404a67f3363\",\n            \"name\": \"Agreements\",\n            \"date_entered\": null,\n            \"date_modified\": null,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html"}
{"id": "e5b6b9850916-4", "text": "\"date_entered\": null,\n            \"date_modified\": null,\n            \"modified_user_id\": null,\n            \"created_by\": null,\n            \"description\": null,\n            \"deleted\": \"0\",\n            \"source_id\": null,\n            \"source_type\": null,\n            \"source_meta\": null,\n            \"root\": \"935d3e07-327a-11e4-818b-5404a67f3363\",\n            \"lft\": \"15\",\n            \"rgt\": \"16\",\n            \"level\": \"2\",\n            \"children\": {\n                \"next_offset\": -1,\n                \"records\": []\n            }\n        }, {\n            \"id\": \"14d30bf3-327b-11e4-818b-5404a67f3363\",\n            \"name\": \"Clients\",\n            \"date_entered\": null,\n            \"date_modified\": null,\n            \"modified_user_id\": null,\n            \"created_by\": null,\n            \"description\": null,\n            \"deleted\": \"0\",\n            \"source_id\": null,\n            \"source_type\": null,\n            \"source_meta\": null,\n            \"root\": \"935d3e07-327a-11e4-818b-5404a67f3363\",\n            \"lft\": \"17\",\n            \"rgt\": \"18\",\n            \"level\": \"2\",\n            \"children\": {\n                \"next_offset\": -1,\n                \"records\": []\n            }\n        }]\n    }\n}]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/tree GET endpoint.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html"}
{"id": "e5b6b9850916-5", "text": "Added /<module>/:record/tree GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html"}
{"id": "8cc7609c2af2-0", "text": "/Administration/packages POST\nOverview\n[ADMIN] PackageManager upload package.\nSummary\nUploads a module loadable package via a multi-part form request. The only parameter is 'upgrade_zip' which must contain a valid module loadable zip file.\nSample Request\nPOST /rest/v11_1/Administration/packages HTTP/1.1\nHost: null\nContent-Type: multipart/form-data\nAccept: application/json\nOAuth-Token: 3bbd6227-cfd0-45c7-8a6e-3c737e3c73ff\nContent-Type: multipart/form-data; boundary=---------------------------9051914041544843365972754266\nContent-Length: 554\n-----------------------------9051914041544843365972754266\nContent-Disposition: form-data; name=\"upgrade_zip\"; filename=\"module.zip\"\nContent-Type: application/zip\n{content-data}\n-----------------------------9051914041544843365972754266--\nResponse\nReturns status 200 OK and file hashes for install and delete package if request is successful.\n{\n\"file_install\": \"5d4b4614421586fd2111714abf622392\",\n\"unFile\": \"5d4b4614421586fd2111714abf622392\"\n}\nOtherwise returns status 4xx with errors.\n{\n\"error\": \"upload_package_error\",\n\"error_message\": \"Issue with the manifest\",\n\"error_description\": \"The uploaded file is not compatible with this version of Sugar: 11.3.0\"\n}\nChange Log\nVersion\nChange\nv11.8\nAdded /Administration/packages\u00c2\u00a0POST endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationpackages_POST/index.html"}
{"id": "d00f7a40de91-0", "text": "/integrate/<module>/:sync_key_field_name/:sync_key_field_value DELETE\nOverview\nDeletes the record with the given sync_key_field_name.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule\nString\nThe module the record belongs to\nTrue\nsync_key_field_name\nString\nThe name of the field that contains sync_key_field_value (the default field is named\u00c2\u00a0sync_key but can be renamed via code customization)\nTrue\nsync_key_field_value\nString\nA unique ID for the record identifying it in an external system\nTrue\nRequest\n/integrate/<module>/:sync_key_field_name/:sync_key_field_value\nResponse Arguments\nName\nType\nDescription\nrecord\nString\nThe ID of the record that was deleted.\nResponse\nStatus 200\n{    \"id\": \"a0328573-a252-a27c-3530-4e4297d4c9e1\"} \nChange Log\nVersion\nChange\nv11_10\nAdded /integrate/<module>/:sync_key_field_name/:sync_key_field_value\u00c2\u00a0DELETE endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulesync_key_field_namesync_key_field_value_DELETE/index.html"}
{"id": "b9d360531d30-0", "text": "/ForecastManagerWorksheets/filter GET\nReturns a collection of ForecastManagerWorksheet models\nSummary:\nThis end point is used to return selective ManagerWorksheets with the optional filter parameter.\nQuery Parameters:\nParam\nDescription\nOptional\nfilter\nWhat you want to filter on\nOptional\nPossible Errors\nError\nDescription\n412 - Invalid Parameter\nWhen the passed in timeperiod and/or user can not be found\n403 - Not Authorized\nIf you are not an administrator, but you are trying to view another managers forecast manager worksheet, you will receive a 403 Not Authorized Error\nUrl Example:\n        /rest/v10/ForecastManagerWorksheets/filter\n{\n  \"filter\":[\n      {\"assigned_user_id\" : \"seed_jim_id\"},\n      {\"timeperiod_id\":\"e546185a-5889-ea75-84c8-511178d1a5ba\"}\n  ],\n}\n    \nOutput Example:\n        { \"next_offset\": -1,\n        \"records\": [\n            {\n                \"id\": \"ad3908c7-83a3-f360-c223-51117844c208\",\n                \"name\": \"Grow-Fast Inc - 1000 units\",\n                \"date_entered\": \"2013-02-05T21:22:00+00:00\",\n                \"date_modified\": \"2013-02-05T21:22:00+00:00\",\n                \"modified_user_id\": \"1\",\n                \"modified_by_name\": \"Administrator\",\n                \"created_by\": \"1\",\n                \"created_by_name\": \"Administrator\",\n                \"description\": \"\",\n                \"img\": \"\",\n                \"deleted\": \"0\",\n                \"assigned_user_id\": \"seed_jim_id\",\n                \"assigned_user_name\": \"Jim Brennan\",\n                \"team_name\": [\n                    {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsfilter_GET/index.html"}
{"id": "b9d360531d30-1", "text": "\"team_name\": [\n                    {\n                        \"id\": \"East\",\n                        \"name\": \"East\",\n                        \"name_2\": \"\",\n                        \"primary\": true\n                    }\n                ],\n                \"parent_id\": \"50b90565-e748-ed77-d9d7-511178f5acae\",\n                \"parent_type\": \"Opportunities\",\n                \"account_name\": \"\",\n                \"account_id\": \"\",\n                \"likely_case\": \"75000\",\n                \"best_case\": \"75000\",\n                \"worst_case\": \"75000\",\n                \"base_rate\": \"1\",\n                \"currency_id\": \"-99\",\n                \"currency_name\": \"\",\n                \"currency_symbol\": \"\",\n                \"date_closed\": \"2013-02-10\",\n                \"date_closed_timestamp\": \"1360531443\",\n                \"sales_stage\": \"Perception Analysis\",\n                \"probability\": \"70\",\n                \"commit_stage\": \"include\",\n                \"draft\": \"1\",\n                \"my_favorite\": false,\n                \"_acl\": {\n                    \"fields\": {}\n                }\n            }]\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsfilter_GET/index.html"}
{"id": "661f63acc9eb-0", "text": "/Administration/search/reindex POST\nOverview\n    [ADMIN] Search schedule reindex\nSummary\n    This endpoint schedules a reindex. This endpoint is only available to administrators.\nRequest Arguments\nName\nType\nDescription\nRequired\n            module_list\n        \n            String\n        \n            Comma delimited list of modules to be reindexed. If omitted, all search enabled modules will be reindexed.\n            \n            Example: Accounts,Contacts\n            False\n        \n            clear_data\n        \n            Boolean\n        \n            If set the records of the selected modules will be removed from the search backend and the schema will be\n            recreated. All records from given modules will be queued to be reindexed which is orchestrated by the job\n            queue.\n            If not set, nothing is dropped from the search backend and all records of the selected modules are queued\n            for reindexing. This is the default behavior.\n            \n            Example: Accounts,Contacts\n            False\n        \nResponse\n{\n    \"success\": true\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Administration/search/reindex POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationsearchreindex_POST/index.html"}
{"id": "bd9b87d289ba-0", "text": "/<module>/:record/unsubscribe DELETE\nSummary:\nThis endpoint deletes a subscription record in the Subscriptions table, from a specified record and module. It allows the user to be unsubscribe from activity stream messages for the record being subscribed to, or \"followed\".\nQuery Parameters:\nThis endpoint does not accept any parameters.\nInput Example:\nThis endpoint does not accept any input.\nOutput Example:\n  If successful, the endpoint responds with a bool of true.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordunsubscribe_DELETE/index.html"}
{"id": "552ca228ef1b-0", "text": "/pmse_Inbox/note_list/:cas_id GET\nOverview\n    Returns the notes list for a process \nSummary\nThis endpoint gets the notes for a process\nRequest Arguments\nName\nType\nDescription\nRequired\ncas_id\nstring\nThe id of the process trigger sequence\ntrue\nResponse Arguments\nName\nType\nDescription\nrowList\nobject\nNote records\ntotalRows\ninteger\nTotal notes\ncurrentOffset\ninteger\nCurrent offset\ncurrentDate\ninteger\nCurrent date\nResponse\n{\n    \"rowList\":\n    [\n        {\n            \"pmse_bpm_notes__date_entered\":\"2016-06-02 16:52:21\",\n            \"id\":\"602d4cb0-28e2-11e6-88c9-6c4008960436\",\n            \"date_entered\":\"2016-06-02T09:52:21-07:00\",\n            \"date_modified\":\"2016-06-02T09:52:21-07:00\",\n            \"cas_id\":\"2\",\n            \"cas_index\":\"1\",\n            \"not_user_id\":\"1\",\n            \"not_user_recipient_id\":\"\",\n            \"not_type\":\"GENERAL\",\n            \"not_date\":null,\n            \"not_status\":\"ACTIVE\",\n            \"not_availability\":\"\",\n            \"not_content\":\"Test Note1\",\n            \"not_recipients\":\"\",\n            \"first_name\":null,\n            \"last_name\":\"Administrator\",\n            \"picture\":\"0b2dc2f0-2377-11e6-9d2a-6c4008960436\"\n        }\n    ],\n    \"totalRows\":1,\n    \"currentOffset\":0,\n    \"currentDate\":\"2016-06-02 16:52:39\"\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxnote_listcas_id_GET/index.html"}
{"id": "552ca228ef1b-1", "text": "}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxnote_listcas_id_GET/index.html"}
{"id": "e53e43a49090-0", "text": "/Emails/:record/link POST\nOverview\n    Creates a relationship to a pre-existing email.\nSummary\n    Cannot link existing Notes records as attachments (link: attachments) and existing EmailParticipants records\n    as a sender (link: from) or recipients(links: to, cc, bcc). All other operations\n    described in Relate Record API are supported.\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Emails/:record/link POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecordlink_POST/index.html"}
{"id": "c28772ff5f7d-0", "text": "/KBContents/filter GET\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n            Note that JSON-encoded filters can be specified as query parameters\n            in one of two ways for GET requests:\n            \n                    By specifying individual filter arguments as distinct parameters.\n                    Example: filter[0][id]=1.\n                \n                    By specifying the whole filter as a single JSON-encoded string.\n                    Note that this syntax is currently not supported on certain modules.\n                    Example: filter=[{\"id\":\"1\"}].\n                \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsfilter_GET/index.html"}
{"id": "c28772ff5f7d-1", "text": "False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. Each field may be represented either by string, or by map\n            containing field name and additional field parameters (applicable to link and collection fields).\n            The fields id and date_modified will always be returned.\n            \n            Example: name,account_type,description,{\"name\":\"opportunities\",\"fields\":[\"id\",\"name\",\"sales_status\"],\"order_by\":\"date_closed:desc\"}\n            For more details on additional field parameters, see\n            Relate API and\n            Collection API.\n        \n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \n            q\n        \n            String\n        \n            A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.\n        \n            False\n        \n            deleted\n        \n            Boolean\n        \n            Boolean to show deleted records in the result set.\n        \n            False\n        \n            nulls_last\n        \n            Boolean", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsfilter_GET/index.html"}
{"id": "c28772ff5f7d-2", "text": "False\n        \n            nulls_last\n        \n            Boolean\n        \n            Boolean to return records with null values in order_by fields last in the result set.\n        \n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\nExample\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsfilter_GET/index.html"}
{"id": "c28772ff5f7d-3", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsfilter_GET/index.html"}
{"id": "c28772ff5f7d-4", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\",\n               \"id\": \"b0701501-1fab-8ae7-3942-540da93f5017\",\n               \"name\": \"360 Vacations - 228 Units\",\n               \"date_modified\": \"2014-09-08T16:05:00+03:00\",\n               \"sales_status\": \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsfilter_GET/index.html"}
{"id": "c28772ff5f7d-5", "text": "{\n               _module: \"Opportunities\"\n               date_modified: \"2014-09-08T16:05:00+03:00\"\n               id: \"9ce7c088-8ee4-7cd3-18f1-540da944d4c0\"\n               name: \"360 Vacations - 312 Units\"\n               sales_status: \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsfilter_GET/index.html"}
{"id": "d1248eb6c3a2-0", "text": "/<module>/:record/link/:link_name/filter/leancount GET\nOverview\n    Lists related filtered records.\nSummary\n    This endpoint will return a set of related records filtered by an expression. The filter can be applied to multiple\n    fields and have multiple and/or conditions in it. Care will need to be taken to make sure this filter has\n    appropriate indexes on the server side otherwise the runtime of the endpoint will be very long. Related fields can\n    be searched by specifying the field name as: \"link_name.remote_field\", so if you wished to search the Accounts\n    module by a related member account you would use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. The field date_modified will always be returned. This argument\n            can be combined with the view argument.\n            \n            Example: name,account_type,description\n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html"}
{"id": "d1248eb6c3a2-1", "text": "False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html"}
{"id": "d1248eb6c3a2-2", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html"}
{"id": "d1248eb6c3a2-3", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nRepsonse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html"}
{"id": "d1248eb6c3a2-4", "text": "\"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",\n         \"full_name\":\"Dale Spivey\",\n         \"title\":\"VP Operations\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(523) 825-4311\",\n         \"email\":[\n            {\n               \"email_address\":\"sugar.dev.sugar@example.co.jp\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            },\n            {\n               \"email_address\":\"the.support@example.biz\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            }\n         ],\n         \"phone_mobile\":\"(373) 861-0757\",\n         \"phone_work\":\"(212) 542-9596\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"sugar.dev.sugar@example.co.jp\",\n         \"email2\":\"the.support@example.biz\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"345 Sugar Blvd.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"87261\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html"}
{"id": "d1248eb6c3a2-5", "text": "\"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Campaign\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"DaleSpivey97\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\\/\",\n         \"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html"}
{"id": "d1248eb6c3a2-6", "text": "\"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Florence\",\n         \"last_name\":\"Haddock\",\n         \"full_name\":\"Florence Haddock\",\n         \"title\":\"Director Sales\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(729) 845-3137\",\n         \"email\":[\n            {\n               \"email_address\":\"dev.vegan@example.de\",\n               \"opt_out\":\"1\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            },\n            {\n               \"email_address\":\"section71@example.it\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            }\n         ],\n         \"phone_mobile\":\"(246) 233-1382\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html"}
{"id": "d1248eb6c3a2-7", "text": "],\n         \"phone_mobile\":\"(246) 233-1382\",\n         \"phone_work\":\"(565) 696-6981\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"section71@example.it\",\n         \"email2\":\"dev.vegan@example.de\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"111 Silicon Valley Road\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"79900\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Support Portal User Registration\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"FlorenceHaddock169\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$nWFhTbK6$JF9BCGSqL\\/NCrbhueX5ia0\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html"}
{"id": "d1248eb6c3a2-8", "text": "\"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/link/:link_name/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html"}
{"id": "955186d1d635-0", "text": "/Administration/elasticsearch/refresh/enable POST\nOverview\n    [ADMIN] Elasticsearch enable refresh_interval\nSummary\n    Enable refresh_interval for all indices managed by SugarCRM. This endpoint is only\n    available to administrators.\nResponse\n{\n  \"aabbcc_contactsleads\": 200,\n  \"aabbcc_accountsonly\": 200,\n  \"aabbcc_shared\": 200\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Administration/elasticsearch/refresh/enable POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchrefreshenable_POST/index.html"}
{"id": "e873490a5f07-0", "text": "/Administration/packages/:id/enable GET\nOverview\n[ADMIN] PackageManager enable a package.\nSummary\nEnable the specified package. Package id hash must be provided. Package id could be found in installed package list.\nResponse\nReturns http status 200 OK and enabled package ID if request is successful.\n{\n\"id\": \"56365210-4cce-11ea-a7bf-acde48001122\"\n}\nOtherwise returns http status 4xx with errors.\n{\n\"error\": \"not_found\",\n\"error_message\": \"Could not find package by ID.\"\n}\nChange Log\nVersion\nChange\nv11.8\nAdded /Administration/packages/:id/enable\u00c2\u00a0GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationpackagesidenable_GET/index.html"}
{"id": "e0327e1b2927-0", "text": "/pmse_Inbox/reactivateFlows PUT\nOverview\n    Deprecated endpoint.\nSummary\nThis endpoint is deprecated and will be removed in a future release.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxreactivateFlows_PUT/index.html"}
{"id": "fed4ad49919b-0", "text": "/Administration/packages/:file_install/install GET\nOverview\n[ADMIN] PackageManager install a package.\nSummary\nInstalls the specified package. Package 'file_install' hash must be provided. file_install hash could be found in staging package list.\nResponse\nReturns http status 200 OK and newly installed package ID if request is successful.\n{\n\"id\": \"56365210-4cce-11ea-a7bf-acde48001122\"\n}\nOtherwise returns http status 4xx with errors.\n{\n\"error\": \"not_found\",\n\"error_message\": \"Could not find package by ID.\"\n}\nChange Log\nVersion\nChange\nv11.8\nAdded /Administration/packages/:file_install/install\u00c2\u00a0GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationpackagesfile_installinstall_GET/index.html"}
{"id": "5a70877e88a3-0", "text": "/pmse_Emails_Templates/variables/find GET\nOverview\n    Get the variable list for a module\nSummary\n    This endpoint will retrieve a list of variables that can be used in the\n    Process Email Templates definition from the specified module.  Input\n    parameters are passed in as the URL query string.  Pagination is supported.\nRequest Arguments\nName\nType\nDescription\nRequired\nbase_module\nString\nThe name of the target module of the Process Email Templates definition.\nTrue\nmodule_list\nString\n                The name of the module the variable list is retrieved from.\n                Should be related to the base_module.\n            \nTrue\nq\nString\nOnly variables with name containing this search string will be returned.\nFalse\nmax_num\nInteger\nMaximum number of variables to return for this request.\nFalse\noffset\nInteger\n                The index of the first variable in the whole list to return for this request.\n                Use \"end\" to indicate no variable should be returned.\n            \nFalse\norder_by\nString\n                Property to sort the variable list by. For example, \"name:asc,id:desc\"\n                will sort the returned variable list by name ASC first and then id DESC.\n            \nFalse\nRequest\nrest/v11/pmse_Emails_Templates/variables/find?max_num=20&order_by=date_modified%3Adesc&module_list=Quotes&base_module=Quotes\nResponse Arguments\nName\nType\nDescription\nnext_offset\nInteger\nThe offset value that should be used to retrieve the next batch of the list.\nrecords\nArray\nA sorted array of variable objects.\nResponse\n{\n    \"next_offset\":20,\n    \"records\":[\n        {\n            \"id\":\"date_quote_expected_closed\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Valid Until\",\n            \"rhs_module\":\"Quotes\"\n        },\n        {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesvariablesfind_GET/index.html"}
{"id": "5a70877e88a3-1", "text": "\"rhs_module\":\"Quotes\"\n        },\n        {\n            \"id\":\"total_usdollar\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Total (US Dollar)\",\n            \"rhs_module\":\"Quotes\"\n        },\n        {\n            \"id\":\"total\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Total\",\n            \"rhs_module\":\"Quotes\"\n        },\n        {\n            \"id\":\"tax_usdollar\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Tax (US Dollar)\",\n            \"rhs_module\":\"Quotes\"\n        },\n        {\n            \"id\":\"tax\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Tax\",\n            \"rhs_module\":\"Quotes\"\n        },\n        {\n            \"id\":\"subtotal_usdollar\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Subtotal (US Dollar)\",\n            \"rhs_module\":\"Quotes\"\n        },\n        {\n            \"id\":\"subtotal\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Subtotal\",\n            \"rhs_module\":\"Quotes\"\n        },\n        {\n            \"id\":\"shipping_address_state\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Shipping State\",\n            \"rhs_module\":\"Quotes\"\n        },\n        {\n            \"id\":\"shipping_address_postalcode\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Shipping Postal Code\",\n            \"rhs_module\":\"Quotes\"\n        },\n        {\n            \"id\":\"shipping_address_country\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Shipping Country\",\n            \"rhs_module\":\"Quotes\"\n        },\n        {\n            \"id\":\"shipping_address_city\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Shipping City\",\n            \"rhs_module\":\"Quotes\"\n        },\n        {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesvariablesfind_GET/index.html"}
{"id": "5a70877e88a3-2", "text": "\"rhs_module\":\"Quotes\"\n        },\n        {\n            \"id\":\"shipping_address_street\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Shipping Address\",\n            \"rhs_module\":\"Quotes\"\n        },\n        {\n            \"id\":\"shipping_usdollar\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Shipping (US Dollar)\",\n            \"rhs_module\":\"Quotes\"\n        },\n        {\n            \"id\":\"shipping\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Shipping\",\n            \"rhs_module\":\"Quotes\"\n        },\n        {\n            \"id\":\"quote_type\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Quote Type\",\n            \"rhs_module\":\"Quotes\"\n        },\n        {\n            \"id\":\"name\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Quote Subject\",\n            \"rhs_module\":\"Quotes\"\n        },\n        {\n            \"id\":\"quote_stage\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Quote Stage\",\n            \"rhs_module\":\"Quotes\"\n        },\n        {\n            \"id\":\"quote_num\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Quote Number\",\n            \"rhs_module\":\"Quotes\"\n        },\n        {\n            \"id\":\"purchase_order_num\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Purchase Order Num\",\n            \"rhs_module\":\"Quotes\"\n        },\n        {\n            \"id\":\"payment_terms\",\n            \"_module\":\"Quotes\",\n            \"name\":\"Payment Terms\",\n            \"rhs_module\":\"Quotes\"\n        }\n    ]\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesvariablesfind_GET/index.html"}
{"id": "642c95028bc0-0", "text": "/ForecastManagerWorksheets/:timeperiod_id GET\nReturns a collection of ForecastManagerWorksheet models\nSummary:\nThis end point is used to return the ManagerWorksheets for a user at a given timeperiod.  If no timeperiod is provide it\n    will use the default timeperiod, likewise if no user is provided, it will default to the logged in user.\nUrl Parameters:\nParam\nDescription\nOptional\ntimeperiod_id\nShow for a specific time period, defaults to the current time period if one is not passed\nOptional\nuser_id\nShow for a specific user, defaults to current user if not defined\nOptional\nPossible Errors\nError\nDescription\n412 - Invalid Parameter\nWhen the passed in timeperiod and/or user can not be found\n403 - Not Authorized\nIf you are not an administrator, but you are trying to view another managers forecast manager worksheet, you will receive a 403 Not Authorized Error\nUrl Example:\n        /rest/v10/ForecastManagerWorksheets/:timeperiod_id/:user_id\n    \nOutput Example:\n    {  \n        \"next_offset\":-1,\n        \"records\":[  \n        {  \n            \"id\":\"401594f5-5b46-fb66-1627-55771fe8723e\",\n            \"name\":\"Sally Bronsen\",\n            \"date_modified\":\"2015-06-09T13:13:26-04:00\",\n            \"created_by\":\"1\",\n            \"quota\":\"1932.444445\",\n            \"best_case\":\"29848.000000\",\n            \"best_case_adjusted\":\"37310.000000\",\n            \"likely_case\":\"28694.444445\",\n            \"likely_case_adjusted\":\"35868.055556\",\n            \"worst_case\":\"27540.888889\",\n            \"worst_case_adjusted\":\"34426.111111\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_id_GET/index.html"}
{"id": "642c95028bc0-1", "text": "\"worst_case_adjusted\":\"34426.111111\",\n            \"timeperiod_id\":\"adb78e81-3fbd-b4e0-287f-55771fd04a06\",\n            \"draft\":true,\n            \"is_manager\":false,\n            \"user_id\":\"seed_sally_id\",\n            \"opp_count\":10,\n            \"pipeline_opp_count\":3,\n            \"pipeline_amount\":\"2415.555556\",\n            \"closed_amount\":\"26278.888889\",\n            \"manager_saved\":true,\n            \"show_history_log\":0,\n            \"following\":false,\n            \"assigned_user_id\":\"seed_sarah_id\",\n            \"assigned_user_name\":\"Sarah Smith\",\n            \"team_name\":[  \n                {  \n                    \"id\":\"1\",\n                    \"name\":\"Global\",\n                    \"name_2\":\"\",\n                    \"primary\":true\n                }\n            ],\n            \"currency_id\":\"-99\",\n            \"base_rate\":\"1.000000\",\n            \"_acl\":{  \n                \"fields\":{  \n                }\n            },\n            \"_module\":\"ForecastManagerWorksheets\"\n        },\n        {  \n            \"id\":\"28226f12-a3c9-bd84-041e-55771f064c4e\",\n            \"name\":\"Max Jensen\",\n            \"date_modified\":\"2015-06-09T13:13:26-04:00\",\n            \"created_by\":\"1\",\n            \"quota\":\"3141.333332\",\n            \"best_case\":\"15848.222223\",\n            \"best_case_adjusted\":\"13206.851853\",\n            \"likely_case\":\"14928.222222\",\n            \"likely_case_adjusted\":\"12440.185185\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_id_GET/index.html"}
{"id": "642c95028bc0-2", "text": "\"likely_case_adjusted\":\"12440.185185\",\n            \"worst_case\":\"14008.222223\",\n            \"worst_case_adjusted\":\"11673.518519\",\n            \"timeperiod_id\":\"adb78e81-3fbd-b4e0-287f-55771fd04a06\",\n            \"draft\":true,\n            \"is_manager\":false,\n            \"user_id\":\"seed_max_id\",\n            \"opp_count\":12,\n            \"pipeline_opp_count\":3,\n            \"pipeline_amount\":\"2617.777777\",\n            \"closed_amount\":\"12310.444445\",\n            \"manager_saved\":true,\n            \"show_history_log\":0,\n            \"following\":false,\n            \"assigned_user_id\":\"seed_sarah_id\",\n            \"assigned_user_name\":\"Sarah Smith\",\n            \"team_name\":[  \n                {  \n                    \"id\":\"1\",\n                    \"name\":\"Global\",\n                    \"name_2\":\"\",\n                    \"primary\":true\n                }\n            ],\n            \"currency_id\":\"-99\",\n            \"base_rate\":\"1.000000\",\n            \"_acl\":{  \n                \"fields\":{  \n                }\n            },\n            \"_module\":\"ForecastManagerWorksheets\"\n        },\n        {  \n            \"id\":\"1aca66af-f069-bba4-28a1-55771fe27506\",\n            \"name\":\"\",\n            \"date_modified\":\"2015-06-09T13:13:26-04:00\",\n            \"created_by\":\"1\",\n            \"quota\":\"10142.333333\",\n            \"best_case\":\"37625.000000\",\n            \"best_case_adjusted\":\"37625.000000\",\n            \"likely_case\":\"34241.333333\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_id_GET/index.html"}
{"id": "642c95028bc0-3", "text": "\"likely_case\":\"34241.333333\",\n            \"likely_case_adjusted\":\"34241.333333\",\n            \"worst_case\":\"30857.666667\",\n            \"worst_case_adjusted\":\"30857.666667\",\n            \"timeperiod_id\":\"adb78e81-3fbd-b4e0-287f-55771fd04a06\",\n            \"draft\":true,\n            \"is_manager\":true,\n            \"user_id\":\"seed_sarah_id\",\n            \"opp_count\":13,\n            \"pipeline_opp_count\":6,\n            \"pipeline_amount\":\"10142.333333\",\n            \"closed_amount\":\"24099.000000\",\n            \"manager_saved\":true,\n            \"show_history_log\":0,\n            \"following\":false,\n            \"assigned_user_id\":\"seed_sarah_id\",\n            \"assigned_user_name\":\"Sarah Smith\",\n            \"team_name\":[  \n                {  \n                    \"id\":\"1\",\n                    \"name\":\"Global\",\n                    \"name_2\":\"\",\n                    \"primary\":true\n                }\n            ],\n            \"currency_id\":\"-99\",\n            \"base_rate\":\"1.000000\",\n            \"_acl\":{  \n                \"fields\":{  \n                }\n            },\n            \"_module\":\"ForecastManagerWorksheets\"\n        }\n        ]\n    }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_id_GET/index.html"}
{"id": "02025b6c571b-0", "text": "/me/password PUT\nOverview\n    Create a new record of a specified type.\nSummary\nThis endpoint allows for changes to the user's password. If client type is support_portal, it will update the corrending Contact. Otherwise, it will update User\nRequest Arguments\nName\nType\nDescription\nRequired\n            old_password\n        \n            String\n        \n            The current password.\n        \n            True\n        \n            new_password\n        \n            String\n        \n            The new password.\n        \n            True\n        \nRequest\n{\n   \"old_password\":\"myoldpass\",\n   \"new_password\":\"mynewpass\"\n}\nResponse Arguments\nName\nType\nDescription\n            valid\n        \n            Boolean\n        \n            Returns the success of the password verification.\n        \n            expiration\n        \n            Date\n        \n            When the password will expire.\n        \nResponse\n{\n   \"valid\":true,\n   \"expiration\":null\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /me/password PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mepassword_PUT/index.html"}
{"id": "337871b993ef-0", "text": "/ForecastManagerWorksheets GET\nReturns a collection of ForecastManagerWorksheet models\nSummary:\nThis end point is used to return the ManagerWorksheets for a user at a given timeperiod.  If no timeperiod is provide it\n    will use the default timeperiod, likewise if no user is provided, it will default to the logged in user.\nUrl Parameters:\nParam\nDescription\nOptional\ntimeperiod_id\nShow for a specific time period, defaults to the current time period if one is not passed\nOptional\nuser_id\nShow for a specific user, defaults to current user if not defined\nOptional\nPossible Errors\nError\nDescription\n412 - Invalid Parameter\nWhen the passed in timeperiod and/or user can not be found\n403 - Not Authorized\nIf you are not an administrator, but you are trying to view another managers forecast manager worksheet, you will receive a 403 Not Authorized Error\nUrl Example:\n        /rest/v10/ForecastManagerWorksheets/:timeperiod_id/:user_id\n    \nOutput Example:\n    {  \n        \"next_offset\":-1,\n        \"records\":[  \n        {  \n            \"id\":\"401594f5-5b46-fb66-1627-55771fe8723e\",\n            \"name\":\"Sally Bronsen\",\n            \"date_modified\":\"2015-06-09T13:13:26-04:00\",\n            \"created_by\":\"1\",\n            \"quota\":\"1932.444445\",\n            \"best_case\":\"29848.000000\",\n            \"best_case_adjusted\":\"37310.000000\",\n            \"likely_case\":\"28694.444445\",\n            \"likely_case_adjusted\":\"35868.055556\",\n            \"worst_case\":\"27540.888889\",\n            \"worst_case_adjusted\":\"34426.111111\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheets_GET/index.html"}
{"id": "337871b993ef-1", "text": "\"worst_case_adjusted\":\"34426.111111\",\n            \"timeperiod_id\":\"adb78e81-3fbd-b4e0-287f-55771fd04a06\",\n            \"draft\":true,\n            \"is_manager\":false,\n            \"user_id\":\"seed_sally_id\",\n            \"opp_count\":10,\n            \"pipeline_opp_count\":3,\n            \"pipeline_amount\":\"2415.555556\",\n            \"closed_amount\":\"26278.888889\",\n            \"manager_saved\":true,\n            \"show_history_log\":0,\n            \"following\":false,\n            \"assigned_user_id\":\"seed_sarah_id\",\n            \"assigned_user_name\":\"Sarah Smith\",\n            \"team_name\":[  \n                {  \n                    \"id\":\"1\",\n                    \"name\":\"Global\",\n                    \"name_2\":\"\",\n                    \"primary\":true\n                }\n            ],\n            \"currency_id\":\"-99\",\n            \"base_rate\":\"1.000000\",\n            \"_acl\":{  \n                \"fields\":{  \n                }\n            },\n            \"_module\":\"ForecastManagerWorksheets\"\n        },\n        {  \n            \"id\":\"28226f12-a3c9-bd84-041e-55771f064c4e\",\n            \"name\":\"Max Jensen\",\n            \"date_modified\":\"2015-06-09T13:13:26-04:00\",\n            \"created_by\":\"1\",\n            \"quota\":\"3141.333332\",\n            \"best_case\":\"15848.222223\",\n            \"best_case_adjusted\":\"13206.851853\",\n            \"likely_case\":\"14928.222222\",\n            \"likely_case_adjusted\":\"12440.185185\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheets_GET/index.html"}
{"id": "337871b993ef-2", "text": "\"likely_case_adjusted\":\"12440.185185\",\n            \"worst_case\":\"14008.222223\",\n            \"worst_case_adjusted\":\"11673.518519\",\n            \"timeperiod_id\":\"adb78e81-3fbd-b4e0-287f-55771fd04a06\",\n            \"draft\":true,\n            \"is_manager\":false,\n            \"user_id\":\"seed_max_id\",\n            \"opp_count\":12,\n            \"pipeline_opp_count\":3,\n            \"pipeline_amount\":\"2617.777777\",\n            \"closed_amount\":\"12310.444445\",\n            \"manager_saved\":true,\n            \"show_history_log\":0,\n            \"following\":false,\n            \"assigned_user_id\":\"seed_sarah_id\",\n            \"assigned_user_name\":\"Sarah Smith\",\n            \"team_name\":[  \n                {  \n                    \"id\":\"1\",\n                    \"name\":\"Global\",\n                    \"name_2\":\"\",\n                    \"primary\":true\n                }\n            ],\n            \"currency_id\":\"-99\",\n            \"base_rate\":\"1.000000\",\n            \"_acl\":{  \n                \"fields\":{  \n                }\n            },\n            \"_module\":\"ForecastManagerWorksheets\"\n        },\n        {  \n            \"id\":\"1aca66af-f069-bba4-28a1-55771fe27506\",\n            \"name\":\"\",\n            \"date_modified\":\"2015-06-09T13:13:26-04:00\",\n            \"created_by\":\"1\",\n            \"quota\":\"10142.333333\",\n            \"best_case\":\"37625.000000\",\n            \"best_case_adjusted\":\"37625.000000\",\n            \"likely_case\":\"34241.333333\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheets_GET/index.html"}
{"id": "337871b993ef-3", "text": "\"likely_case\":\"34241.333333\",\n            \"likely_case_adjusted\":\"34241.333333\",\n            \"worst_case\":\"30857.666667\",\n            \"worst_case_adjusted\":\"30857.666667\",\n            \"timeperiod_id\":\"adb78e81-3fbd-b4e0-287f-55771fd04a06\",\n            \"draft\":true,\n            \"is_manager\":true,\n            \"user_id\":\"seed_sarah_id\",\n            \"opp_count\":13,\n            \"pipeline_opp_count\":6,\n            \"pipeline_amount\":\"10142.333333\",\n            \"closed_amount\":\"24099.000000\",\n            \"manager_saved\":true,\n            \"show_history_log\":0,\n            \"following\":false,\n            \"assigned_user_id\":\"seed_sarah_id\",\n            \"assigned_user_name\":\"Sarah Smith\",\n            \"team_name\":[  \n                {  \n                    \"id\":\"1\",\n                    \"name\":\"Global\",\n                    \"name_2\":\"\",\n                    \"primary\":true\n                }\n            ],\n            \"currency_id\":\"-99\",\n            \"base_rate\":\"1.000000\",\n            \"_acl\":{  \n                \"fields\":{  \n                }\n            },\n            \"_module\":\"ForecastManagerWorksheets\"\n        }\n        ]\n    }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheets_GET/index.html"}
{"id": "09421be654fc-0", "text": "/Accounts/:record/link/:link_name/filter GET\nOverview\n    Lists related filtered records.\nSummary\n    This endpoint will return a set of related records filtered by an expression. The filter can be applied to multiple\n    fields and have multiple and/or conditions in it. Care will need to be taken to make sure this filter has\n    appropriate indexes on the server side otherwise the runtime of the endpoint will be very long. Related fields can\n    be searched by specifying the field name as: \"link_name.remote_field\", so if you wished to search the Accounts\n    module by a related member account you would use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. The field date_modified will always be returned. This argument\n            can be combined with the view argument.\n            \n            Example: name,account_type,description\n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Accountsrecordlinklink_namefilter_GET/index.html"}
{"id": "09421be654fc-1", "text": "False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Accountsrecordlinklink_namefilter_GET/index.html"}
{"id": "09421be654fc-2", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Accountsrecordlinklink_namefilter_GET/index.html"}
{"id": "09421be654fc-3", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nRepsonse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Accountsrecordlinklink_namefilter_GET/index.html"}
{"id": "09421be654fc-4", "text": "\"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",\n         \"full_name\":\"Dale Spivey\",\n         \"title\":\"VP Operations\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(523) 825-4311\",\n         \"email\":[\n            {\n               \"email_address\":\"sugar.dev.sugar@example.co.jp\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            },\n            {\n               \"email_address\":\"the.support@example.biz\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            }\n         ],\n         \"phone_mobile\":\"(373) 861-0757\",\n         \"phone_work\":\"(212) 542-9596\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"sugar.dev.sugar@example.co.jp\",\n         \"email2\":\"the.support@example.biz\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"345 Sugar Blvd.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"87261\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Accountsrecordlinklink_namefilter_GET/index.html"}
{"id": "09421be654fc-5", "text": "\"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Campaign\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"DaleSpivey97\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\\/\",\n         \"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Accountsrecordlinklink_namefilter_GET/index.html"}
{"id": "09421be654fc-6", "text": "\"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Florence\",\n         \"last_name\":\"Haddock\",\n         \"full_name\":\"Florence Haddock\",\n         \"title\":\"Director Sales\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(729) 845-3137\",\n         \"email\":[\n            {\n               \"email_address\":\"dev.vegan@example.de\",\n               \"opt_out\":\"1\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            },\n            {\n               \"email_address\":\"section71@example.it\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            }\n         ],\n         \"phone_mobile\":\"(246) 233-1382\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Accountsrecordlinklink_namefilter_GET/index.html"}
{"id": "09421be654fc-7", "text": "],\n         \"phone_mobile\":\"(246) 233-1382\",\n         \"phone_work\":\"(565) 696-6981\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"section71@example.it\",\n         \"email2\":\"dev.vegan@example.de\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"111 Silicon Valley Road\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"79900\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Support Portal User Registration\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"FlorenceHaddock169\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$nWFhTbK6$JF9BCGSqL\\/NCrbhueX5ia0\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Accountsrecordlinklink_namefilter_GET/index.html"}
{"id": "09421be654fc-8", "text": "\"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/link/:link_name/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Accountsrecordlinklink_namefilter_GET/index.html"}
{"id": "fe3885dc8d29-0", "text": "/pmse_Inbox/settings GET\nOverview\n    Retrieve settings for the PA engine\nSummary\n    This endpoint gets settings for the SugarBPMTM engine\nRequest Arguments\nName\nType\nDescription\nRequired\nfields\nstring\nComma separated list of SugarBPMTM config keys to return. If not sent, all config settings will be returned.\nfalse\nResponse Arguments\nName\nType\nDescription\nlogger_level\nstring\nLevel of logging\nerror_number_of_cycles\ninteger\nError number of cycles\nerror_timeout\ninteger\nTimeout for errors\nResponse\n{\n    \"logger_level\":\"critical\",\n    \"error_number_of_cycles\":\"10\",\n    \"error_timeout\":\"40\"\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxsettings_GET/index.html"}
{"id": "7d23012ac5cf-0", "text": "/connector/twitter/:twitterId GET\nOverview\n    Responds with twitter timeline if connector is set up in administration\nRequest Arguments\nName\nType\nDescription\nRequired\ncount\nInteger\nThe number of tweets to retrieve.\nFalse\nResponse Arguments\nName\nType\nDescription\n            <response>\n        \n            String\n        \nResponse\n[\n   {\n      \"created_at\":\"Tue Jun 25 23:45:35 +0000 2013\",\n      \"id\":349674766946414592,\n      \"id_str\":\"349674766946414592\",\n      \"text\":\"this tweet is awesome!\",\n      \"source\":\"web\",\n      \"truncated\":false,\n      \"in_reply_to_status_id\":null,\n      \"in_reply_to_status_id_str\":null,\n      \"in_reply_to_user_id\":143456975,\n      \"in_reply_to_user_id_str\":\"14934565\",\n      \"in_reply_to_screen_name\":\"testdesk\",\n      \"user\":{\n         \"id\":2630841,\n         \"id_str\":\"2630841\",\n         \"name\":\"SugarCRM\",\n         \"screen_name\":\"sugarcrm\",\n         \"location\":\"Cupertino, CA\",\n         \"description\":\"Everyone Sells. Everyone Supports. Everyone Connects.\",\n         \"url\":\"http:\\/\\/t.co\\/s9ejrBSlki\",\n         \"entities\":{\n            \"url\":{\n               \"urls\":[\n                  {\n                     \"url\":\"http:\\/\\/t.co\\/s9ejrBSlki\",\n                     \"expanded_url\":\"http:\\/\\/www.sugarcrm.com\",\n                     \"display_url\":\"sugarcrm.com\",\n                     \"indices\":[\n                        0,\n                        22\n                     ]\n                  }\n               ]\n            },\n            \"description\":{\n               \"urls\":[", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittertwitterId_GET/index.html"}
{"id": "7d23012ac5cf-1", "text": "}\n               ]\n            },\n            \"description\":{\n               \"urls\":[\n               ]\n            }\n         },\n         \"protected\":false,\n         \"followers_count\":8761,\n         \"friends_count\":6966,\n         \"listed_count\":453,\n         \"created_at\":\"Wed Mar 28 07:16:58 +0000 2007\",\n         \"favourites_count\":27,\n         \"utc_offset\":-28800,\n         \"time_zone\":\"Pacific Time (US \\u0026 Canada)\",\n         \"geo_enabled\":false,\n         \"verified\":false,\n         \"statuses_count\":7488,\n         \"lang\":\"en\",\n         \"contributors_enabled\":false,\n         \"is_translator\":false,\n         \"profile_background_color\":\"98C7EA\",\n         \"profile_background_image_url\":\"http:\\/\\/a0.twimg.com\\/profile_background_images\\/551274192\\/sugar-twitter-background.png\",\n         \"profile_background_image_url_https\":\"https:\\/\\/si0.twimg.com\\/profile_background_images\\/551274192\\/sugar-twitter-background.png\",\n         \"profile_background_tile\":false,\n         \"profile_image_url\":\"http:\\/\\/a0.twimg.com\\/profile_images\\/2027721183\\/Sugar_cube_RGB_180x180_normal.png\",\n         \"profile_image_url_https\":\"https:\\/\\/si0.twimg.com\\/profile_images\\/2027721183\\/Sugar_cube_RGB_180x180_normal.png\",\n         \"profile_link_color\":\"0045AD\",\n         \"profile_sidebar_border_color\":\"FFFFFF\",\n         \"profile_sidebar_fill_color\":\"CCEAFF\",\n         \"profile_text_color\":\"000000\",\n         \"profile_use_background_image\":true,\n         \"default_profile\":false,\n         \"default_profile_image\":false,\n         \"following\":null,\n         \"follow_request_sent\":false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittertwitterId_GET/index.html"}
{"id": "7d23012ac5cf-2", "text": "\"following\":null,\n         \"follow_request_sent\":false,\n         \"notifications\":null\n      },\n      \"geo\":null,\n      \"coordinates\":null,\n      \"place\":null,\n      \"contributors\":null,\n      \"retweet_count\":1,\n      \"favorite_count\":0,\n      \"entities\":{\n         \"hashtags\":[\n         ],\n         \"symbols\":[\n         ],\n         \"urls\":[\n         ],\n         \"user_mentions\":[\n            {\n               \"screen_name\":\"testdesk\",\n               \"name\":\"testdesk\",\n               \"id\":143455,\n               \"id_str\":\"ertrt75\",\n               \"indices\":[\n                  0,\n                  8\n               ]\n            }\n         ],\n         \"media\":[\n         ]\n      },\n      \"favorited\":false,\n      \"retweeted\":false,\n      \"possibly_sensitive\":false,\n      \"lang\":\"en\"\n   }\n]\nChange Log\nVersion\nChange\n            v10\n        \n            Added /twitter/{twitterId} GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittertwitterId_GET/index.html"}
{"id": "6ad1295dfaab-0", "text": "/Administration/packages/:id/uninstall GET\nOverview\n[ADMIN] PackageManager uninstall a package.\nSummary\nUninstalls the specified package. Package id hash must be provided. Package id could be found in installed package list.\nResponse\nReturns http status 200 OK and newly installed package ID if request is successful. Otherwise returns http status 4xx with errors.\n{\n\"error\": \"not_found\",\n\"error_message\": \"Could not find package by ID.\"\n}\nChange Log\nVersion\nChange\nv11.8\nAdded /Administration/packages/:id/uninstall\u00c2\u00a0GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationpackagesiduninstall_GET/index.html"}
{"id": "b601ac57f563-0", "text": "/Administration/packages/:unFile DELETE\nOverview\n[ADMIN] PackageManager delete a package.\nSummary\nDelete the specified package. Package 'unFile' hash must be provided. Package 'unFile' hash could be found in staging package list.\nResponse\nReturns http status 200 OK if request is successful. Otherwise returns http status 4xx with errors.\n{\n\"error\": \"delete_package_error\",\n\"error_message\": \"Could not find package file.\"\n}\nChange Log\nVersion\nChange\nv11.8\nAdded /Administration/packages/:unFile DELETE endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/AdministrationpackagesunFile_DELETE/index.html"}
{"id": "4b9fc73bb124-0", "text": "/Administration/idm/migration/enable POST\nOverview\n    [ADMIN] Enable Idm migrations\nSummary\n    This endpoint enables Idm migrations. This endpoint is only available to administrators.\nRequest Arguments\n    This endpoint does not accept any arguments.\nResponse\n{\n    \"success\": true\n}\nChange Log\nVersion\nChange\n            v11_2\n        \n            Added Administration/idm/migration/enable POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationidmmigrationenable_POST/index.html"}
{"id": "199dee51c4d6-0", "text": "/<module>/insertafter/:target POST\nOverview\n    Insert new node after target node.\nRequest Arguments\nName\nType\nDescription\nRequired\n                module\n            \n                String\n            \n                The name of sugar module that contains a nested set data and implements the NestedSetInterface.\n            \n                True\n            \n                target\n            \n                String\n            \n                The ID of record that will be used as target to insert new node after\n            \n                True\n            \nRequest\n{\n    \"name\" : \"Children Node 1\"\n}\nResponse Arguments\n    This endpoint does not return any response arguments.\nResponse\nThis endpoint returns a newly created bean\n    {\n    \"my_favorite\":false,\n    \"following\":\"\",\n    \"id\":\"59fa8dd7-0f2c-4bfd-364f-54495f77fa3f\",\n    \"name\":\"Default title\",\n    \"date_entered\":\"2014-10-23T23:03:22+03:00\",\n    \"date_modified\":\"2014-10-23T23:03:22+03:00\",\n    \"modified_user_id\":\"1\",\n    \"modified_by_name\":\"Administrator\",\n    \"created_by\":\"1\",\n    \"created_by_name\":\"Administrator\",\n    \"doc_owner\":\"\",\n    \"description\":\"\",\n    \"deleted\":false,\n    \"source_id\":\"\",\n    \"source_type\":\"\",\n    \"source_meta\":\"\",\n    \"root\":\"be9b0c4a-8b78-1ffa-4f14-54481c2f6269\",\n    \"lft\":118,\n    \"rgt\":119,\n    \"level\":1,\n    \"_acl\":{\"fields\":{}},\n    \"_module\":\"Categories\"\n    }\nChange Log\nVersion", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleinsertaftertarget_POST/index.html"}
{"id": "199dee51c4d6-1", "text": "\"_module\":\"Categories\"\n    }\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/insertafter/:target POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleinsertaftertarget_POST/index.html"}
{"id": "e1c2388f68d7-0", "text": "/<module>/filter POST\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n        \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. The field date_modified will always be returned.\n            \n            Example: name,account_type,description\n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html"}
{"id": "e1c2388f68d7-1", "text": "constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example\n    you would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html"}
{"id": "e1c2388f68d7-2", "text": "Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\nThere are two module expressions, they operate on modules instead of fields. The current module can be specified by\neither using the module name \"_this\" or by leaving the module name as a blank string. The example expression would", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html"}
{"id": "e1c2388f68d7-3", "text": "filter the records in the current module to only your favorites. The only currently accepted module expressions are\n\"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html"}
{"id": "e1c2388f68d7-4", "text": "\"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",\n         \"full_name\":\"Dale Spivey\",\n         \"title\":\"VP Operations\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(523) 825-4311\",\n         \"email\":[\n            {\n               \"email_address\":\"sugar.dev.sugar@example.co.jp\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            },\n            {\n               \"email_address\":\"the.support@example.biz\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            }\n         ],\n         \"phone_mobile\":\"(373) 861-0757\",\n         \"phone_work\":\"(212) 542-9596\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"sugar.dev.sugar@example.co.jp\",\n         \"email2\":\"the.support@example.biz\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"345 Sugar Blvd.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"87261\",\n         \"primary_address_country\":\"USA\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html"}
{"id": "e1c2388f68d7-5", "text": "\"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Campaign\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"DaleSpivey97\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\\/\",\n         \"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html"}
{"id": "e1c2388f68d7-6", "text": "\"name\":\"Florence Haddock\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Florence\",\n         \"last_name\":\"Haddock\",\n         \"full_name\":\"Florence Haddock\",\n         \"title\":\"Director Sales\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(729) 845-3137\",\n         \"email\":[\n            {\n               \"email_address\":\"dev.vegan@example.de\",\n               \"opt_out\":\"1\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            },\n            {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html"}
{"id": "e1c2388f68d7-7", "text": "\"primary_address\":\"0\"\n            },\n            {\n               \"email_address\":\"section71@example.it\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            }\n         ],\n         \"phone_mobile\":\"(246) 233-1382\",\n         \"phone_work\":\"(565) 696-6981\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"section71@example.it\",\n         \"email2\":\"dev.vegan@example.de\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"111 Silicon Valley Road\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"79900\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Support Portal User Registration\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html"}
{"id": "e1c2388f68d7-8", "text": "\"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"FlorenceHaddock169\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$nWFhTbK6$JF9BCGSqL\\/NCrbhueX5ia0\",\n         \"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html"}
{"id": "963fc59d28c2-0", "text": "/Emails/filter/count GET\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n        \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. The field date_modified will always be returned.\n            \n            Example: name,account_type,description\n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html"}
{"id": "963fc59d28c2-1", "text": "constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example\n    you would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html"}
{"id": "963fc59d28c2-2", "text": "Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\nThere are two module expressions, they operate on modules instead of fields. The current module can be specified by\neither using the module name \"_this\" or by leaving the module name as a blank string. The example expression would", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html"}
{"id": "963fc59d28c2-3", "text": "filter the records in the current module to only your favorites. The only currently accepted module expressions are\n\"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html"}
{"id": "963fc59d28c2-4", "text": "\"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",\n         \"full_name\":\"Dale Spivey\",\n         \"title\":\"VP Operations\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(523) 825-4311\",\n         \"email\":[\n            {\n               \"email_address\":\"sugar.dev.sugar@example.co.jp\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            },\n            {\n               \"email_address\":\"the.support@example.biz\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            }\n         ],\n         \"phone_mobile\":\"(373) 861-0757\",\n         \"phone_work\":\"(212) 542-9596\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"sugar.dev.sugar@example.co.jp\",\n         \"email2\":\"the.support@example.biz\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"345 Sugar Blvd.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"87261\",\n         \"primary_address_country\":\"USA\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html"}
{"id": "963fc59d28c2-5", "text": "\"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Campaign\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"DaleSpivey97\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\\/\",\n         \"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html"}
{"id": "963fc59d28c2-6", "text": "\"name\":\"Florence Haddock\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Florence\",\n         \"last_name\":\"Haddock\",\n         \"full_name\":\"Florence Haddock\",\n         \"title\":\"Director Sales\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(729) 845-3137\",\n         \"email\":[\n            {\n               \"email_address\":\"dev.vegan@example.de\",\n               \"opt_out\":\"1\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            },\n            {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html"}
{"id": "963fc59d28c2-7", "text": "\"primary_address\":\"0\"\n            },\n            {\n               \"email_address\":\"section71@example.it\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            }\n         ],\n         \"phone_mobile\":\"(246) 233-1382\",\n         \"phone_work\":\"(565) 696-6981\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"section71@example.it\",\n         \"email2\":\"dev.vegan@example.de\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"111 Silicon Valley Road\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"79900\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Support Portal User Registration\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html"}
{"id": "963fc59d28c2-8", "text": "\"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"FlorenceHaddock169\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$nWFhTbK6$JF9BCGSqL\\/NCrbhueX5ia0\",\n         \"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html"}
{"id": "db4b43dc720e-0", "text": "/<module>/:record/unfavorite PUT\nOverview\n    Removes a record of a specified type as a favorite for the current user.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            <record field>\n        \n            <record field type>\n        \n            Returns the fields for the selected record.\n        \nResponse\n{\n   \"id\":\"bdd59d85-687b-1739-b00a-512d09f6db9e\",\n   \"name\":\"Insight Marketing Inc\",\n   \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n   \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n   \"modified_user_id\":\"1\",\n   \"modified_by_name\":\"Administrator\",\n   \"created_by\":\"1\",\n   \"created_by_name\":\"Administrator\",\n   \"description\":\"\",\n   \"img\":\"\",\n   \"last_activity_date\":\"2013-02-26T19:12:00+00:00\",\n   \"deleted\":false,\n   \"assigned_user_id\":\"seed_max_id\",\n   \"assigned_user_name\":\"Max Jensen\",\n   \"team_name\":[\n      {\n         \"id\":\"East\",\n         \"name\":\"East\",\n         \"name_2\":\"\",\n         \"primary\":false\n      },\n      {\n         \"id\":1,\n         \"name\":\"Global\",\n         \"name_2\":\"\",\n         \"primary\":false\n      },\n      {\n         \"id\":\"West\",\n         \"name\":\"West\",\n         \"name_2\":\"\",\n         \"primary\":true\n      }\n   ],\n   \"linkedin\":\"\",\n   \"facebook\":\"\",\n   \"twitter\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordunfavorite_PUT/index.html"}
{"id": "db4b43dc720e-1", "text": "\"linkedin\":\"\",\n   \"facebook\":\"\",\n   \"twitter\":\"\",\n   \"googleplus\":\"\",\n   \"account_type\":\"Customer\",\n   \"industry\":\"Electronics\",\n   \"annual_revenue\":\"\",\n   \"phone_fax\":\"\",\n   \"billing_address_street\":\"345 Sugar Blvd.\",\n   \"billing_address_street_2\":\"\",\n   \"billing_address_street_3\":\"\",\n   \"billing_address_street_4\":\"\",\n   \"billing_address_city\":\"San Mateo\",\n   \"billing_address_state\":\"CA\",\n   \"billing_address_postalcode\":\"56019\",\n   \"billing_address_country\":\"USA\",\n   \"rating\":\"\",\n   \"phone_office\":\"(927) 136-9572\",\n   \"phone_alternate\":\"\",\n   \"website\":\"www.sectionvegan.de\",\n   \"ownership\":\"\",\n   \"employees\":\"\",\n   \"ticker_symbol\":\"\",\n   \"shipping_address_street\":\"345 Sugar Blvd.\",\n   \"shipping_address_street_2\":\"\",\n   \"shipping_address_street_3\":\"\",\n   \"shipping_address_street_4\":\"\",\n   \"shipping_address_city\":\"San Mateo\",\n   \"shipping_address_state\":\"CA\",\n   \"shipping_address_postalcode\":\"56019\",\n   \"shipping_address_country\":\"USA\",\n   \"email1\":\"kid.support.vegan@example.info\",\n   \"parent_id\":\"\",\n   \"sic_code\":\"\",\n   \"parent_name\":\"\",\n   \"email_opt_out\":false,\n   \"invalid_email\":false,\n   \"email\":[\n      {\n         \"email_address\":\"kid.support.vegan@example.info\",\n         \"opt_out\":\"0\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"1\"\n      },\n      {\n         \"email_address\":\"phone.kid@example.cn\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordunfavorite_PUT/index.html"}
{"id": "db4b43dc720e-2", "text": "},\n      {\n         \"email_address\":\"phone.kid@example.cn\",\n         \"opt_out\":\"0\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"0\"\n      }\n   ],\n   \"campaign_id\":\"\",\n   \"campaign_name\":\"\",\n   \"my_favorite\":false,\n   \"_acl\":{\n      \"fields\":{\n      }\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/favorite DELETE endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordunfavorite_PUT/index.html"}
{"id": "cb1d4e1bdf76-0", "text": "/Emails/:record GET\nOverview\n    Retrieves an Emails record.\nFields\nName\nType\nDescription\n                <record field>\n            \n                <record field type>\n            \n                Returns the fields for the selected record.\n            \n                from_collection\n            \n                List\n            \n                The email's sender.\n            \n                to_collection\n            \n                List\n            \n                The email's recipients found in the TO field.\n            \n                cc_collection\n            \n                List\n            \n                The email's recipients found in the CC field.\n            \n                bcc_collection\n            \n                List\n            \n                The email's recipients found in the BCC field.\n            \n                attachments_collection\n            \n                List\n            \n                The email's attachments.\n            \nRequest\nGET /Emails/a028341c-ba92-9343-55e7-56cf5beda121?fields=name,state,\n{\"name\":\"from_collection\",\"fields\":[\"email_address\",\"email_address_id\",\n\"parent_type\",\"parent_id\",\"parent_name\"]},\n{\"name\":\"to_collection\",\"fields\":[\"email_address\",\"email_address_id\",\n\"parent_type\",\"parent_id\",\"parent_name\"]},\n{\"name\":\"cc_collection\",\"fields\":[\"email_address\",\"email_address_id\",\n\"parent_type\",\"parent_id\",\"parent_name\"]},\n{\"name\":\"bcc_collection\",\"fields\":[\"email_address\",\"email_address_id\",\n\"parent_type\",\"parent_id\",\"parent_name\"]},\n{\"name\":\"attachments_collection\",\"fields\":[\"name\",\"filename\",\"file_size\",\n\"file_source\",\"file_mime_type\",\"file_ext\",\"upload_id\"]}\nResponse\n{\n  \"id\": \"a028341c-ba92-9343-55e7-56cf5beda121\",\n  \"state\": \"Archived\",\n  \"name\": \"Re: Discuss Proposal\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_GET/index.html"}
{"id": "cb1d4e1bdf76-1", "text": "\"state\": \"Archived\",\n  \"name\": \"Re: Discuss Proposal\",\n  \"from_collection\": {\n    \"next_offset\": {\n      \"from\": -1\n    },\n    \"records\": [{\n      \"id\": \"ec113d14-7d27-11e7-a951-3c15c2d582c6\",\n      \"email_address\": \"tdavis@example.com\",\n      \"email_address_id\": \"ec05a896-7d27-11e7-a51e-3c15c2d582c6\",\n      \"parent_type\": \"Leads\",\n      \"parent_id\": \"f6a0611a-7d27-11e7-9d70-3c15c2d582c6\",\n      \"parent_name\": \"Tom Davis\",\n      \"_acl\": {\n        \"fields\": {}\n      },\n      \"_link\": \"from\",\n      \"_module\": \"EmailParticipants\"\n    }]\n  },\n  \"to_collection\": {\n    \"next_offset\": {\n      \"to\": -1\n    },\n    \"records\": [{\n      \"id\": \"ec0f1278-7d27-11e7-8d1f-3c15c2d582c6\",\n      \"email_address\": \"ssmith@example.com\",\n      \"email_address_id\": \"ec0fb516-7d27-11e7-b7ad-3c15c2d582c6\",\n      \"parent_type\": \"Users\",\n      \"parent_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n      \"parent_name\": \"Sarah Smith\",\n      \"_acl\": {\n        \"fields\": {}\n      },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_GET/index.html"}
{"id": "cb1d4e1bdf76-2", "text": "\"_acl\": {\n        \"fields\": {}\n      },\n      \"_link\": \"to\",\n      \"_module\": \"EmailParticipants\"\n    }]\n  },\n  \"cc_collection\": {\n    \"next_offset\": {\n      \"cc\": -1\n    },\n    \"records\": [{\n      \"id\": \"eafa7e9a-7d27-11e7-aa2b-3c15c2d582c6\",\n      \"email_address\": \"broland@example.com\",\n      \"email_address_id\": \"ea1cec7e-7d27-11e7-9845-3c15c2d582c6\",\n      \"parent_type\": \"Users\",\n      \"parent_id\": \"e087e79a-7d27-11e7-b02c-3c15c2d582c6\",\n      \"parent_name\": \"Brian Roland\",\n      \"_acl\": {\n        \"fields\": {}\n      },\n      \"_link\": \"cc\",\n      \"_module\": \"EmailParticipants\"\n    }, {\n      \"id\": \"df5eb204-7d27-11e7-b363-3c15c2d582c6\",\n      \"email_address\": \"twallace@example.com\",\n      \"email_address_id\": \"ddf1d9e6-7d27-11e7-bb17-3c15c2d582c6\",\n      \"parent_type\": \"\",\n      \"parent_id\": \"\",\n      \"parent_name\": \"\",\n      \"_acl\": {\n        \"fields\": {}\n      },\n      \"_link\": \"cc\",\n      \"_module\": \"EmailParticipants\"\n    }]\n  },\n  \"bcc_collection\": {\n    \"next_offset\": {\n      \"bcc\": -1", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_GET/index.html"}
{"id": "cb1d4e1bdf76-3", "text": "\"next_offset\": {\n      \"bcc\": -1\n    },\n    \"records\": []\n  },\n  \"attachments_collection\": {\n    \"next_offset\": {\n      \"attachments\": -1\n    },\n    \"records\": [{\n      \"id\": \"afe9702e-53a3-0efb-6bbe-56c3580885ef\",\n      \"name\": \"Quote.pdf\",\n      \"filename\": \"Quote.pdf\",\n      \"upload_id\": \"\",\n      \"file_mime_type\": \"application/pdf\",\n      \"file_size\": 158589,\n      \"file_source\": \"DocumentRevisions\",\n      \"file_ext\": \"pdf\"\n      \"_acl\": {\n        \"fields\": {}\n      },\n      \"_link\": \"attachments\",\n      \"_module\": \"Notes\"\n    }]\n  }\n  \"_acl\": {\n    \"fields\": [\n    ]\n  },\n  \"_module\": \"Emails\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Emails/:record GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_GET/index.html"}
{"id": "5a9c34ca032c-0", "text": "/me/preferences PUT\nOverview\n    Mass updates preferences for the user.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            \u00c2\u00a0\n        \n            \u00c2\u00a0\n        \n            \u00c2\u00a0\n        \nResponse\n{\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /me/preferences PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mepreferences_PUT/index.html"}
{"id": "e7a7b81a8818-0", "text": "/pmse_Project/CrmData/:data/:filter GET\nOverview\n    Retrieves information about Fields, Modules, Users, Roles, etc.\nSummary\n    This endpoint will retrieve various data related to the Process\n    Definition.\nRequest Arguments\nName\nType\nDescription\nRequired\ndata\nString\nThe type of data to be retrieved\nTrue\nfilter\nString\nFiltering criteria to be applied to data retrieved\nFalse\nRequest\nNote: Additional input parameters can be provided in the form\nof a URL query string.\n    /rest/v11/pmse_Project/CrmData/related/Accounts?cardinality=one\nResponse Arguments\nName\nType\nDescription\nsuccess\nBoolean\nThe status of the response\nsearch\nString\nThe value of the filter input parameter\nresult\nArray\nThe data requested\nResponse\n{\n    \"search\":\"Accounts\",\n    \"success\":true,\n    \"result\":\n    [\n        {\n            \"value\":\"Accounts\",\n            \"text\":\"\\u003CAccounts\\u003E\",\n            \"module\":\"Accounts\",\n            \"module_label\":\"Accounts\",\n            \"module_name\":\"Accounts\",\n            \"relationship\":\"Accounts\"\n        },\n        {\n            \"value\":\"member_of\",\n            \"text\":\"Accounts (Member of: member_of)\",\n            \"module\":\"Accounts\",\n            \"module_label\":\"Accounts\",\n            \"module_name\":\"Accounts\",\n            \"relationship\":\"member_accounts\"\n        },\n        {\n            \"value\":\"campaign_accounts\",\n            \"text\":\"Campaigns (Campaigns: campaign_accounts)\",\n            \"module\":\"Campaigns\",\n            \"module_label\":\"Campaigns\",\n            \"module_name\":\"Campaigns\",\n            \"relationship\":\"campaign_accounts\"\n        },\n        {\n            \"value\":\"assigned_user_link\",\n            \"text\":\"Users (Assigned to User: assigned_user_link)\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectCrmDatadatafilter_GET/index.html"}
{"id": "e7a7b81a8818-1", "text": "\"text\":\"Users (Assigned to User: assigned_user_link)\",\n            \"module\":\"Users\",\n            \"module_label\":\"Users\",\n            \"module_name\":\"Users\",\n            \"relationship\":\"accounts_assigned_user\"\n        },\n        {\n            \"value\":\"created_by_link\",\n            \"text\":\"Users (Created by User: created_by_link)\",\n            \"module\":\"Users\",\n            \"module_label\":\"Users\",\n            \"module_name\":\"Users\",\n            \"relationship\":\"accounts_created_by\"\n        },\n        {\n            \"value\":\"modified_user_link\",\n            \"text\":\"Users (Modified by User: modified_user_link)\",\n            \"module\":\"Users\",\n            \"module_label\":\"Users\",\n            \"module_name\":\"Users\",\n            \"relationship\":\"accounts_modified_user\"\n        }\n    ]\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectCrmDatadatafilter_GET/index.html"}
{"id": "dc56b6f98d0d-0", "text": "/Teams/:record/link/:link_name/:remote_id POST\nOverview\n    Creates a relationship to a pre-existing record.\nQuery String Parameters\n    This endpoint does not accept any arguments.\nResponse Arguments\nName\nType\nDescription\n            record\n        \n            Array\n        \n            The record linked to the related record.\n        \n            related_record\n        \n            Array\n        \n            The record that was associated.\n        \nResponse\n{\n   \"record\":{\n      \"id\":\"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n      \"name\":\"Slender Broadband Inc - 1000 units\",\n      \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n      \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n      \"modified_user_id\":\"1\",\n      \"modified_by_name\":\"Administrator\",\n      \"created_by\":\"1\",\n      \"created_by_name\":\"Administrator\",\n      \"description\":\"\",\n      \"img\":\"\",\n      \"last_activity_date\":\"2013-02-28T18:21:00+00:00\",\n      \"deleted\":false,\n      \"assigned_user_id\":\"seed_max_id\",\n      \"assigned_user_name\":\"Max Jensen\",\n      \"team_name\":[\n         {\n            \"id\":\"East\",\n            \"name\":\"East\",\n            \"name_2\":\"\",\n            \"primary\":false\n         },\n         {\n            \"id\":\"West\",\n            \"name\":\"West\",\n            \"name_2\":\"\",\n            \"primary\":true\n         }\n      ],\n      \"opportunity_type\":\"\",\n      \"account_name\":\"Slender Broadband Inc\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_POST/index.html"}
{"id": "dc56b6f98d0d-1", "text": "\"opportunity_type\":\"\",\n      \"account_name\":\"Slender Broadband Inc\",\n      \"account_id\":\"181461c6-dc81-1115-1fe0-512d092e8f15\",\n      \"campaign_id\":\"\",\n      \"campaign_name\":\"\",\n      \"lead_source\":\"Campaign\",\n      \"amount\":\"25000\",\n      \"base_rate\":\"1\",\n      \"amount_usdollar\":\"25000\",\n      \"currency_id\":\"-99\",\n      \"currency_name\":\"\",\n      \"currency_symbol\":\"\",\n      \"date_closed\":\"2013-02-27\",\n      \"date_closed_timestamp\":\"1361992480\",\n      \"next_step\":\"\",\n      \"sales_stage\":\"Needs Analysis\",\n      \"sales_status\":\"New\",\n      \"probability\":\"90\",\n      \"best_case\":\"25000\",\n      \"worst_case\":\"25000\",\n      \"commit_stage\":\"include\",\n      \"my_favorite\":false,\n      \"_acl\":{\n         \"fields\":{\n         }\n      }\n   },\n   \"related_record\":{\n      \"id\":\"e689173e-c953-1e14-c215-512d0927e7a2\",\n      \"name\":\"Gus Dales\",\n      \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n      \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n      \"modified_user_id\":\"1\",\n      \"modified_by_name\":\"Administrator\",\n      \"created_by\":\"1\",\n      \"created_by_name\":\"Administrator\",\n      \"description\":\"\",\n      \"img\":\"\",\n      \"deleted\":false,\n      \"assigned_user_id\":\"seed_sally_id\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_POST/index.html"}
{"id": "dc56b6f98d0d-2", "text": "\"deleted\":false,\n      \"assigned_user_id\":\"seed_sally_id\",\n      \"assigned_user_name\":\"Sally Bronsen\",\n      \"team_name\":[\n         {\n            \"id\":\"West\",\n            \"name\":\"West\",\n            \"name_2\":\"\",\n            \"primary\":true\n         }\n      ],\n      \"salutation\":\"\",\n      \"first_name\":\"Gus\",\n      \"last_name\":\"Dales\",\n      \"full_name\":\"Gus Dales\",\n      \"title\":\"Director Operations\",\n      \"linkedin\":\"\",\n      \"facebook\":\"\",\n      \"twitter\":\"\",\n      \"googleplus\":\"\",\n      \"department\":\"\",\n      \"do_not_call\":false,\n      \"phone_home\":\"(661) 120-2292\",\n      \"email\":[\n         {\n            \"email_address\":\"section.sugar.section@example.it\",\n            \"opt_out\":\"1\",\n            \"invalid_email\":\"0\",\n            \"primary_address\":\"0\"\n         },\n         {\n            \"email_address\":\"support.qa.kid@example.co.uk\",\n            \"opt_out\":\"0\",\n            \"invalid_email\":\"0\",\n            \"primary_address\":\"1\"\n         }\n      ],\n      \"phone_mobile\":\"(294) 447-9707\",\n      \"phone_work\":\"(036) 840-3216\",\n      \"phone_other\":\"\",\n      \"phone_fax\":\"\",\n      \"email1\":\"support.qa.kid@example.co.uk\",\n      \"email2\":\"section.sugar.section@example.it\",\n      \"invalid_email\":false,\n      \"email_opt_out\":false,\n      \"primary_address_street\":\"48920 San Carlos Ave\",\n      \"primary_address_street_2\":\"\",\n      \"primary_address_street_3\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_POST/index.html"}
{"id": "dc56b6f98d0d-3", "text": "\"primary_address_street_2\":\"\",\n      \"primary_address_street_3\":\"\",\n      \"primary_address_city\":\"Persistance\",\n      \"primary_address_state\":\"CA\",\n      \"primary_address_postalcode\":\"54556\",\n      \"primary_address_country\":\"USA\",\n      \"alt_address_street\":\"\",\n      \"alt_address_street_2\":\"\",\n      \"alt_address_street_3\":\"\",\n      \"alt_address_city\":\"\",\n      \"alt_address_state\":\"\",\n      \"alt_address_postalcode\":\"\",\n      \"alt_address_country\":\"\",\n      \"assistant\":\"\",\n      \"assistant_phone\":\"\",\n      \"picture\":\"\",\n      \"email_and_name1\":\"\",\n      \"lead_source\":\"Support Portal User Registration\",\n      \"account_name\":\"Arts & Crafts Inc\",\n      \"account_id\":\"d43243c6-9b8e-2973-aee2-512d09bc34b4\",\n      \"opportunity_role_fields\":\"\",\n      \"opportunity_role_id\":\"\",\n      \"opportunity_role\":\"Technical Advisor\",\n      \"reports_to_id\":\"\",\n      \"report_to_name\":\"\",\n      \"portal_name\":\"GusDales145\",\n      \"portal_active\":true,\n      \"portal_password\":\"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0\",\n      \"portal_password1\":\"\",\n      \"portal_app\":\"\",\n      \"preferred_language\":\"en_us\",\n      \"campaign_id\":\"\",\n      \"campaign_name\":\"\",\n      \"c_accept_status_fields\":\"\",\n      \"m_accept_status_fields\":\"\",\n      \"accept_status_id\":\"\",\n      \"accept_status_name\":\"\",\n      \"sync_contact\":\"\",\n      \"my_favorite\":false,\n      \"_acl\":{\n         \"fields\":{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_POST/index.html"}
{"id": "dc56b6f98d0d-4", "text": "\"my_favorite\":false,\n      \"_acl\":{\n         \"fields\":{\n         }\n      }\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/link/:link_name/:remote_id POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_POST/index.html"}
{"id": "052f1b9b2a98-0", "text": "/Opportunities/:record PUT\nOverview\n    Update a record of the specified type.\nRequest Arguments\nName\nType\nDescription\nRequired\n            <record field>\n        \n            <record field type>\n        \n            The name value list of fields to populate.\n        \n            True\n        \nRequest\n{\n    \"name\":\"New Account Name\",\n    \"phone_office\":\"(555) 888-5555\",\n    \"website\":\"www.newsite.com\",\n    \"meetings\": {\n    {\n        \"add\": [\"21e3385e-404f-b470-407e-54044e3d8024\"],\n        \"delete\": [\"21e3385e-404f-b470-407e-54044e3d8023\"],\n        \"create\": [\n        {\n            \"name\": \"Test Meeting\"\n        }\n      ]\n    }\n}\nLink fields\n    It is possible to add or delete record relations to other records and create new related records.\nAction\nType\nDescription\nadd\n            List\n        \n            List of related records ID. See RelateRecordApi\n            for details.\n        \ndelete\n            List\n        \n            List of related records ID.\n        \ncreate\n            List\n        \n            List of name to value arrays of related records.\n        \nResponse Arguments\nName\nType\nDescription\n            <record field>\n        \n            <record field type>\n        \n            Returns the fields for the updated record.\n        \nResponse\n{\n   \"id\":\"f222265a-b755-da89-0bc7-512d09b800b6\",\n   \"name\":\"New Account Name\",\n   \"date_entered\":\"2013-02-26T19:12:00+00:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Opportunitiesrecord_PUT/index.html"}
{"id": "052f1b9b2a98-1", "text": "\"date_modified\":\"2013-02-27T22:49:00+00:00\",\n   \"modified_user_id\":\"1\",\n   \"modified_by_name\":\"Administrator\",\n   \"created_by\":\"1\",\n   \"created_by_name\":\"Administrator\",\n   \"description\":\"\",\n   \"img\":\"\",\n   \"last_activity_date\":\"2013-02-26T19:12:00+00:00\",\n   \"deleted\":false,\n   \"assigned_user_id\":\"seed_sarah_id\",\n   \"assigned_user_name\":\"Sarah Smith\",\n   \"team_name\":[\n      {\n         \"id\":1,\n         \"name\":\"Global\",\n         \"name_2\":\"\",\n         \"primary\":false\n      },\n      {\n         \"id\":\"West\",\n         \"name\":\"West\",\n         \"name_2\":\"\",\n         \"primary\":true\n      }\n   ],\n   \"linkedin\":\"\",\n   \"facebook\":\"\",\n   \"twitter\":\"\",\n   \"googleplus\":\"\",\n   \"account_type\":\"Customer\",\n   \"industry\":\"Hospitality\",\n   \"annual_revenue\":\"\",\n   \"phone_fax\":\"\",\n   \"billing_address_street\":\"9 IBM Path\",\n   \"billing_address_street_2\":\"\",\n   \"billing_address_street_3\":\"\",\n   \"billing_address_street_4\":\"\",\n   \"billing_address_city\":\"San Francisco\",\n   \"billing_address_state\":\"CA\",\n   \"billing_address_postalcode\":\"43635\",\n   \"billing_address_country\":\"USA\",\n   \"rating\":\"\",\n   \"phone_office\":\"(555) 888-5555\",\n   \"phone_alternate\":\"\",\n   \"website\":\"www.newsite.com\",\n   \"ownership\":\"\",\n   \"employees\":\"\",\n   \"ticker_symbol\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Opportunitiesrecord_PUT/index.html"}
{"id": "052f1b9b2a98-2", "text": "\"ownership\":\"\",\n   \"employees\":\"\",\n   \"ticker_symbol\":\"\",\n   \"shipping_address_street\":\"9 IBM Path\",\n   \"shipping_address_street_2\":\"\",\n   \"shipping_address_street_3\":\"\",\n   \"shipping_address_street_4\":\"\",\n   \"shipping_address_city\":\"San Francisco\",\n   \"shipping_address_state\":\"CA\",\n   \"shipping_address_postalcode\":\"43635\",\n   \"shipping_address_country\":\"USA\",\n   \"email1\":\"kid86@example.net\",\n   \"parent_id\":\"\",\n   \"sic_code\":\"\",\n   \"parent_name\":\"\",\n   \"email_opt_out\":false,\n   \"invalid_email\":false,\n   \"email\":[\n      {\n         \"email_address\":\"kid86@example.net\",\n         \"opt_out\":\"0\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"1\"\n      },\n      {\n         \"email_address\":\"the.dev@example.name\",\n         \"opt_out\":\"0\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"0\"\n      }\n   ],\n   \"campaign_id\":\"\",\n   \"campaign_name\":\"\",\n   \"my_favorite\":false,\n   \"_acl\":{\n      \"fields\":{\n      }\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Opportunitiesrecord_PUT/index.html"}
{"id": "a2b4ddbe627e-0", "text": "/<module>/favorites POST\nOverview\n    Opportunity Favorites Help\nSummary\n    This endpoint returns all the favorite Quotes/Revenue Line Items in alphabetical order to be displayed in the\n    \"Product Catalog Quick Picks\" dashlet.\nRequest Arguments\nName\nType\nDescription\nRequired\n            pageNum\n        \n            integer\n        \n            An integer attribute in the payload data object which gets the page number for which the items need to be\n            displayed based on the current page or the page clicked.\n        \n            False\n        \nRequest\n{\n    pageNum: 0\n}\nResponse Arguments\nName\nType\nDescription\n            <config field>\n        \n            <config field type>\n        \n            The list of config fields will be returned.\n        \nResponse\n{\n    \"totalPages\":5,\n    \"pageNum\":0,\n    \"max_num\":8,\n    \"records\":[\n                {\n                    \"id\":\"c181bd32-c7f2-11e8-b4eb-7831c1c14620\",\n                    \"name\":\"Allyson Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c18112d8-c7f2-11e8-b753-7831c1c14620\",\n                    \"mft_part_num\":\"Ink Conglomerate Inc 921535XYZ987\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html"}
{"id": "a2b4ddbe627e-1", "text": "\"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"534.000000\",\n                    \"discount_price\":\"842.000000\",\n                    \"list_price\":\"905.000000\",\n                    \"cost_usdollar\":\"534.000000\",\n                    \"discount_usdollar\":\"842.000000\",\n                    \"list_usdollar\":\"905.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"20.00\",\n                    \"qty_in_stock\":26,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"Fixed\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c18e0448-c7f2-11e8-86b0-7831c1c14620\",\n                    \"name\":\"Arla Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html"}
{"id": "a2b4ddbe627e-2", "text": "\"category_id\":\"c18b8b64-c7f2-11e8-8c1a-7831c1c14620\",\n                    \"mft_part_num\":\"24\\/7 Couriers 795391XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"398.000000\",\n                    \"discount_price\":\"402.020202\",\n                    \"list_price\":\"941.000000\",\n                    \"cost_usdollar\":\"398.000000\",\n                    \"discount_usdollar\":\"402.020202\",\n                    \"list_usdollar\":\"941.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"22.00\",\n                    \"qty_in_stock\":145,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"ProfitMargin\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c1b60434-c7f2-11e8-8964-7831c1c14620\",\n                    \"name\":\"Billie Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html"}
{"id": "a2b4ddbe627e-3", "text": "\"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c1b3bf58-c7f2-11e8-92e7-7831c1c14620\",\n                    \"mft_part_num\":\"Kringle Bell IncK.A. Tower \\u0026 Co 694143XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"403.000000\",\n                    \"discount_price\":\"927.000000\",\n                    \"list_price\":\"927.000000\",\n                    \"cost_usdollar\":\"403.000000\",\n                    \"discount_usdollar\":\"927.000000\",\n                    \"list_usdollar\":\"927.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"16.00\",\n                    \"qty_in_stock\":148,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"IsList\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c186a612-c7f2-11e8-9fee-7831c1c14620\",\n                    \"name\":\"Bradford Gadget\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html"}
{"id": "a2b4ddbe627e-4", "text": "\"name\":\"Bradford Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c185dbb0-c7f2-11e8-a6b7-7831c1c14620\",\n                    \"mft_part_num\":\"Mississippi Bank Group 133834XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"528.000000\",\n                    \"discount_price\":\"533.333333\",\n                    \"list_price\":\"745.000000\",\n                    \"cost_usdollar\":\"528.000000\",\n                    \"discount_usdollar\":\"533.333333\",\n                    \"list_usdollar\":\"745.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"33.00\",\n                    \"qty_in_stock\":70,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"ProfitMargin\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"base_rate\":\"1.000000\"\n                },\n                {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html"}
{"id": "a2b4ddbe627e-5", "text": "\"base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c1b4680e-c7f2-11e8-9380-7831c1c14620\",\n                    \"name\":\"Brain Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c1b3bf58-c7f2-11e8-92e7-7831c1c14620\",\n                    \"mft_part_num\":\"Smallville Resources Inc 362299XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"370.000000\",\n                    \"discount_price\":\"854.370000\",\n                    \"list_price\":\"863.000000\",\n                    \"cost_usdollar\":\"370.000000\",\n                    \"discount_usdollar\":\"854.370000\",\n                    \"list_usdollar\":\"863.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"10.00\",\n                    \"qty_in_stock\":106,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html"}
{"id": "a2b4ddbe627e-6", "text": "\"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"PercentageDiscount\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c1baf0e8-c7f2-11e8-ab05-7831c1c14620\",\n                    \"name\":\"Carley Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c1b8e4ec-c7f2-11e8-b435-7831c1c14620\",\n                    \"mft_part_num\":\"Hollywood Diner Ltd 10023XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"554.000000\",\n                    \"discount_price\":\"559.595960\",\n                    \"list_price\":\"927.000000\",\n                    \"cost_usdollar\":\"554.000000\",\n                    \"discount_usdollar\":\"559.595959\",\n                    \"list_usdollar\":\"927.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html"}
{"id": "a2b4ddbe627e-7", "text": "\"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"30.00\",\n                    \"qty_in_stock\":58,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"ProfitMargin\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c1b77544-c7f2-11e8-8347-7831c1c14620\",\n                    \"name\":\"Carma Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c1b3bf58-c7f2-11e8-92e7-7831c1c14620\",\n                    \"mft_part_num\":\"Sea Region Inc 773472XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"332.000000\",\n                    \"discount_price\":\"745.000000\",\n                    \"list_price\":\"822.000000\",\n                    \"cost_usdollar\":\"332.000000\",\n                    \"discount_usdollar\":\"745.000000\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html"}
{"id": "a2b4ddbe627e-8", "text": "\"discount_usdollar\":\"745.000000\",\n                    \"list_usdollar\":\"822.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"35.00\",\n                    \"qty_in_stock\":1,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"Fixed\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c1b98c9e-c7f2-11e8-9740-7831c1c14620\",\n                    \"name\":\"Catrina Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c1b8e4ec-c7f2-11e8-b435-7831c1c14620\",\n                    \"mft_part_num\":\"Jungle Systems Inc 273034XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"577.000000\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html"}
{"id": "a2b4ddbe627e-9", "text": "\"date_cost_price\":null,\n                    \"cost_price\":\"577.000000\",\n                    \"discount_price\":\"582.770000\",\n                    \"list_price\":\"946.000000\",\n                    \"cost_usdollar\":\"577.000000\",\n                    \"discount_usdollar\":\"582.770000\",\n                    \"list_usdollar\":\"946.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"13.00\",\n                    \"qty_in_stock\":105,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"PercentageMarkup\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"base_rate\":\"1.000000\"\n                }\n            ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Opportunities/favorites POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html"}
{"id": "c5166ebee5a1-0", "text": "/<module>/:record/movefirst/:target PUT\nOverview\n    Move existing node as first child of target node.\nRequest Arguments\nName\nType\nDescription\nRequired\n                module\n            \n                String\n            \n                The name of sugar module that contains a nested set data and implements the NestedSetInterface.\n            \n                True\n            \n                target\n            \n                String\n            \n                The ID of record that will be used as target to move node as first child\n            \n                True\n            \nResponse Arguments\n    This endpoint does not return any response arguments.\nResponse\nThis endpoint return a record GUID that was moved\n\"1b7b868d-7357-2e29-7513-54169bdc444d\"\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/movefirst/:target PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordmovefirsttarget_PUT/index.html"}
{"id": "bf43c88da13b-0", "text": "/EmbeddedFiles/:record/file/:field PUT\nOverview\n    This endpoint takes a file or image and saves it to a record that already contains an attachment in the specified field. The PUT method is very similar to the POST method but differs slightly in how the request is constructed. PUT requests should send the file data as the body of the request. Optionally, a filename query parameter can be sent with the request to assign a name. Additionally, the PUT \n    method can accept base64 encoded file data which will be decoded by the endpoint\n    if the content_transfer_encoding parameter is set to 'base64'.NOTE: In lieu of the content_transfer_encoding parameter, a\n    request header of X-Content-Transfer-Encoding can also be sent with a value\n    of 'base64'. In the event both the content transfer encoding header and request\n    parameter are sent, the header will be used.\nRequest Arguments\nName\nType\nDescription\nRequired\n            filename\n        \n            String\n        \n            Filename to save the document as\n        \n            False\n        \n            content_transfer_encoding\n        \n            String\n        \n            When set to 'base64', indicates the file contents are base64 encoded\n            and will result in the file contents being base64 decoded before being\n            saved\n        \n            False\n        \nRequest\nPUT /rest/v10/Notes/abcd-1234/file/field/ HTTP/1.1 Host: localhost Connection: keep-alive Content-Length: 23456 Content-Type: application/document-doc ...This is where the bin data would be\nResponse Arguments\nName\nType\nDescription\n            field\n        \n            Array\n        \n            The fields containing file properties.\n        \n            field.content-type\n        \n            String\n        \n            The files content type.\n        \n            field.content-length\n        \n            Integer\n        \n            The files content length.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmbeddedFilesrecordfilefield_PUT/index.html"}
{"id": "bf43c88da13b-1", "text": "Integer\n        \n            The files content length.\n        \n            field.name\n        \n            String\n        \n            The files name.\n        \n            field.width\n        \n            Integer\n        \n            The width of the image.\n        \n            field.height\n        \n            Integer\n        \n            The height of the image.\n        \n            field.uri\n        \n            String\n        \n            The URI of the file.\n        \nResponse\n{\n   \"picture\":{\n      \"content-type\":\"image\\/png\",\n      \"content-length\":72512,\n      \"name\":\"1a7b8f5c-b11c-0094-c8d8-512e9daaa983\",\n      \"width\":933,\n      \"height\":519,\n      \"uri\":\"http:\\/\\/sugarcrm\\/rest\\/v10\\/Contacts\\/fa300a0e-0ad1-b322-9601-512d0983c19a\\/file\\/picture\"\n   }\n    \"attachment\":{\n        \"content-type\":\"application/document-doc\",\n        \"content-length\":\"873921\",\n        \"name\":\"myFile.doc\",\n        \"uri\": \"http:\\/\\/sugarcrm\\/rest\\/v10\\/Contacts\\/f2f9aa4d-99a8-e86e-f4d5-512d0986effa\\/file\\/attachment\"\n    }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/file/:field PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmbeddedFilesrecordfilefield_PUT/index.html"}
{"id": "5aa1040c57da-0", "text": "/pmse_Project/CrmData/:record/:filter PUT\nOverview\n    Updates information about Fields, Modules, Users, Roles, etc.\nSummary\n    This endpoint will update various data related to the Process Definition\n    with the data provided in the request payload.\nRequest Arguments\nName\nType\nDescription\nRequired\nrecord\nString\nThe type of data to be updated\nTrue\nfilter\nString\nFiltering criteria to be applied to data updated\nFalse\nRequest\n/rest/v11/pmse_Project/CrmData/clearEventCriteria/383414365573cf64b8eaa65039872849\nRequest Payload\n{\n    \"data\":null\n}\nResponse Arguments\nName\nType\nDescription\nsuccess\nBoolean\nThe status of the update operation\nResponse\n{\n    \"success\":true\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectCrmDatarecordfilter_PUT/index.html"}
{"id": "032c28350b74-0", "text": "/Quotes/:record/opportunity POST\nOverview\n    Quote Convert to Opportunity\nSummary\n    This endpoint converts a Quote to an Opportunity.\nRequest Arguments\nNONE\nResponse Arguments\nNONE\nResponse\nCreated Opportunity:\n{\n    \"record\": {\n        \"id\": \"31a601ee-2d3f-11e8-bfae-024289eecda3\",\n        \"name\": \"Mirrors for J.K.M. Corp (HA)\",\n        \"date_entered\": \"2018-03-21T19:36:47+00:00\",\n        \"date_modified\": \"2018-03-21T19:36:47+00:00\",\n        \"modified_user_id\": \"1\",\n        \"modified_by_name\": \"admin\",\n        \"modified_user_link\": {\n            \"full_name\": \"admin\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": {\n                    \"pwd_last_changed\": {\n                        \"write\": \"no\",\n                        \"create\": \"no\"\n                    },\n                    \"last_login\": {\n                        \"write\": \"no\",\n                        \"create\": \"no\"\n                    }\n                },\n                \"delete\": \"no\",\n                \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n            }\n        },\n        \"created_by\": \"1\",\n        \"created_by_name\": \"\",\n        \"created_by_link\": {\n            \"full_name\": \"\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": {\n                    \"pwd_last_changed\": {\n                        \"write\": \"no\",\n                        \"create\": \"no\"\n                    },\n                    \"last_login\": {\n                        \"write\": \"no\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html"}
{"id": "032c28350b74-1", "text": "},\n                    \"last_login\": {\n                        \"write\": \"no\",\n                        \"create\": \"no\"\n                    }\n                },\n                \"delete\": \"no\",\n                \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n            }\n        },\n        \"deleted\": false,\n        \"opportunity_type\": \"New Business\",\n        \"account_name\": \"\",\n        \"accounts\": {\n            \"name\": \"\",\n            \"id\": \"0029279c-2d3d-11e8-a121-024289eecda3\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"account_id\": \"0029279c-2d3d-11e8-a121-024289eecda3\",\n        \"campaign_name\": \"\",\n        \"campaign_opportunities\": {\n            \"name\": \"\",\n            \"id\": null,\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"amount\": \"520.000000\",\n        \"amount_usdollar\": \"520.000000\",\n        \"date_closed\": \"2012-04-30\",\n        \"date_closed_timestamp\": 1335744000,\n        \"sales_stage\": \"Prospecting\",\n        \"sales_status\": \"In Progress\",\n        \"probability\": 10,\n        \"best_case\": \"520.000000\",\n        \"worst_case\": \"520.000000\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html"}
{"id": "032c28350b74-2", "text": "\"worst_case\": \"520.000000\",\n        \"commit_stage\": \"exclude\",\n        \"total_revenue_line_items\": 1,\n        \"closed_revenue_line_items\": 0,\n        \"included_revenue_line_items\": 0,\n        \"mkto_sync\": false,\n        \"assigned_user_id\": \"seed_max_id\",\n        \"assigned_user_name\": \"Max Jensen\",\n        \"assigned_user_link\": {\n            \"full_name\": \"Max Jensen\",\n            \"id\": \"seed_max_id\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"team_id\": \"1\",\n        \"team_set_id\": \"1\",\n        \"acl_team_set_id\": \"f846e71c-2d3c-11e8-a9e4-024289eecda3\",\n        \"team_count\": \"\",\n        \"team_count_link\": {\n            \"team_count\": \"\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"currency_id\": \"-99\",\n        \"base_rate\": \"1.000000\",\n        \"currency_name\": \"\",\n        \"currencies\": {\n            \"name\": \"\",\n            \"id\": \"-99\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            },\n            \"symbol\": \"\"\n        },\n        \"currency_symbol\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html"}
{"id": "032c28350b74-3", "text": "},\n            \"symbol\": \"\"\n        },\n        \"currency_symbol\": \"\",\n        \"my_favorite\": false,\n        \"_acl\": {\n            \"fields\": {}\n        },\n        \"_module\": \"Opportunities\"\n    },\n    \"related_record\": {\n        \"id\": \"23d19cec-2d3d-11e8-b4bf-024289eecda3\",\n        \"name\": \"Mirrors for J.K.M. Corp (HA)\",\n        \"date_entered\": \"2018-03-21T19:20:19+00:00\",\n        \"date_modified\": \"2018-03-21T19:36:47+00:00\",\n        \"modified_user_id\": \"1\",\n        \"modified_by_name\": \"admin\",\n        \"modified_user_link\": {\n            \"full_name\": \"admin\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": {\n                    \"pwd_last_changed\": {\n                        \"write\": \"no\",\n                        \"create\": \"no\"\n                    },\n                    \"last_login\": {\n                        \"write\": \"no\",\n                        \"create\": \"no\"\n                    }\n                },\n                \"delete\": \"no\",\n                \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n            }\n        },\n        \"created_by\": \"1\",\n        \"created_by_name\": \"Administrator\",\n        \"created_by_link\": {\n            \"full_name\": \"Administrator\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": {\n                    \"pwd_last_changed\": {\n                        \"write\": \"no\",\n                        \"create\": \"no\"\n                    },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html"}
{"id": "032c28350b74-4", "text": "\"write\": \"no\",\n                        \"create\": \"no\"\n                    },\n                    \"last_login\": {\n                        \"write\": \"no\",\n                        \"create\": \"no\"\n                    }\n                },\n                \"delete\": \"no\",\n                \"_hash\": \"08b99a97c2e8d792f7a44d8882b5af6d\"\n            }\n        },\n        \"description\": \"\",\n        \"deleted\": false,\n        \"shipper_id\": \"\",\n        \"shipper_name\": \"\",\n        \"shippers\": {\n            \"name\": \"\",\n            \"id\": \"\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"taxrate_id\": \"2254f224-2d3d-11e8-925e-024289eecda3\",\n        \"taxrate_name\": \"8.25 - Cupertino, CA\",\n        \"taxrates\": {\n            \"name\": \"8.25 - Cupertino, CA\",\n            \"id\": \"2254f224-2d3d-11e8-925e-024289eecda3\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"taxrate_value\": \"8.250000\",\n        \"show_line_nums\": true,\n        \"quote_type\": \"Quotes\",\n        \"date_quote_expected_closed\": \"2012-04-30\",\n        \"original_po_date\": \"\",\n        \"payment_terms\": \"Net 15\",\n        \"date_quote_closed\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html"}
{"id": "032c28350b74-5", "text": "\"payment_terms\": \"Net 15\",\n        \"date_quote_closed\": \"\",\n        \"date_order_shipped\": \"\",\n        \"order_stage\": \"\",\n        \"quote_stage\": \"Negotiation\",\n        \"purchase_order_num\": \"3940021\",\n        \"quote_num\": 2,\n        \"subtotal\": \"520.000000\",\n        \"subtotal_usdollar\": \"520.000000\",\n        \"shipping\": \"0.000000\",\n        \"shipping_usdollar\": \"0.000000\",\n        \"discount\": \"\",\n        \"deal_tot\": \"0.000000\",\n        \"deal_tot_discount_percentage\": 0,\n        \"deal_tot_usdollar\": \"0.000000\",\n        \"new_sub\": \"520.000000\",\n        \"new_sub_usdollar\": \"520.000000\",\n        \"taxable_subtotal\": \"520.000000\",\n        \"tax\": \"42.900000\",\n        \"tax_usdollar\": \"42.900000\",\n        \"total\": \"562.900000\",\n        \"total_usdollar\": \"562.900000\",\n        \"billing_address_street\": \"111 Silicon Valley Road\",\n        \"billing_address_city\": \"Kansas City\",\n        \"billing_address_state\": \"CA\",\n        \"billing_address_postalcode\": \"47108\",\n        \"billing_address_country\": \"USA\",\n        \"shipping_address_street\": \"111 Silicon Valley Road\",\n        \"shipping_address_city\": \"Kansas City\",\n        \"shipping_address_state\": \"CA\",\n        \"shipping_address_postalcode\": \"47108\",\n        \"shipping_address_country\": \"USA\",\n        \"shipping_account_name\": \"\",\n        \"shipping_accounts\": {\n            \"name\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html"}
{"id": "032c28350b74-6", "text": "\"shipping_accounts\": {\n            \"name\": \"\",\n            \"id\": \"0029279c-2d3d-11e8-a121-024289eecda3\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"shipping_account_id\": \"\",\n        \"shipping_contact_name\": \"\",\n        \"shipping_contacts\": {\n            \"full_name\": \"\",\n            \"id\": \"\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"shipping_contact_id\": \"\",\n        \"account_name\": \"J.K.M. Corp (HA)\",\n        \"billing_accounts\": {\n            \"name\": \"J.K.M. Corp (HA)\",\n            \"id\": \"0029279c-2d3d-11e8-a121-024289eecda3\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"account_id\": \"0029279c-2d3d-11e8-a121-024289eecda3\",\n        \"billing_account_name\": \"J.K.M. Corp (HA)\",\n        \"billing_account_id\": \"0029279c-2d3d-11e8-a121-024289eecda3\",\n        \"billing_contact_name\": \"\",\n        \"billing_contacts\": {\n            \"full_name\": \"\",\n            \"id\": \"\",\n            \"_acl\": {\n                \"fields\": [],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html"}
{"id": "032c28350b74-7", "text": "\"id\": \"\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"billing_contact_id\": \"\",\n        \"opportunity_name\": \"\",\n        \"opportunities\": {\n            \"name\": \"\",\n            \"id\": \"23d19cec-2d3d-11e8-b4bf-024289eecda3\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"opportunity_id\": \"\",\n        \"following\": \"\",\n        \"my_favorite\": false,\n        \"tag\": [],\n        \"locked_fields\": [],\n        \"assigned_user_id\": \"seed_max_id\",\n        \"assigned_user_name\": \"Max Jensen\",\n        \"assigned_user_link\": {\n            \"full_name\": \"Max Jensen\",\n            \"id\": \"seed_max_id\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"team_count\": \"\",\n        \"team_count_link\": {\n            \"team_count\": \"\",\n            \"id\": \"1\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            }\n        },\n        \"team_name\": [{\n            \"id\": \"1\",\n            \"name\": \"Global\",\n            \"name_2\": \"\",\n            \"primary\": true,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html"}
{"id": "032c28350b74-8", "text": "\"name_2\": \"\",\n            \"primary\": true,\n            \"selected\": false\n        }],\n        \"currency_id\": \"-99\",\n        \"base_rate\": \"1.000000\",\n        \"currency_name\": \"\",\n        \"currencies\": {\n            \"name\": \"\",\n            \"id\": \"-99\",\n            \"_acl\": {\n                \"fields\": [],\n                \"_hash\": \"654d337e0e912edaa00dbb0fb3dc3c17\"\n            },\n            \"symbol\": \"\"\n        },\n        \"currency_symbol\": \"\",\n        \"_acl\": {\n            \"fields\": {}\n        },\n        \"_module\": \"Quotes\"\n    }\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html"}
{"id": "35758aceb33f-0", "text": "/KBContents/config POST\nCreates and/or updates the config settings for the KBContents module\nSummary:\n    This endpoint is used to create and/or update the config settings for the KBContents module as json data.\n    It extends the core config endpoint by adding the functionality to process deleted languages and documents\n    related to them.\nQuery Parameters:\nParam\nDescription\nOptional\nInput Example:\n    {\n        \"languages\":[{\n            \"en\":\"English\",\n            \"primary\":true\n        },{\n            \"de\":\"German\",\n            \"primary\":false\n        }],\n        \"category_root\":\"31696245-0438-ff7a-9144-544f8c659daf\",\n        \"deleted_languages\":[\"es\",\"ru\"]\n    }\n    \nOutput Example:\n    {\n        \"languages\":[{\n            \"en\":\"English\",\n            \"primary\":true\n        },{\n            \"de\":\"German\",\n            \"primary\":false\n        }],\n        \"category_root\":\"31696245-0438-ff7a-9144-544f8c659daf\",\n        \"deleted_languages\":[\"es\",\"ru\"]\n    }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsconfig_POST/index.html"}
{"id": "40838991658c-0", "text": "/Administration/packages/staged GET\nOverview\n[ADMIN] PackageManager lists staged packages.\nSummary\nLists staged packages in the system.\nResponse\n{\n    \"packages\": [\n        {\n            \"name\": \"project_P1\",\n            \"version\": 1580885419,\n            \"published_date\": \"2020-02-05 06:50:19\",\n            \"description\": \"None\",\n            \"uninstallable\": \"Yes\",\n            \"type\": \"Module\",\n            \"file\": \"0ef4dd8b237f4358bdb246a744eb2b38\",\n            \"file_install\": \"5d4b4614421586fd2111714abf622392\",\n            \"unFile\": \"5d4b4614421586fd2111714abf622392\"\n        }\n    ]\n}\nChange Log\nVersion\nChange\nv11.8\nAdded /Administration/packages/staged\u00c2\u00a0GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationpackagesstaged_GET/index.html"}
{"id": "d9eb6fc455b1-0", "text": "/ping/whattimeisit GET\nOverview\n    Responds with the current time in server format.\nRequest Arguments\n    This endpoint does not accept any arguments.\nResponse Arguments\nName\nType\nDescription\n            <server time>\n        \n            String\n        \n            Returns the servers time.\n        \nResponse\n<time>\nChange Log\nVersion\nChange\n            v10\n        \n            Added /ping/whattimeisit GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pingwhattimeisit_GET/index.html"}
{"id": "a3262e46f0ec-0", "text": "/<module>/sync_key/:sync_key_field_value PUT\nOverview\nUpserts based on sync_key. If a record can be found with sync_key, then update. If the record does not exist, then create it.\u00c2\u00a0Note that the PATCH method is recommended over the PUT method.\nNote:\u00c2\u00a0This endpoint cannot be used to set the sync_key for an existing Sugar record. To do so, it is recommended to use the set sync key endpoint to update the matching Sugar record ID. Once the sync_key is set for the record, then it is possible to leverage this endpoint.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule\nString\nThe module the record belongs to\nTrue\nsync_key_field_value\nString\nA unique ID for the record identifying it in an external system\nTrue\nRequest\n/<module>/sync_key/:sync_key_field_value\nResponse Arguments\nName\nType\nDescription\nrecord\nString\nThe ID of the record that was upserted.\nResponse\nStatus 201: For a created record\nStatus 200: For an updated record\n{    record: \"a0328573-a252-a27c-3530-4e4297d4c9e1\"} \nChange Log\nVersion\nChange\nv11_10\nAdded /<module>/sync_key/:sync_key_field_value\u00c2\u00a0PUT endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulesync_keysync_key_field_value_PUT/index.html"}
{"id": "0a6b4e33bee3-0", "text": "/<module>/favorites GET\nOverview\n    Opportunity Favorites Help\nSummary\n    This endpoint returns all the favorite Quotes/Revenue Line Items in alphabetical order to be displayed in the\n    \"Product Catalog Quick Picks\" dashlet.\nRequest Arguments\nName\nType\nDescription\nRequired\n            pageNum\n        \n            integer\n        \n            An integer attribute in the payload data object which gets the page number for which the items need to be\n            displayed based on the current page or the page clicked.\n        \n            False\n        \nRequest\n{\n    pageNum: 0\n}\nResponse Arguments\nName\nType\nDescription\n            <config field>\n        \n            <config field type>\n        \n            The list of config fields will be returned.\n        \nResponse\n{\n    \"totalPages\":5,\n    \"pageNum\":0,\n    \"max_num\":8,\n    \"records\":[\n                {\n                    \"id\":\"c181bd32-c7f2-11e8-b4eb-7831c1c14620\",\n                    \"name\":\"Allyson Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c18112d8-c7f2-11e8-b753-7831c1c14620\",\n                    \"mft_part_num\":\"Ink Conglomerate Inc 921535XYZ987\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html"}
{"id": "0a6b4e33bee3-1", "text": "\"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"534.000000\",\n                    \"discount_price\":\"842.000000\",\n                    \"list_price\":\"905.000000\",\n                    \"cost_usdollar\":\"534.000000\",\n                    \"discount_usdollar\":\"842.000000\",\n                    \"list_usdollar\":\"905.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"20.00\",\n                    \"qty_in_stock\":26,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"Fixed\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c18e0448-c7f2-11e8-86b0-7831c1c14620\",\n                    \"name\":\"Arla Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html"}
{"id": "0a6b4e33bee3-2", "text": "\"category_id\":\"c18b8b64-c7f2-11e8-8c1a-7831c1c14620\",\n                    \"mft_part_num\":\"24\\/7 Couriers 795391XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"398.000000\",\n                    \"discount_price\":\"402.020202\",\n                    \"list_price\":\"941.000000\",\n                    \"cost_usdollar\":\"398.000000\",\n                    \"discount_usdollar\":\"402.020202\",\n                    \"list_usdollar\":\"941.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"22.00\",\n                    \"qty_in_stock\":145,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"ProfitMargin\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c1b60434-c7f2-11e8-8964-7831c1c14620\",\n                    \"name\":\"Billie Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html"}
{"id": "0a6b4e33bee3-3", "text": "\"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c1b3bf58-c7f2-11e8-92e7-7831c1c14620\",\n                    \"mft_part_num\":\"Kringle Bell IncK.A. Tower \\u0026 Co 694143XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"403.000000\",\n                    \"discount_price\":\"927.000000\",\n                    \"list_price\":\"927.000000\",\n                    \"cost_usdollar\":\"403.000000\",\n                    \"discount_usdollar\":\"927.000000\",\n                    \"list_usdollar\":\"927.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"16.00\",\n                    \"qty_in_stock\":148,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"IsList\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c186a612-c7f2-11e8-9fee-7831c1c14620\",\n                    \"name\":\"Bradford Gadget\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html"}
{"id": "0a6b4e33bee3-4", "text": "\"name\":\"Bradford Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c185dbb0-c7f2-11e8-a6b7-7831c1c14620\",\n                    \"mft_part_num\":\"Mississippi Bank Group 133834XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"528.000000\",\n                    \"discount_price\":\"533.333333\",\n                    \"list_price\":\"745.000000\",\n                    \"cost_usdollar\":\"528.000000\",\n                    \"discount_usdollar\":\"533.333333\",\n                    \"list_usdollar\":\"745.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"33.00\",\n                    \"qty_in_stock\":70,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"ProfitMargin\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"base_rate\":\"1.000000\"\n                },\n                {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html"}
{"id": "0a6b4e33bee3-5", "text": "\"base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c1b4680e-c7f2-11e8-9380-7831c1c14620\",\n                    \"name\":\"Brain Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c1b3bf58-c7f2-11e8-92e7-7831c1c14620\",\n                    \"mft_part_num\":\"Smallville Resources Inc 362299XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"370.000000\",\n                    \"discount_price\":\"854.370000\",\n                    \"list_price\":\"863.000000\",\n                    \"cost_usdollar\":\"370.000000\",\n                    \"discount_usdollar\":\"854.370000\",\n                    \"list_usdollar\":\"863.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"10.00\",\n                    \"qty_in_stock\":106,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html"}
{"id": "0a6b4e33bee3-6", "text": "\"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"PercentageDiscount\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c1baf0e8-c7f2-11e8-ab05-7831c1c14620\",\n                    \"name\":\"Carley Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c1b8e4ec-c7f2-11e8-b435-7831c1c14620\",\n                    \"mft_part_num\":\"Hollywood Diner Ltd 10023XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"554.000000\",\n                    \"discount_price\":\"559.595960\",\n                    \"list_price\":\"927.000000\",\n                    \"cost_usdollar\":\"554.000000\",\n                    \"discount_usdollar\":\"559.595959\",\n                    \"list_usdollar\":\"927.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html"}
{"id": "0a6b4e33bee3-7", "text": "\"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"30.00\",\n                    \"qty_in_stock\":58,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"ProfitMargin\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c1b77544-c7f2-11e8-8347-7831c1c14620\",\n                    \"name\":\"Carma Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c1b3bf58-c7f2-11e8-92e7-7831c1c14620\",\n                    \"mft_part_num\":\"Sea Region Inc 773472XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"332.000000\",\n                    \"discount_price\":\"745.000000\",\n                    \"list_price\":\"822.000000\",\n                    \"cost_usdollar\":\"332.000000\",\n                    \"discount_usdollar\":\"745.000000\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html"}
{"id": "0a6b4e33bee3-8", "text": "\"discount_usdollar\":\"745.000000\",\n                    \"list_usdollar\":\"822.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"35.00\",\n                    \"qty_in_stock\":1,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"Fixed\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c1b98c9e-c7f2-11e8-9740-7831c1c14620\",\n                    \"name\":\"Catrina Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c1b8e4ec-c7f2-11e8-b435-7831c1c14620\",\n                    \"mft_part_num\":\"Jungle Systems Inc 273034XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"577.000000\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html"}
{"id": "0a6b4e33bee3-9", "text": "\"date_cost_price\":null,\n                    \"cost_price\":\"577.000000\",\n                    \"discount_price\":\"582.770000\",\n                    \"list_price\":\"946.000000\",\n                    \"cost_usdollar\":\"577.000000\",\n                    \"discount_usdollar\":\"582.770000\",\n                    \"list_usdollar\":\"946.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"13.00\",\n                    \"qty_in_stock\":105,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"PercentageMarkup\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"base_rate\":\"1.000000\"\n                }\n            ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Opportunities/favorites GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html"}
{"id": "264f2547cae5-0", "text": "/Genericsearch POST\nOverview\nGeneric search.\nSummary\nThis endpoint searches the content of the given modules using the provider specified by the \"generic_search\" configuration variable. If the variable is absent, the default provider is \"Elastic\".\nRequest Arguments\nName\nType\nDescription\nRequired\nq\nString\nThe search expression.\nTrue\nmodule_list\nString\nComma-delimited list of modules to search. If omitted, all search enabled modules will be queried. Example: KBDocuments,Bugs\nFalse\nmax_num\nInteger\nA maximum number of records to return. Default is 20.\nFalse\noffset\nInteger\nThe number of records to skip over before records are returned. Default is 0.\nFalse\nResponse Arguments\nName\nType\nDescription\nnext_offset\nInteger\nDisplays the next offset for retrieval of additional results. -1 will be returned when there are no more records.\ntotal\nInteger\nThe number of records found.\nrecords\nArray\nAn array of results containing matched records.\nResponse\n{\n    \"next_offset\": -1,\n    \"total\": 1,\n    \"records\": [\n        {\n            \"name\": \"Connecting to the Internet\",\n            \"description\": \"To connect your device to the Internet, use any application that accesses the Internet. You can connect using either Wi-Fi or Bluetooth.\",\n            \"url\": \"portal/index.html#KBContents/60142236-bad3-11e9-9d32-3c15c2d57622\" (for portal)\n            \"url\": \"#KBContents/60142236-bad3-11e9-9d32-3c15c2d57622\" (for base)\n        }\n    ]\n}\nChange Log\nVersion\nChange\nv11_9\nAdded /Genericsearch\u00c2\u00a0POST endpoint.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Genericsearch_POST/index.html"}
{"id": "264f2547cae5-1", "text": "Version\nChange\nv11_9\nAdded /Genericsearch\u00c2\u00a0POST endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Genericsearch_POST/index.html"}
{"id": "00714ac949d4-0", "text": "/PdfManager/generate GET\nOverview\n    PdfManager Generate Endpoint Help\nSummary\n    This endpoint returns and initiates download of a PDF.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule\nString\nThe Module name of the Bean from which to create a PDF\nTrue\nrecord\nString\nThe Record ID from which to create a PDF\nTrue\npdf_template_id\nString\nThe PDF Template ID to use to create the PDF\nTrue\nsugarpdf\nString\nThe type of PDF to use. Defaults to 'pdfmanager'.\nFalse\nRequest\n{\n   \"module\": \"Quotes\",\n   \"record\": \"abcde-fghij-12345-67890\",\n   \"pdf_template_id\": \"12345-67890-abcde-fghij\",\n   \"sugarpdf\": \"pdfmanager\"\n}\nResponse\n    The response is a base64 encoded string of the contents of the PDF file.\nChange Log\nVersion\nChange\nv11.3\nAdded /PdfManager/generate GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/PdfManagergenerate_GET/index.html"}
{"id": "d447436dc3f0-0", "text": "/Dashboards/Activities GET\nOverview\n    List current user's filtered Activity Stream dashboards.\nSummary\n    This endpoint will return a set of Activity Stream dashboards filtered by an expression. The filter can be applied\n    to multiple fields and have multiple and/or conditions in it. Alternatively, you may use an existing filter by\n    specifying its id. If both a filter definition and a filter id are passed, the two filters will be joined with an\n    AND. Care will need to be taken to make sure that any filters used have appropriate indexes on the\n    server side otherwise the runtime of the endpoint will be very long.\nNotice\nThe behavior of this endpoint has changed in v11. If you continue to use v10 of the API, your\n    REST calls should behave as below. But, it is advisable to upgrade to v11.Migrating to v11:\n    For more information on behavior in v11, refer to GET /<module>.\n    \n    Recommended Replacement:\nGET /Dashboards\n    The module name is no longer part of the path. To specify a module name, include it as a filter\n    parameter, usev11: \nGET /Dashboards?filter[0][dashboard_module]=Activities\n    name, id. etc. are no longer specified as default fields. To retain the default fields, usev11: \n        GET /Dashboards?filter[0][dashboard_module]=Activities&fields=id,name,view_name\n    \nRequest Arguments\nName\nType\nDescription\nRequired\nfilter\nString\nSee Filter API.\nFalse\nfilter_id\nString\n            Identifier for a preexisting filter. See \n            the Filter API for details.\n        \nFalse\nmax_num\nInteger\n            Max number of records that can be returned. Default is 20, unless overruled by your Sugar configuration.\n        \nFalse\noffset\nInteger", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/DashboardsActivities_GET/index.html"}
{"id": "d447436dc3f0-1", "text": "False\noffset\nInteger\nThe number of records to skip over before records are returned. Default is 0.\nFalse\nfields\nString\n            Comma delimited list of fields to return. Each field may be represented either by string, or by map\n            containing field name and additional field parameters (applicable to link and collection fields).\n            The fields id and date_modified will always be returned.\n            For more details on additional field parameters, see\n            Relate API and\n            Collection API.\n        \nFalse\norder_by\nString\nSee Filter API.\nFalse\ndeleted\nBoolean\nBoolean to show deleted records in the result set.\nFalse\nResponse Arguments\nName\nType\nDescription\nnext_offset\nInteger\n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \nrecords\nArray\nAn array of results containing matched records.\nResponse\n{\n  \"next_offset\": -1,\n  \"records\": [\n    {\n      \"id\": \"d509b3da-29f6-7b23-7cce-56fab1a6335b\",\n      \"name\": \"Activity Stream Dashboard\",\n      \"date_modified\": \"2016-03-29T09:46:00-07:00\",\n      \"view_name\": \"activities\",\n      \"_acl\": {\n        \"fields\": {}\n      },\n      \"view\": \"activities\",\n      \"_module\": \"Dashboards\"\n    },\n    {\n      \"id\": \"cc4982cd-0bdf-bad4-d079-56fab4bdddf1\",\n      \"name\": \"Activity Stream Dashboard 2\",\n      \"date_modified\": \"2016-03-29T09:57:58-07:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/DashboardsActivities_GET/index.html"}
{"id": "d447436dc3f0-2", "text": "\"view_name\": \"activities\",\n      \"_acl\": {\n        \"fields\": {}\n      },\n      \"view\": \"activities\",\n      \"_module\": \"Dashboards\"\n    }\n  ]\n}\nChange Log\nVersion\nChange\nv11\nNo longer supported. Please use GET /Dashboards instead.\nv10\nAdded /Dashboards/Activities GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/DashboardsActivities_GET/index.html"}
{"id": "8e66aa420c46-0", "text": "/Dashboards POST\n    Create a new Home dashboard.\nNotice\nThe behavior of this endpoint has changed in v11. For a description of behavior in v11, refer to\n    POST /<module>. If you continue to use v10 of the API,\n    your REST calls should behave as below. But, it is advisable to upgrade to v11.Migrating to v11:\n    Recommended Replacement: POST /Dashboards\n    The Home module is no longer the default dashboard_module. To specify the Home\n    module, include it in the Request Body.v11: POST /Dashboards with the following in the Request Body:\n{\"dashboard_module\":\"Home\"}\nRequest Arguments\nName\nType\nDescription\nRequired\n<record field>\n<record field type>\nThe name value list of fields to populate.\nTrue\nRequest\n{\n    \"name\": \"New Home Dashboard\",\n    \"dashboard_module\": \"Home\",\n    \"view_name\": \"\",\n    \"metadata\": {\n        \"components\": [{\n            \"rows\": [[{\n                \"width\": 12,\n                \"view\": {\n                    \"limit\": 10,\n                    \"visibility\": \"user\",\n                    \"label\": \"Active Tasks\",\n                    \"type\": \"active-tasks\",\n                    \"module\": null,\n                    \"template\": \"tabbed-dashlet\"\n                }\n            }]],\n            \"width\": 12\n        }]\n    }\n}\nResponse Arguments\nName\nType\nDescription\n<record field>\n<record field type>\nReturns the fields for the newly created dashboard.\nResponse\n{\n  \"id\": \"4ccda6fa-fa02-9c8e-215f-56cf72f98fcb\",\n  \"name\": \"New Home Dashboard\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboards_POST/index.html"}
{"id": "8e66aa420c46-1", "text": "\"name\": \"New Home Dashboard\",\n  \"date_entered\": \"2016-02-25T13:30:51-08:00\",\n  \"date_modified\": \"2016-02-25T13:30:51-08:00\",\n  \"modified_user_id\": \"1\",\n  \"modified_by_name\": \"Administrator\",\n  \"created_by\": \"1\",\n  \"created_by_name\": \"Administrator\",\n  \"description\": \"\",\n  \"deleted\": false,\n  \"dashboard_module\": \"Home\",\n  \"view_name\": \"\",\n  \"metadata\": {\n    \"components\": [\n      {\n        \"rows\": [\n          [\n            {\n              \"width\": 12,\n              \"view\": {\n                \"limit\": 10,\n                \"visibility\": \"user\",\n                \"label\": \"Active Tasks\",\n                \"type\": \"active-tasks\",\n                \"module\": null,\n                \"template\": \"tabbed-dashlet\"\n              }\n            }\n          ]\n        ],\n        \"width\": 12\n      }\n    ]\n  },\n  \"following\": \"\",\n  \"my_favorite\": false,\n  \"tag\": [],\n  \"assigned_user_id\": \"1\",\n  \"assigned_user_name\": \"Administrator\",\n  \"_acl\": {\n    \"fields\": {}\n  },\n  \"view\": \"\",\n  \"_module\": \"Dashboards\"\n}\nChange Log\nVersion\nChange\nv11\n            Behavior has changed. Please see POST /Dashboards\n            for the designated replacement.\n        \nv10\nAdded /Dashboards POST endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboards_POST/index.html"}
{"id": "854bd2177966-0", "text": "/Administration/packages/:id/disable GET\nOverview\n[ADMIN] PackageManager disable a package.\nSummary\nDisable the specified package. Package id hash must be provided. Package id could be found in installed package list.\nResponse\nReturns http status 200 OK and disabled package ID if request is successful.\n{\n\"id\": \"56365210-4cce-11ea-a7bf-acde48001122\"\n}\nOtherwise returns http status 4xx with errors.\n{\n\"error\": \"not_found\",\n\"error_message\": \"Could not find package by ID.\"\n}\nChange Log\nVersion\nChange\nv11.8\nAdded /Administration/packages/:id/disable\u00c2\u00a0GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationpackagesiddisable_GET/index.html"}
{"id": "f7916d36721b-0", "text": "/Leads/:leadId/convert POST\nConvert Lead to a Contact and optionally link it to a new or existing instance of the modules specified\nSummary:\n    This endpoint is used to convert the specified Lead to a Contact and optionally link that Contact to a new or existing instance of the modules specified.\n    The types of modules that can be specified are limited to those that have been configured by the system administrator.\nPost Parameters:\nParameter\nDescription \nmodules (required)\nAn object containing the Contacts module to be created as part of the conversion, along with (optionally)\n                any modules that this new Contact record is to be related to. If relate-to modules are also specified, they must\n                consist of a valid module type and either the id of a existing module of that type, or if new, the full record\n                to be created for that type.  Note that the allowed module types are defined by the System Administrator.\n            \n\u00c2\u00a0Example\n    {\n        \"modules\": {\n            \"Contacts\": {\n                \"deleted\": \"0\",\n                \"do_not_call\": false,\n                \"portal_active\": \"0\",\n                \"preferred_language\": \"en_us\",\n                \"assigned_user_id\": \"1\",\n                \"assigned_user_name\": \"Administrator\",\n                \"salutation\": \"\",\n                \"first_name\": \"Darius\",\n                \"last_name\": \"Paisley\",\n                \"title\": \"Director Operations\",\n                \"department\": \"\",\n                \"description\": \"\",\n                \"team_name\": [\n                    {\n                        \"id\": \"East\",\n                        \"name\": \"East\",\n                        \"name_2\": \"\",\n                        \"primary\": true\n                    },\n                    {\n                        \"id\": 1,\n                        \"name\": \"Global\",\n                        \"name_2\": \"\",\n                        \"primary\": false", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/LeadsleadIdconvert_POST/index.html"}
{"id": "f7916d36721b-1", "text": "\"name_2\": \"\",\n                        \"primary\": false\n                    },\n                    {\n                        \"id\": \"West\",\n                        \"name\": \"West\",\n                        \"name_2\": \"\",\n                        \"primary\": false\n                    }\n                ],\n                \"phone_home\": \"(890) 241-5509\",\n                \"phone_mobile\": \"(738) 338-2546\",\n                \"phone_work\": \"(579) 448-8879\",\n                \"phone_fax\": \"\",\n                \"primary_address_street\": \"123 Anywhere Street\",\n                \"primary_address_city\": \"Salt Lake City\",\n                \"primary_address_state\": \"CA\",\n                \"primary_address_postalcode\": \"81738\",\n                \"primary_address_country\": \"USA\",\n                \"campaign_id\": \"\",\n                \"campaign_name\": \"\",\n                \"email\": [\n                    {\n                        \"email_address\": \"kid75@example.it\",\n                        \"invalid_email\": false,\n                        \"opt_out\": false,\n                        \"primary_address\": true,\n                        \"reply_to_address\": false\n                    }\n                ]\n            },\n            \"Accounts\": {\n                \"id\": \"1c212ff9-c0d5-866d-d3ae-526e6cd47a31\",\n                \"name\": \"Lexington Shores Corp\",\n                \"date_entered\": \"2013-10-28T09:52:46-04:00\",\n                \"date_modified\": \"2013-10-28T09:52:46-04:00\",\n                \"modified_user_id\": \"1\",\n                \"modified_by_name\": \"Administrator\",\n                \"created_by\": \"1\",\n                \"created_by_name\": \"Administrator\",\n                \"description\": \"\",\n                \"deleted\": false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/LeadsleadIdconvert_POST/index.html"}
{"id": "f7916d36721b-2", "text": "\"description\": \"\",\n                \"deleted\": false,\n                \"assigned_user_id\": \"seed_sally_id\",\n                \"assigned_user_name\": \"Sally Bronsen\",\n                \"team_count\": \"\",\n                \"team_name\": [\n                    {\n                        \"id\": \"West\",\n                        \"name\": \"West\",\n                        \"name_2\": \"\",\n                        \"primary\": true\n                    }\n                ],\n                \"linkedin\": \"\",\n                \"facebook\": \"\",\n                \"twitter\": \"\",\n                \"googleplus\": \"\",\n                \"account_type\": \"Customer\",\n                \"industry\": \"Electronics\",\n                \"annual_revenue\": \"\",\n                \"phone_fax\": \"\",\n                \"billing_address_street\": \"111 Silicon Valley Road\",\n                \"billing_address_street_2\": \"\",\n                \"billing_address_street_3\": \"\",\n                \"billing_address_street_4\": \"\",\n                \"billing_address_city\": \"Santa Fe\",\n                \"billing_address_state\": \"CA\",\n                \"billing_address_postalcode\": \"63785\",\n                \"billing_address_country\": \"USA\",\n                \"rating\": \"\",\n                \"phone_office\": \"(641) 347-6902\",\n                \"phone_alternate\": \"\",\n                \"website\": \"www.imphone.de\",\n                \"ownership\": \"\",\n                \"employees\": \"\",\n                \"ticker_symbol\": \"\",\n                \"shipping_address_street\": \"111 Silicon Valley Road\",\n                \"shipping_address_street_2\": \"\",\n                \"shipping_address_street_3\": \"\",\n                \"shipping_address_street_4\": \"\",\n                \"shipping_address_city\": \"Santa Fe\",\n                \"shipping_address_state\": \"CA\",\n                \"shipping_address_postalcode\": \"63785\",\n                \"shipping_address_country\": \"USA\",\n                \"email\": [\n                    {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/LeadsleadIdconvert_POST/index.html"}
{"id": "f7916d36721b-3", "text": "\"shipping_address_country\": \"USA\",\n                \"email\": [\n                    {\n                        \"email_address\": \"section.qa@example.tw\",\n                        \"invalid_email\": false,\n                        \"opt_out\": false,\n                        \"primary_address\": true,\n                        \"reply_to_address\": false\n                    },\n                    {\n                        \"email_address\": \"vegan29@example.de\",\n                        \"invalid_email\": false,\n                        \"opt_out\": false,\n                        \"primary_address\": false,\n                        \"reply_to_address\": false\n                    }\n                ],\n                \"email1\": \"section.qa@example.tw\",\n                \"parent_id\": \"\",\n                \"sic_code\": \"\",\n                \"parent_name\": \"\",\n                \"email_opt_out\": false,\n                \"invalid_email\": false,\n                \"campaign_id\": \"\",\n                \"campaign_name\": \"\",\n                \"my_favorite\": false,\n                \"_acl\": {\n                    \"fields\": {}\n                },\n                \"following\": false,\n                \"_module\": \"Accounts\",\n                \"duplicate_check_rank\": 8\n            },\n            \"Opportunities\": {\n                \"id\": \"5529e246-c42f-04e0-1989-526e6d3029c6\",\n                \"name\": \"Lexington Shores Corp - 311 Units\",\n                \"date_entered\": \"2013-10-28T09:52:46-04:00\",\n                \"date_modified\": \"2013-10-28T09:52:46-04:00\",\n                \"modified_user_id\": \"1\",\n                \"modified_by_name\": \"Administrator\",\n                \"created_by\": \"1\",\n                \"created_by_name\": \"Administrator\",\n                \"description\": \"\",\n                \"deleted\": false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/LeadsleadIdconvert_POST/index.html"}
{"id": "f7916d36721b-4", "text": "\"description\": \"\",\n                \"deleted\": false,\n                \"assigned_user_id\": \"seed_sally_id\",\n                \"assigned_user_name\": \"Sally Bronsen\",\n                \"team_count\": \"\",\n                \"team_name\": [\n                    {\n                        \"id\": \"West\",\n                        \"name\": \"West\",\n                        \"name_2\": \"\",\n                        \"primary\": true\n                    }\n                ],\n                \"opportunity_type\": \"\",\n                \"account_name\": \"Lexington Shores Corp\",\n                \"account_id\": \"1c212ff9-c0d5-866d-d3ae-526e6cd47a31\",\n                \"campaign_id\": \"\",\n                \"campaign_name\": \"\",\n                \"lead_source\": \"Partner\",\n                \"amount\": 10413,\n                \"base_rate\": 1,\n                \"amount_usdollar\": 10413,\n                \"currency_id\": \"-99\",\n                \"currency_name\": \"\",\n                \"currency_symbol\": \"\",\n                \"date_closed\": \"2014-03-30\",\n                \"date_closed_timestamp\": 1396187804,\n                \"next_step\": \"\",\n                \"sales_stage\": \"Prospecting\",\n                \"sales_status\": \"New\",\n                \"probability\": 10,\n                \"best_case\": 11795,\n                \"worst_case\": 9031,\n                \"commit_stage\": \"exclude\",\n                \"total_revenue_line_items\": 5,\n                \"closed_revenue_line_items\": 1,\n                \"contact_role\": \"\",\n                \"my_favorite\": false,\n                \"_acl\": {\n                    \"fields\": {}\n                },\n                \"following\": false,\n                \"_module\": \"Opportunities\",\n                \"duplicate_check_rank\": 0\n            }\n        }\n    }", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/LeadsleadIdconvert_POST/index.html"}
{"id": "f7916d36721b-5", "text": "\"duplicate_check_rank\": 0\n            }\n        }\n    }\n            \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/LeadsleadIdconvert_POST/index.html"}
{"id": "9d75115b607b-0", "text": "/css GET\nOverview\n    Runs LessPHP for a platform and a theme and outputs an array of css files. If not found the css files\n    will be compiled.\nRequest Arguments\nName\nType\nDescription\nRequired\nplatform\nString\nThe theme platform - /themes/clients/***PLATFORM***/themeName/. Accepted values are 'base' and 'portal'.\nNo. (defaults to base)\nthemeName\nString\nThe theme name - /themes/clients/platform/***THEMENAME***/.\nNo. (defaults to default)\nRequest\n{\n    platform: 'portal',\n    themeName: 'default'\n}\nResponse\n{\n    url: [\n        'cache/themes/clients/base/default/bootstrap_97c9cf53841dbe471c20d169e3533763.css',\n        'cache/themes/clients/base/default/sugar_14c42516aad866b7f80cc896ce5c5406.css',\n    ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<css> GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/css_GET/index.html"}
{"id": "8ec417b6ac6c-0", "text": "/lang/labels/module PUT\nOverview\nUpdate display labels of fields for modules under different languages.\nSummary\nThis endpoint is used to update display labels of fields for modules under different languages.\nRequest Arguments\nName\nType\nDescription\nRequired\nname\nstring\nThe dropdown name.\nTrue\nlabels\narray\nThe new labels grouped by language keys.\nTrue\nRequest\n[\n  {\n    \"name\": \"Leads\",\n    \"labels\": {\n      \"en_us\": {\n          \"ai_conv_score_classification_c\": \"Ai Conv Score Classification\"\n      },\n      \"de_DE\": {\n          \"ai_conv_score_classification_c\": \"Ai Conv Score Klassifizierung\"\n      },\n      \"ja_JP\": {\n          \"ai_conv_score_classification_c\": \"AiConv\u00e3\u0082\u00b9\u00e3\u0082\u00b3\u00e3\u0082\u00a2\u00e5\u0088\u0086\u00e9\u00a1\u009e\"\n      }\n    }\n  }\n]\n\u00c2\u00a0\nRequest example for multiple fields:\n[\n  {\n    \"name\": \"Leads\",\n    \"labels\": {\n      \"en_us\": {\n          \"ai_score_c\": \"Ai Score\",\n          \"ai_conv_score_classification_c\": \"Ai Conv Score Classification\",\n          \"description\": \"New Description\"\n      },\n      \"de_DE\": {\n          \"ai_score_c\": \"Ai Punktzahl\",\n          \"ai_conv_score_classification_c\": \"Ai Conv Score Klassifizierung\",\n          \"description\": \"New German Description\"\n      },\n      \"ja_JP\": {\n          \"ai_score_c\": \"\u00e6\u0084\u009b\u00e3\u0082\u00b9\u00e3\u0082\u00b3\u00e3\u0082\u00a2\",\n          \"ai_conv_score_classification_c\": \"AiConv\u00e3\u0082\u00b9\u00e3\u0082\u00b3\u00e3\u0082\u00a2\u00e5\u0088\u0086\u00e9\u00a1\u009e\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/langlabelsmodule_PUT/index.html"}
{"id": "8ec417b6ac6c-1", "text": "\"description\": \"New Japanese Description\"\n      }\n    }\n  },\n  {\n    \"name\": \"Opportunities\",\n    \"labels\": {\n      \"de_DE\": {\n          \"amount\": \"Menge\",\n          \"amount_usdollar\": \"Betrag US-Dollar\"\n      },\n      \"ja_JP\": {\n          \"amount\": \"\u00e9\u0087\u008f\",\n          \"amount_usdollar\": \"\u00e9\u0087\u0091\u00e9\u00a1\u008d\u00e7\u00b1\u00b3\u00e3\u0083\u0089\u00e3\u0083\u00ab\"\n      }\n    }\n  }\n]\nResponse Example\n[\n    {\n        \"name\": \"Leads\",\n        \"labels\": {\n            \"en_us\": {\n                \"LBL_AI_SCORE\": \"Ai Score\",\n                \"LBL_AI_CONV_SCORE_CLASSIFICATION\": \"Ai Conv Score Classification\",\n                \"LBL_DESCRIPTION\": \"New Description\"\n            },\n            \"de_DE\": {\n                \"LBL_AI_SCORE\": \"Ai Punktzahl\",\n                \"LBL_AI_CONV_SCORE_CLASSIFICATION\": \"Ai Conv Score Klassifizierung\",\n                \"LBL_DESCRIPTION\": \"New German Description\"\n            },\n            \"ja_JP\": {\n                \"LBL_AI_SCORE\": \"\u00e6\u0084\u009b\u00e3\u0082\u00b9\u00e3\u0082\u00b3\u00e3\u0082\u00a2\",\n                \"LBL_AI_CONV_SCORE_CLASSIFICATION\": \"AiConv\u00e3\u0082\u00b9\u00e3\u0082\u00b3\u00e3\u0082\u00a2\u00e5\u0088\u0086\u00e9\u00a1\u009e\",\n                \"LBL_DESCRIPTION\": \"New Japanese Description\"\n            }\n        }\n    },\n    {\n        \"type\": \"field\",\n        \"module\": \"Opportunities\",\n        \"labels\": {\n            \"de_DE\": {\n                \"LBL_LIKELY\": \"Menge\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/langlabelsmodule_PUT/index.html"}
{"id": "8ec417b6ac6c-2", "text": "\"de_DE\": {\n                \"LBL_LIKELY\": \"Menge\",\n                \"LBL_AMOUNT_USDOLLAR\": \"Betrag US-Dollar\"\n            },\n            \"ja_JP\": {\n                \"LBL_LIKELY\": \"\u00e9\u0087\u008f\",\n                \"LBL_AMOUNT_USDOLLAR\": \"\u00e9\u0087\u0091\u00e9\u00a1\u008d\u00e7\u00b1\u00b3\u00e3\u0083\u0089\u00e3\u0083\u00ab\"\n            }\n        }\n    }\n]\nChange Log\nVersion\nChange\nv11.13\nAdded\u00c2\u00a0/lang/labels/module/\u00c2\u00a0PUT endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/langlabelsmodule_PUT/index.html"}
{"id": "70d03e96259e-0", "text": "/pmse_Project/GatewayDefinition/:record GET\nOverview\n    Retrieves the definition data for a gateway\nSummary\n    This endpoint will retrieve the JSON encoded definition data for the Process\n    Definition gateway identified by the record input parameter.\nRequest Arguments\nName\nType\nDescription\nRequired\nrecord\nString\nThe value for the gat_uid field in the pmse_bpmn_gateway record\nTrue\nResponse Arguments\nName\nType\nDescription\nsuccess\nBoolean\nThe status of the response\ndata\nArray\nThe definition data for the gateway\nResponse\n{\n    \"success\":true,\n    \"data\":\n    [\n        {\n            \"flo_uid\":\"985528634573cabc8901d04029355451\",\n            \"flo_condition\":\"[{\\u0022expType\\u0022:\\u0022BUSINESS_RULES\\u0022,\\u0022expLabel\\u0022:\\u0022Action # 1 is equal to \\\\\\u0022TRUE\\\\\\u0022\\u0022,\\u0022expValue\\u0022:\\u0022TRUE\\u0022,\\u0022expOperator\\u0022:\\u0022equals\\u0022,\\u0022expField\\u0022:\\u0022b6d2500c-bf29-2ad7-67a2-569d5debc7d9\\u0022}]\"\n        }\n    ]\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectGatewayDefinitionrecord_GET/index.html"}
{"id": "550228d3404e-0", "text": "/Tags/:record PUT\nOverview\n    Update a record of the specified type.\nRequest Arguments\nName\nType\nDescription\nRequired\n            <record field>\n        \n            <record field type>\n        \n            The name value list of fields to populate.\n        \n            True\n        \nRequest\n{\n    \"name\":\"New Account Name\",\n    \"phone_office\":\"(555) 888-5555\",\n    \"website\":\"www.newsite.com\",\n    \"meetings\": {\n    {\n        \"add\": [\"21e3385e-404f-b470-407e-54044e3d8024\"],\n        \"delete\": [\"21e3385e-404f-b470-407e-54044e3d8023\"],\n        \"create\": [\n        {\n            \"name\": \"Test Meeting\"\n        }\n      ]\n    }\n}\nLink fields\n    It is possible to add or delete record relations to other records and create new related records.\nAction\nType\nDescription\nadd\n            List\n        \n            List of related records ID. See RelateRecordApi\n            for details.\n        \ndelete\n            List\n        \n            List of related records ID.\n        \ncreate\n            List\n        \n            List of name to value arrays of related records.\n        \nResponse Arguments\nName\nType\nDescription\n            <record field>\n        \n            <record field type>\n        \n            Returns the fields for the updated record.\n        \nResponse\n{\n   \"id\":\"f222265a-b755-da89-0bc7-512d09b800b6\",\n   \"name\":\"New Account Name\",\n   \"date_entered\":\"2013-02-26T19:12:00+00:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Tagsrecord_PUT/index.html"}
{"id": "550228d3404e-1", "text": "\"date_modified\":\"2013-02-27T22:49:00+00:00\",\n   \"modified_user_id\":\"1\",\n   \"modified_by_name\":\"Administrator\",\n   \"created_by\":\"1\",\n   \"created_by_name\":\"Administrator\",\n   \"description\":\"\",\n   \"img\":\"\",\n   \"last_activity_date\":\"2013-02-26T19:12:00+00:00\",\n   \"deleted\":false,\n   \"assigned_user_id\":\"seed_sarah_id\",\n   \"assigned_user_name\":\"Sarah Smith\",\n   \"team_name\":[\n      {\n         \"id\":1,\n         \"name\":\"Global\",\n         \"name_2\":\"\",\n         \"primary\":false\n      },\n      {\n         \"id\":\"West\",\n         \"name\":\"West\",\n         \"name_2\":\"\",\n         \"primary\":true\n      }\n   ],\n   \"linkedin\":\"\",\n   \"facebook\":\"\",\n   \"twitter\":\"\",\n   \"googleplus\":\"\",\n   \"account_type\":\"Customer\",\n   \"industry\":\"Hospitality\",\n   \"annual_revenue\":\"\",\n   \"phone_fax\":\"\",\n   \"billing_address_street\":\"9 IBM Path\",\n   \"billing_address_street_2\":\"\",\n   \"billing_address_street_3\":\"\",\n   \"billing_address_street_4\":\"\",\n   \"billing_address_city\":\"San Francisco\",\n   \"billing_address_state\":\"CA\",\n   \"billing_address_postalcode\":\"43635\",\n   \"billing_address_country\":\"USA\",\n   \"rating\":\"\",\n   \"phone_office\":\"(555) 888-5555\",\n   \"phone_alternate\":\"\",\n   \"website\":\"www.newsite.com\",\n   \"ownership\":\"\",\n   \"employees\":\"\",\n   \"ticker_symbol\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Tagsrecord_PUT/index.html"}
{"id": "550228d3404e-2", "text": "\"ownership\":\"\",\n   \"employees\":\"\",\n   \"ticker_symbol\":\"\",\n   \"shipping_address_street\":\"9 IBM Path\",\n   \"shipping_address_street_2\":\"\",\n   \"shipping_address_street_3\":\"\",\n   \"shipping_address_street_4\":\"\",\n   \"shipping_address_city\":\"San Francisco\",\n   \"shipping_address_state\":\"CA\",\n   \"shipping_address_postalcode\":\"43635\",\n   \"shipping_address_country\":\"USA\",\n   \"email1\":\"kid86@example.net\",\n   \"parent_id\":\"\",\n   \"sic_code\":\"\",\n   \"parent_name\":\"\",\n   \"email_opt_out\":false,\n   \"invalid_email\":false,\n   \"email\":[\n      {\n         \"email_address\":\"kid86@example.net\",\n         \"opt_out\":\"0\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"1\"\n      },\n      {\n         \"email_address\":\"the.dev@example.name\",\n         \"opt_out\":\"0\",\n         \"invalid_email\":\"0\",\n         \"primary_address\":\"0\"\n      }\n   ],\n   \"campaign_id\":\"\",\n   \"campaign_name\":\"\",\n   \"my_favorite\":false,\n   \"_acl\":{\n      \"fields\":{\n      }\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Tagsrecord_PUT/index.html"}
{"id": "7afa54e4a1ac-0", "text": "/Administration/elasticsearch/routing GET\nOverview\n    [ADMIN] Elasticsearch index routing\nSummary\n    This endpoint returns an overview of the current read and write indices per module. This routing information is\n    based on the configured index routing strategies and the index configuration per module. Note that this output\n    shows the default routing only as no context is available to determine dynamic routing strategies. This endpoint\n    is only available to administrators.\nResponse\n{\n    \"Contacts\":{\n        \"strategy\":\"static\",\n        \"routing\":{\n            \"write_index\":\"autobr2583_contacts\",\n            \"read_indices\":[\n                \"autobr2583_contacts\"\n            ]\n        }\n    },\n    \"Accounts\":{\n        \"strategy\":\"static\",\n        \"routing\":{\n            \"write_index\":\"autobr2583_shared\",\n            \"read_indices\":[\n                \"autobr2583_shared\"\n            ]\n        }\n    },\n    \"Emails\":{\n        \"strategy\":\"rolling\",\n        \"routing\":{\n            \"write_index\":\"autobr2583_emails_201503\",\n            \"read_indices\":[\n                \"autobr2583_emails_201503\",\n                \"autobr2583_emails_201502\",\n                \"autobr2583_emails_201501\"\n            ]\n        }\n    }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Administration/elasticsearch/routing GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchrouting_GET/index.html"}
{"id": "709488da66db-0", "text": "/Administration/search/status GET\nOverview\n    [ADMIN] Search status\nSummary\n    This endpoint returns the status of the search backend including a list of the activated full text search modules.\n    This endpoint is only available to administrators.\nResponse\n{\n    \"available\":true,\n    \"enabled_modules\":\n    [\n        \"Accounts\",\n        \"Bugs\",\n        \"Calls\",\n        \"Campaigns\",\n    ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Administration/search/status GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationsearchstatus_GET/index.html"}
{"id": "05c5f1d97df2-0", "text": "/rssfeed GET\nOverview\n    Consumes an RSS feed as a proxy and returns the feed up to a certain number of entries.\nRequest Arguments\nName\nType\nDescription\nRequired\nfeed_url\nString\nA fully qualified URL to an RSS feed.\nTrue\nlimit\nInteger\nMaximum number of entries to fetch. If not provided, the API will return up to $sugar_config['rss_feed_max_entries'] or 20 if no config option is set.\nFalse\nRequest\nhttp://{site_url}/rest/v10/rssfeed?feed_url=http%3A%2F%2Ffqd.rssfeed.url%2F&limit=10\nNote: GET endpoint parameters are passed in the form of a query string.\nResponse Arguments\nName\nType\nDescription\ntitle\nString\nThe title of the RSS Feed. This can be blank.\nlink\nString\nThe URL to the source of the RSS Feed. This can be blank.\ndescription\nString\nA description of the feed. This can be blank.\npublication_date\nTimestamp\nA timestamp of when the feed was published.\nentries\nArray\n                An array of entries, each of which will contain the following values:\n                title\ndescription\nlink\npublication_date\nsource\nauthor\nResponse\n{\n    \"feed\":{\n        \"title\":\"Sample Feed Title\",\n        \"link\":\"http:\\/\\/www.samplefeed.com\\/feed-link-url.htm\",\n        \"description\":\"A sample of a feed description\",\n        \"publication_date\":\"Tue, 10 Aug 2014 13:38:55 -0800\",\n        \"entries\":[\n            {\n                \"title\":\"First entry title\",\n                \"description\":\"A blurb about the first entry. This will be HTML encoded on return.\",\n                \"link\":\"http:\\/\\/www.samplefeed.com\\/feed-entry-1.htm\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/rssfeed_GET/index.html"}
{"id": "05c5f1d97df2-1", "text": "\"link\":\"http:\\/\\/www.samplefeed.com\\/feed-entry-1.htm\",\n                \"publication_date\":\"Tue, 10 Aug 2014 13:38:55 -0800\",\n                \"source\":\"Reuters\",\n                \"author\":\"John Doe\"\n            },\n            {\n                \"title\":\"Second entry title\",\n                \"description\":\"A blurb about the Second entry. This will be HTML encoded on return.\",\n                \"link\":\"http:\\/\\/www.samplefeed.com\\/feed-entry-2.htm\",\n                \"publication_date\":\"Tue, 10 Aug 2014 13:38:55 -0800\",\n                \"source\":\"BBC\",\n                \"author\":\"\"\n            }\n        ]\n    }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<rssfeed> GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/rssfeed_GET/index.html"}
{"id": "84321fa44500-0", "text": "/<module>/:record/link/:link_name/:remote_id PUT\nOverview\n    Updates relationship specific information on an existing relationship.\nRequest Arguments\nName\nType\nDescription\nRequired\n            <relationship field>\n        \n            <relationship field type>\n        \n            The name value list of relationship fields to populate. An example is the contact_role field on Opportunities and Contacts.\n        \n            True\n        \nRequest\n{\n    \"contact_role\":\"Primary Decision Maker\"\n}\nResponse Arguments\nName\nType\nDescription\n            record\n        \n            Array\n        \n            The record linked to the related record.\n        \n            related_record\n        \n            Array\n        \n            The record that was associated.\n        \nResponse\n{\n   \"record\":{\n      \"id\":\"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n      \"name\":\"Slender Broadband Inc - 1000 units\",\n      \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n      \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n      \"modified_user_id\":\"1\",\n      \"modified_by_name\":\"Administrator\",\n      \"created_by\":\"1\",\n      \"created_by_name\":\"Administrator\",\n      \"description\":\"\",\n      \"img\":\"\",\n      \"deleted\":false,\n      \"assigned_user_id\":\"seed_max_id\",\n      \"assigned_user_name\":\"Max Jensen\",\n      \"team_name\":[\n         {\n            \"id\":\"East\",\n            \"name\":\"East\",\n            \"name_2\":\"\",\n            \"primary\":false\n         },\n         {\n            \"id\":\"West\",\n            \"name\":\"West\",\n            \"name_2\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_PUT/index.html"}
{"id": "84321fa44500-1", "text": "\"name\":\"West\",\n            \"name_2\":\"\",\n            \"primary\":true\n         }\n      ],\n      \"opportunity_type\":\"\",\n      \"account_name\":\"Slender Broadband Inc\",\n      \"account_id\":\"181461c6-dc81-1115-1fe0-512d092e8f15\",\n      \"campaign_id\":\"\",\n      \"campaign_name\":\"\",\n      \"lead_source\":\"Campaign\",\n      \"amount\":\"25000\",\n      \"base_rate\":\"1\",\n      \"amount_usdollar\":\"25000\",\n      \"currency_id\":\"-99\",\n      \"currency_name\":\"\",\n      \"currency_symbol\":\"\",\n      \"date_closed\":\"2013-02-27\",\n      \"date_closed_timestamp\":\"1361992480\",\n      \"next_step\":\"\",\n      \"sales_stage\":\"Needs Analysis\",\n      \"sales_status\":\"New\",\n      \"probability\":\"90\",\n      \"best_case\":\"25000\",\n      \"worst_case\":\"25000\",\n      \"commit_stage\":\"include\",\n      \"my_favorite\":false,\n      \"_acl\":{\n         \"fields\":{\n         }\n      }\n   },\n   \"related_record\":{\n      \"id\":\"e1c495cb-af17-1b37-dd66-512f934fe155\",\n      \"name\":\"Bill Edwards\",\n      \"date_entered\":\"2013-02-28T17:25:00+00:00\",\n      \"date_modified\":\"2013-02-28T17:25:00+00:00\",\n      \"modified_user_id\":\"1\",\n      \"modified_by_name\":\"Administrator\",\n      \"created_by\":\"1\",\n      \"created_by_name\":\"Administrator\",\n      \"description\":\"\",\n      \"img\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_PUT/index.html"}
{"id": "84321fa44500-2", "text": "\"description\":\"\",\n      \"img\":\"\",\n      \"deleted\":false,\n      \"assigned_user_id\":\"\",\n      \"assigned_user_name\":\"\",\n      \"team_name\":[\n         {\n            \"id\":1,\n            \"name\":\"Global\",\n            \"name_2\":\"\",\n            \"primary\":true\n         }\n      ],\n      \"salutation\":\"\",\n      \"first_name\":\"Bill\",\n      \"last_name\":\"Edwards\",\n      \"full_name\":\"Bill Edwards\",\n      \"title\":\"\",\n      \"linkedin\":\"\",\n      \"facebook\":\"\",\n      \"twitter\":\"\",\n      \"googleplus\":\"\",\n      \"department\":\"\",\n      \"do_not_call\":false,\n      \"phone_home\":\"\",\n      \"email\":[\n      ],\n      \"phone_mobile\":\"\",\n      \"phone_work\":\"\",\n      \"phone_other\":\"\",\n      \"phone_fax\":\"\",\n      \"email1\":\"\",\n      \"email2\":\"\",\n      \"invalid_email\":\"\",\n      \"email_opt_out\":\"\",\n      \"primary_address_street\":\"\",\n      \"primary_address_street_2\":\"\",\n      \"primary_address_street_3\":\"\",\n      \"primary_address_city\":\"\",\n      \"primary_address_state\":\"\",\n      \"primary_address_postalcode\":\"\",\n      \"primary_address_country\":\"\",\n      \"alt_address_street\":\"\",\n      \"alt_address_street_2\":\"\",\n      \"alt_address_street_3\":\"\",\n      \"alt_address_city\":\"\",\n      \"alt_address_state\":\"\",\n      \"alt_address_postalcode\":\"\",\n      \"alt_address_country\":\"\",\n      \"assistant\":\"\",\n      \"assistant_phone\":\"\",\n      \"picture\":\"\",\n      \"email_and_name1\":\"\",\n      \"lead_source\":\"\",\n      \"account_id\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_PUT/index.html"}
{"id": "84321fa44500-3", "text": "\"lead_source\":\"\",\n      \"account_id\":\"\",\n      \"opportunity_role_fields\":\"\",\n      \"opportunity_role_id\":\"\",\n      \"opportunity_role\":\"Primary Decision Maker\",\n      \"reports_to_id\":\"\",\n      \"report_to_name\":\"\",\n      \"portal_name\":\"\",\n      \"portal_active\":false,\n      \"portal_password\":\"\",\n      \"portal_password1\":\"\",\n      \"portal_app\":\"\",\n      \"preferred_language\":\"en_us\",\n      \"campaign_id\":\"\",\n      \"campaign_name\":\"\",\n      \"c_accept_status_fields\":\"\",\n      \"m_accept_status_fields\":\"\",\n      \"accept_status_id\":\"\",\n      \"accept_status_name\":\"\",\n      \"sync_contact\":\"\",\n      \"my_favorite\":false,\n      \"_acl\":{\n         \"fields\":{\n         }\n      }\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/link/:link_name/:remote_id PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_PUT/index.html"}
{"id": "1dac22885471-0", "text": "/<module>/sync_key/:sync_key_field_value PATCH\nOverview\nUpserts based on sync_key. If a record can be found with sync_key, then update. If the record does not exist, then create it.\nNote:\u00c2\u00a0This endpoint cannot be used to set the sync_key for an existing Sugar record. To do so, it is recommended to use the set sync key endpoint to update the matching Sugar record ID. Once the sync_key is set for the record, then it is possible to leverage this endpoint.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule\nString\nThe module the record belongs to\nTrue\nsync_key_field_value\nString\nA unique ID for the record identifying it in an external system\nTrue\nRequest\n/<module>/sync_key/:sync_key_field_value\nResponse Arguments\nName\nType\nDescription\nrecord\nString\nThe ID of the record that was upserted.\nResponse\nStatus 201: For a created record\nStatus 200: For an updated record\n{    record: \"a0328573-a252-a27c-3530-4e4297d4c9e1\"} \nChange Log\nVersion\nChange\nv11_10\nAdded /<module>/sync_key/:sync_key_field_value\u00c2\u00a0PATCH endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulesync_keysync_key_field_value_PATCH/index.html"}
{"id": "19e55415a279-0", "text": "/Notifications GET\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n            Note that JSON-encoded filters can be specified as query parameters\n            in one of two ways for GET requests:\n            \n                    By specifying individual filter arguments as distinct parameters.\n                    Example: filter[0][id]=1.\n                \n                    By specifying the whole filter as a single JSON-encoded string.\n                    Note that this syntax is currently not supported on certain modules.\n                    Example: filter=[{\"id\":\"1\"}].\n                \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Notifications_GET/index.html"}
{"id": "19e55415a279-1", "text": "False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. Each field may be represented either by string, or by map\n            containing field name and additional field parameters (applicable to link and collection fields).\n            The fields id and date_modified will always be returned.\n            \n            Example: name,account_type,description,{\"name\":\"opportunities\",\"fields\":[\"id\",\"name\",\"sales_status\"],\"order_by\":\"date_closed:desc\"}\n            For more details on additional field parameters, see\n            Relate API and\n            Collection API.\n        \n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \n            q\n        \n            String\n        \n            A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.\n        \n            False\n        \n            deleted\n        \n            Boolean\n        \n            Boolean to show deleted records in the result set.\n        \n            False\n        \n            nulls_last\n        \n            Boolean", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Notifications_GET/index.html"}
{"id": "19e55415a279-2", "text": "False\n        \n            nulls_last\n        \n            Boolean\n        \n            Boolean to return records with null values in order_by fields last in the result set.\n        \n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\nExample\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Notifications_GET/index.html"}
{"id": "19e55415a279-3", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Notifications_GET/index.html"}
{"id": "19e55415a279-4", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\",\n               \"id\": \"b0701501-1fab-8ae7-3942-540da93f5017\",\n               \"name\": \"360 Vacations - 228 Units\",\n               \"date_modified\": \"2014-09-08T16:05:00+03:00\",\n               \"sales_status\": \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Notifications_GET/index.html"}
{"id": "19e55415a279-5", "text": "{\n               _module: \"Opportunities\"\n               date_modified: \"2014-09-08T16:05:00+03:00\"\n               id: \"9ce7c088-8ee4-7cd3-18f1-540da944d4c0\"\n               name: \"360 Vacations - 312 Units\"\n               sales_status: \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Notifications_GET/index.html"}
{"id": "d177333f95ac-0", "text": "/login/marketingContentUrl GET\nOverview\nReturns the SugarCRM marketing content URL that is managed by the marketing team.\nSummary\nThis API attempts to reach SugarCRM's marketing content URL. If the service is unreachable, a URL for the static content is returned.\nRequest Arguments\nName\nType\nDescription\nRequired\nselected_language\nString\nCode for the desired marketing content language. (Eg. \"en_us\", \"fr_FR\"). Providing a certain language code does not guarantee that content returned will be in the provided language. If an invalid language is specified, will assume \"en_us\".\nFalse. It uses the configured language if this parameter is missing. Defaults to \"en_us\".\nstatic\nBoolean\nIf set to true, return URL for static marketing content. Defaults to false.\nFalse. If this parameter is missing, the API defaults to the dynamic content url.\nResponse Arguments\nName\nType\nDescription\nurl\nString\nURL suitable for embedding in an iFrame that links to marketing content from SugarCRM.\nResponse\n\"https://www.sugarcrm.com/product-login-page-service/\"\nChange Log\nVersion\nChange\nv11_9\nAdded /login/marketingContentUrl\u00c2\u00a0GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/loginmarketingContentUrl_GET/index.html"}
{"id": "4a90e8721fd3-0", "text": "/Forecasts/config PUT\nCreates and/or updates the config settings for the Forecasts module\nSummary:\n    This endpoint is used to create and/or update the config settings for the Forecasts module as json data.  It extends\n    the core config endpoint by adding the functionality to create\n    the Timeperiods and updates existing Opportunities for use in the Forecasts module.\nQuery Parameters:\nParam\nDescription\nOptional\nInput Example:\n        {\n            \"is_setup\": 1,\n            \"is_upgrade\": 0,\n            \"has_commits\": 1,\n            \"timeperiod_type\": \"chronological\",\n            \"timeperiod_interval\": \"Annual\",\n            \"timeperiod_leaf_interval\": \"Quarter\",\n            \"timeperiod_start_date\": \"2013-01-01\",\n            \"timeperiod_shown_forward\": 2,\n            \"timeperiod_shown_backward\": 2,\n            \"forecast_ranges\": \"show_binary\",\n            \"buckets_dom\": \"commit_stage_binary_dom\",\n            \"show_binary_ranges\": {\n                \"include\": {\n                    \"min\": 70,\n                    \"max\": 100\n                },\n                \"exclude\": {\n                    \"min\": 0,\n                    \"max\": 69\n                }\n            },\n            \"show_buckets_ranges\": {\n                \"include\": {\n                    \"min\": 85,\n                    \"max\": 100\n                },\n                \"upside\": {\n                    \"min\": 70,\n                    \"max\": 84\n                },\n                \"exclude\": {\n                    \"min\": 0,\n                    \"max\": 69\n                }\n            },\n            \"sales_stage_won\": [\n                \"Closed Won\"\n            ],\n            \"sales_stage_lost\": [\n                \"Closed Lost\"\n            ],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsconfig_PUT/index.html"}
{"id": "4a90e8721fd3-1", "text": "],\n            \"sales_stage_lost\": [\n                \"Closed Lost\"\n            ],\n            \"show_worksheet_likely\": 1,\n            \"show_worksheet_best\": 1,\n            \"show_worksheet_worst\": 0,\n            \"show_projected_likely\": 1,\n            \"show_projected_best\": 1,\n            \"show_projected_worst\": 0,\n            \"show_forecasts_commit_warnings\": 1\n        }\n    \nOutput Example:\n        {\n            \"is_setup\": 1,\n            \"is_upgrade\": 0,\n            \"has_commits\": 1,\n            \"timeperiod_type\": \"chronological\",\n            \"timeperiod_interval\": \"Annual\",\n            \"timeperiod_leaf_interval\": \"Quarter\",\n            \"timeperiod_start_date\": \"2013-01-01\",\n            \"timeperiod_shown_forward\": 2,\n            \"timeperiod_shown_backward\": 2,\n            \"forecast_ranges\": \"show_binary\",\n            \"buckets_dom\": \"commit_stage_binary_dom\",\n            \"show_binary_ranges\": {\n                \"include\": {\n                    \"min\": 70,\n                    \"max\": 100\n                },\n                \"exclude\": {\n                    \"min\": 0,\n                    \"max\": 69\n                }\n            },\n            \"show_buckets_ranges\": {\n                \"include\": {\n                    \"min\": 85,\n                    \"max\": 100\n                },\n                \"upside\": {\n                    \"min\": 70,\n                    \"max\": 84\n                },\n                \"exclude\": {\n                    \"min\": 0,\n                    \"max\": 69\n                }\n            },\n            \"sales_stage_won\": [\n                \"Closed Won\"\n            ],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsconfig_PUT/index.html"}
{"id": "4a90e8721fd3-2", "text": "\"sales_stage_won\": [\n                \"Closed Won\"\n            ],\n            \"sales_stage_lost\": [\n                \"Closed Lost\"\n            ],\n            \"show_worksheet_likely\": 1,\n            \"show_worksheet_best\": 1,\n            \"show_worksheet_worst\": 0,\n            \"show_projected_likely\": 1,\n            \"show_projected_best\": 1,\n            \"show_projected_worst\": 0,\n            \"show_forecasts_commit_warnings\": 1\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsconfig_PUT/index.html"}
{"id": "f3b7de283c2d-0", "text": "/Administration/settings/idmMode POST\nOverview\n    [ADMIN] Turn IDM-mode on.\nSummary\n    This endpoint switches IDM mode on. This endpoint is only available to administrators when IDM migration is turned on and intended for internal use for IDM integration.\nRequest to enable IDM-mode.\n{\"idmMode\": \n    {\n        \"enabled\": true,\n        \"clientId\": \"mangoOIDCClientId\",\n        \"clientSecret\": \"mangoOIDCClientSecret\",\n        \"stsUrl\": \"http://sts.sugarcrm.local\",\n        \"idpUrl\": \"http://login.sugarcrm.local\",\n        \"stsKeySetId\": \"mangoOIDCKeySet\",\n        \"tid\": \"srn:cloud:idp:eu:0000000001:tenant\",\n        \"crmOAuthScope\": \"https://apis.sugarcrm.com/auth/crm\",\n        \"requestedOAuthScopes\": [\"offline\", \"https://apis.sugarcrm.com/auth/crm\", \"profile\", \"email\", \"address\", \"phone\"],\n        \"cloudConsoleUrl\": \"http://console.sugarcrm.local\",\n        \"allowedSAs\": [\"srn:cloud:iam:us-west-2:9999999999:sa:user-sync\"]\n    }\n}\nRefer to multiverse documenation for parameters explanation.\nResponse when IDM mode has been enabled\n{\n    \"tid\": \"srn:cloud:idp:eu:0000000001:tenant\",\n    \"clientId\": \"mangoOIDCClientId\",\n    \"clientSecret\": \"mangoOIDCClientSecret\",\n    \"stsUrl\": \"http://sts.sugarcrm.local\",\n    \"idpUrl\": \"http://login.sugarcrm.local\",\n    \"redirectUri\": \"http://sugar\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/AdministrationsettingsidmMode_POST/index.html"}
{"id": "f3b7de283c2d-1", "text": "\"redirectUri\": \"http://sugar\",\n    \"urlAuthorize\": \"http://sts.sugarcrm.local/oauth2/auth\",\n    \"urlAccessToken\": \"http://sts.sugarcrm.local/oauth2/token\",\n    \"urlResourceOwnerDetails\": \"http://sts.sugarcrm.local/oauth2/introspect\",\n    \"urlUserInfo\": \"http://sts.sugarcrm.local/userinfo\",\n    \"http_client\": [],\n    \"cloudConsoleUrl\": \"http://console.sugarcrm.local\",\n    \"cloudConsoleRoutes\": [],\n    \"caching\": [],\n    \"crmOAuthScope\": \"https://apis.sugarcrm.com/auth/crm\",\n    \"requestedOAuthScopes\": [\n        \"offline\",\n        \"https://apis.sugarcrm.com/auth/crm\",\n        \"profile\",\n        \"email\",\n        \"address\",\n        \"phone\"\n    ],\n    \"keySetId\": \"mangoOIDCKeySet\",\n    \"urlKeys\": \"http://sts.sugarcrm.local/keys/mangoOIDCKeySet\",\n    \"allowedSAs\": [\"srn:cloud:iam:us-west-2:9999999999:sa:user-sync\"]\n}\nChange Log\nVersion\nChange\n            v11_2\n        \n            Added /Administration/settings/idmMode POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/AdministrationsettingsidmMode_POST/index.html"}
{"id": "22c3f85f0230-0", "text": "/Emails POST\nOverview\n    Create a new Emails record.\nSummary\n    Used for creating an archived email, creating a draft to send later, or creating and sending an email.\nCreating an Archived Email\nRequest Arguments\nName\nType\nDescription\nRequired\n                state\n            \n                String\n            \n                Use \"Archived\" to create an archived email. \"Archived\" is the default value if this argument is not\n                provided.\n            \n                False\n            \n                name\n            \n                String\n            \n                The email's subject.\n            \n                False\n            \n                description_html\n            \n                String\n            \n                The email's HTML body.\n            \n                False\n            \n                description\n            \n                String\n            \n                The email's plain text body. This field is not necessary unless the text body is different from the HTML\n                body.\n            \n                False\n            \n                raw_source\n            \n                String\n            \n                The complete raw source of the email showing the headers and content in one document.\n            \n                False\n            \n                date_sent\n            \n                String\n            \n                The date that the email was sent/received.\n            \n                False\n            \n                message_id\n            \n                String\n            \n                The email's unique identifier.\n            \n                False\n            \n                message_uid\n            \n                String\n            \n                Only use this field for importing emails downloaded from an IMAP server, as this is the email's IMAP\n                UID.\n            \n                False\n            \n                assigned_user_id\n            \n                String\n            \n                The assigned user's ID.\n            \n                False\n            \n                parent_type\n            \n                String\n            \n                The parent record's module.\n            \n                False\n            \n                parent_id\n            \n                String", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html"}
{"id": "22c3f85f0230-1", "text": "False\n            \n                parent_id\n            \n                String\n            \n                The parent record's ID.\n            \n                False\n            \n                team_name\n            \n                List\n            \n                List of teams that can access the email.\n            \n                False\n            \n                from\n            \n                Object\n            \n                The email's sender. Existing EmailParticipants records cannot be used; only the create action is\n                supported. Metadata about the sender is required to link the record.\n                \nparent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,\n                        or Users, out out of the box. These fields are not necessary if only an email address is known\n                        for the sender.\n                    \nemail_address_id is the ID of the email address the sender used to send the email. To get\n                        the ID of the email address, first make a request to /EmailAddresses POST. If this\n                        argument is not provided, then the primary email address of the parent record is used.\n                    \n                True\n            \n                to\n            \n                Object\n            \n                The email's recipients found in the TO field. Existing EmailParticipants records cannot be used; only\n                the create action is supported. Metadata about each recipient is required to link the records.\n                \nparent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,\n                        or Users, out out of the box. These fields are not necessary if only an email address is known\n                        for the recipient.\n                    \nemail_address_id is the ID of the email address the recipient used in the email. To get\n                        the ID of the email address, first make a request to /EmailAddresses POST. If this\n                        argument is not provided, then the primary email address of the parent record is used.\n                    \n                False\n            \n                cc", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html"}
{"id": "22c3f85f0230-2", "text": "False\n            \n                cc\n            \n                Object\n            \n                The email's recipients found in the CC field. Existing EmailParticipants records cannot be used; only\n                the create action is supported. Metadata about each recipient is required to link the records.\n                \nparent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,\n                        or Users, out out of the box. These fields are not necessary if only an email address is known\n                        for the recipient.\n                    \nemail_address_id is the ID of the email address the recipient used in the email. To get\n                        the ID of the email address, first make a request to /EmailAddresses POST. If this\n                        argument is not provided, then the primary email address of the parent record is used.\n                    \n                False\n            \n                bcc\n            \n                Object\n            \n                The email's recipients found in the BCC field. Existing EmailParticipants records cannot be used; only\n                the create action is supported. Metadata about each recipient is required to link the records.\n                \nparent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,\n                        or Users, out out of the box. These fields are not necessary if only an email address is known\n                        for the recipient.\n                    \nemail_address_id is the ID of the email address the recipient used in the email. To get\n                        the ID of the email address, first make a request to /EmailAddresses POST. If this\n                        argument is not provided, then the primary email address of the parent record is used.\n                    \n                False\n            \n                attachments\n            \n                Object\n            \n                The email's attachments. Existing Notes records cannot be used as email attachments; only the\n                create action is supported. Metadata about each attachment is required to link the records.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html"}
{"id": "22c3f85f0230-3", "text": "create action is supported. Metadata about each attachment is required to link the records.\n                \nfilename_guid is the temporary file ID for an uploaded file to attach as a Notes record.\n                    \nupload_id is the ID of an existing file that the Notes record should reference as the\n                        attachment. This allows files to be shared by multiple Notes records, to preserve space.\n                    \n                        When using upload_id, file_source should be provided to indicate from where the\n                        file originated. The value should be the module of the record that shares its ID with the file.\n                        So when an attachment comes from an email template, file_source should be\n                        EmailTemplates. And when an attachment comes from a document, file_source should\n                        be DocumentRevisions.\n                    \n                False\n            \nRequest\n{\n  \"state\": \"Archived\",\n  \"name\": \"Re: Discuss Proposal\",\n  \"description\": \"Now is a good time\",\n  \"description_html\": \"<p>Now is a good time</p>\",\n  \"date_sent\": \"2012-02-17T06:53:00-08:00\",\n  \"message_id\": \"<d9c165d0-8863-ba61-dc85-51ed8016c476@example.com>\",\n  \"assigned_user_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"parent_type\": \"Leads\",\n  \"parent_id\": \"f6a0611a-7d27-11e7-9d70-3c15c2d582c6\",\n  \"team_name\": [{\n    \"id\": \"1\",\n    \"display_name\": \"Global\",\n    \"name\": \"Global\",\n    \"name_2\": \"\",\n    \"primary\": true,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html"}
{"id": "22c3f85f0230-4", "text": "\"name_2\": \"\",\n    \"primary\": true,\n    \"selected\": false\n  }],\n  \"from\": {\n    \"create\": [{\n      \"parent_type\": \"Leads\",\n      \"parent_id\": \"f6a0611a-7d27-11e7-9d70-3c15c2d582c6\"\n    }]\n  },\n  \"to\": {\n    \"create\": [{\n      \"parent_type\": \"Users\",\n      \"parent_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\"\n    }]\n  },\n  \"cc\": {\n    \"create\": [{\n      \"parent_type\": \"Contacts\",\n      \"parent_id\": \"79b9c194-7d79-11e7-8fc5-3c15c2d582c6\"\n    }, {\n      \"parent_type\": \"Users\",\n      \"parent_id\": \"79c2e800-7d79-11e7-84af-3c15c2d582c6\"\n      \"email_address_id\": \"79cc341e-7d79-11e7-8748-3c15c2d582c6\"\n    }]\n  },\n  \"bcc\": {\n    \"create\": [{\n      \"email_address_id\": \"ac804842-7d78-11e7-a809-3c15c2d582c6\"\n    }]\n  },\n  \"attachments\": {\n    \"create\": [{\n      \"filename_guid\": \"afe9702e-53a3-0efb-6bbe-56c3580885ef\",\n      \"name\": \"Quote.pdf\",\n      \"filename\": \"Quote.pdf\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html"}
{"id": "22c3f85f0230-5", "text": "\"name\": \"Quote.pdf\",\n      \"filename\": \"Quote.pdf\"\n    }]\n  }\n}\nResponse\n{\n  \"id\": \"a028341c-ba92-9343-55e7-56cf5beda121\",\n  \"date_entered\": \"2016-02-25T11:53:07-08:00\",\n  \"created_by\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"created_by_name\": \"Sarah Smith\",\n  \"date_modified\": \"2016-02-25T11:53:07-08:00\",\n  \"modified_by_name\": \"Sarah Smith\",\n  \"modified_user_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"deleted\": false,\n  \"assigned_user_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"assigned_user_name\": \"Sarah Smith\",\n  \"state\": \"Archived\",\n  \"name\": \"Re: Discuss Proposal\",\n  \"description\": \"Now is a good time\",\n  \"description_html\": \"<p>Now is a good time</p>\",\n  \"date_sent\": \"2012-02-17T06:53:00-08:00\",\n  \"message_id\": \"\",\n  \"message_uid\": \"\",\n  \"reply_to_status\": false,\n  \"total_attachments\": 1,\n  \"parent_name\": \"Tom Davis\",\n  \"parent_type\": \"Leads\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html"}
{"id": "22c3f85f0230-6", "text": "\"parent_name\": \"Tom Davis\",\n  \"parent_type\": \"Leads\",\n  \"parent_id\": \"f6a0611a-7d27-11e7-9d70-3c15c2d582c6\"\n  \"team_count\": \"\",\n  \"team_name\": [{\n    \"id\": 1,\n    \"name\": \"Global\",\n    \"name_2\": \"\",\n    \"primary\": true,\n    \"selected\": false\n  }],\n  \"my_favorite\": false,\n  \"_acl\": {\n    \"fields\": {}\n  },\n  \"_module\": \"Emails\"\n}\nCreating a Draft\nRequest Arguments\nName\nType\nDescription\nRequired\n                state\n            \n                String\n            \n                Use \"Draft\" to save a draft.\n            \n                True\n            \n                outbound_email_id\n            \n                String\n            \n                The ID of the chosen SMTP configuration for sending an email. Only use this field when saving a draft\n                or sending an email. The user's default SMTP configuration is used if one hasn't been chosen prior to\n                sending.\n            \n                False\n            \n                name\n            \n                String\n            \n                The email's subject.\n            \n                False\n            \n                description_html\n            \n                String\n            \n                The email's HTML body.\n            \n                False\n            \n                description\n            \n                String\n            \n                The email's plain text body. This field is not necessary unless the text body is different from the HTML\n                body.\n            \n                False\n            \n                reply_to_id\n            \n                String\n            \n                Only use this field when saving a draft or sending an email that is a reply to another email. This is\n                the ID of that other email.\n            \n                False", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html"}
{"id": "22c3f85f0230-7", "text": "the ID of that other email.\n            \n                False\n            \n                parent_type\n            \n                String\n            \n                The parent record's module.\n            \n                False\n            \n                parent_id\n            \n                String\n            \n                The parent record's ID.\n            \n                False\n            \n                to\n            \n                Object\n            \n                The email's recipients found in the TO field. Existing EmailParticipants records cannot be used; only\n                the create action is supported. Metadata about each recipient is required to link the records.\n                \nparent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,\n                        or Users, out out of the box. These fields are not necessary if only an email address is known\n                        for the recipient.\n                    \nemail_address_id is the ID of the email address the recipient used in the email. To get\n                        the ID of the email address, first make a request to /EmailAddresses POST. If this\n                        argument is not provided, then the primary email address of the parent record is used.\n                    \n                False\n            \n                cc\n            \n                Object\n            \n                The email's recipients found in the CC field. Existing EmailParticipants records cannot be used; only\n                the create action is supported. Metadata about each recipient is required to link the records.\n                \nparent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,\n                        or Users, out out of the box. These fields are not necessary if only an email address is known\n                        for the recipient.\n                    \nemail_address_id is the ID of the email address the recipient used in the email. To get\n                        the ID of the email address, first make a request to /EmailAddresses POST. If this\n                        argument is not provided, then the primary email address of the parent record is used.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html"}
{"id": "22c3f85f0230-8", "text": "argument is not provided, then the primary email address of the parent record is used.\n                    \n                False\n            \n                bcc\n            \n                Object\n            \n                The email's recipients found in the BCC field. Existing EmailParticipants records cannot be used; only\n                the create action is supported. Metadata about each recipient is required to link the records.\n                \nparent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,\n                        or Users, out out of the box. These fields are not necessary if only an email address is known\n                        for the recipient.\n                    \nemail_address_id is the ID of the email address the recipient used in the email. To get\n                        the ID of the email address, first make a request to /EmailAddresses POST. If this\n                        argument is not provided, then the primary email address of the parent record is used.\n                    \n                False\n            \n                attachments\n            \n                Object\n            \n                The email's attachments. Existing Notes records cannot be used as email attachments; only the\n                create action is supported. Metadata about each attachment is required to link the records.\n                \nfilename_guid is the temporary file ID for an uploaded file to attach as a Notes record.\n                    \nupload_id is the ID of an existing file that the Notes record should reference as the\n                        attachment. This allows files to be shared by multiple Notes records, to preserve space.\n                    \n                        When using upload_id, file_source should be provided to indicate from where the\n                        file originated. The value should be the module of the record that shares its ID with the file.\n                        So when an attachment comes from an email template, file_source should be\n                        EmailTemplates. And when an attachment comes from a document, file_source should\n                        be DocumentRevisions.\n                    \n                False\n            \nRequest\n{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html"}
{"id": "22c3f85f0230-9", "text": "be DocumentRevisions.\n                    \n                False\n            \nRequest\n{\n  \"state\": \"Draft\",\n  \"outbound_email_id\": \"b80adf1a-7d78-11e7-855a-3c15c2d582c6\",\n  \"name\": \"Re: Discuss Proposal\",\n  \"description_html\": \"<p>Calling you now.</p>\",\n  \"reply_to_id\": \"a028341c-ba92-9343-55e7-56cf5beda121\",\n  \"parent_type\": \"Leads\",\n  \"parent_id\": \"f6a0611a-7d27-11e7-9d70-3c15c2d582c6\",\n  \"to\": {\n    \"create\": [{\n      \"parent_type\": \"Leads\",\n      \"parent_id\": \"f6a0611a-7d27-11e7-9d70-3c15c2d582c6\"\n    }]\n  },\n  \"cc\": {\n    \"create\": [{\n      \"parent_type\": \"Contacts\",\n      \"parent_id\": \"79b9c194-7d79-11e7-8fc5-3c15c2d582c6\"\n    }, {\n      \"parent_type\": \"Users\",\n      \"parent_id\": \"79c2e800-7d79-11e7-84af-3c15c2d582c6\"\n      \"email_address_id\": \"79cc341e-7d79-11e7-8748-3c15c2d582c6\"\n    }]\n  },\n  \"bcc\": {\n    \"create\": [{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html"}
{"id": "22c3f85f0230-10", "text": "}]\n  },\n  \"bcc\": {\n    \"create\": [{\n      \"email_address_id\": \"ac804842-7d78-11e7-a809-3c15c2d582c6\"\n    }]\n  },\n  \"attachments\": {\n    \"create\": [{\n      \"upload_id\": \"a028341c-ba92-9343-55e7-56cf5beda121\",\n      \"name\": \"Contract.pdf\",\n      \"filename\": \"Contract.pdf\",\n      \"file_source\": \"DocumentRevisions\"\n    }, {\n      \"upload_id\": \"18a72782-4514-11e6-a5f7-3c15c2d582c6\",\n      \"name\": \"survey.doc\",\n      \"filename\": \"survey.doc\",\n      \"file_source\": \"EmailTemplates\"\n    }]\n  }\n}\nResponse\n{\n  \"id\": \"f3c85966-7d27-11e7-9e9e-3c15c2d582c6\",\n  \"date_entered\": \"2016-02-25T11:53:07-08:00\",\n  \"created_by\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"created_by_name\": \"Sarah Smith\",\n  \"date_modified\": \"2016-02-25T11:53:07-08:00\",\n  \"modified_by_name\": \"Sarah Smith\",\n  \"modified_user_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"deleted\": false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html"}
{"id": "22c3f85f0230-11", "text": "\"deleted\": false,\n  \"assigned_user_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"assigned_user_name\": \"Sarah Smith\",\n  \"state\": \"Draft\",\n  \"outbound_email_id\": \"b80adf1a-7d78-11e7-855a-3c15c2d582c6\",\n  \"name\": \"Re: Discuss Proposal\",\n  \"description\": \"Now is a good time\",\n  \"description_html\": \"<p>Now is a good time</p>\",\n  \"date_sent\": \"2012-02-17T11:53:07-08:00\",\n  \"message_id\": \"\",\n  \"message_uid\": \"\",\n  \"reply_to_id\": \"a028341c-ba92-9343-55e7-56cf5beda121\",\n  \"reply_to_status\": false,\n  \"total_attachments\": 2,\n  \"parent_name\": \"Tom Davis\",\n  \"parent_type\": \"Leads\",\n  \"parent_id\": \"f6a0611a-7d27-11e7-9d70-3c15c2d582c6\"\n  \"team_count\": \"\",\n  \"team_name\": [{\n    \"id\": 1,\n    \"name\": \"Global\",\n    \"name_2\": \"\",\n    \"primary\": true,\n    \"selected\": false\n  }],\n  \"my_favorite\": false,\n  \"_acl\": {\n    \"fields\": {}\n  },\n  \"_module\": \"Emails\"\n}\nSending an Email\nRequest Arguments\nName\nType\nDescription\nRequired\n                state\n            \n                String", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html"}
{"id": "22c3f85f0230-12", "text": "Name\nType\nDescription\nRequired\n                state\n            \n                String\n            \n                Use \"Ready\" to send an email.\n            \n                True\n            \n                outbound_email_id\n            \n                String\n            \n                The ID of the chosen SMTP configuration for sending an email. Only use this field when saving a draft\n                or sending an email. The user's default SMTP configuration is used if one hasn't been chosen prior to\n                sending.\n            \n                False\n            \n                name\n            \n                String\n            \n                The email's subject.\n            \n                False\n            \n                description_html\n            \n                String\n            \n                The email's HTML body.\n            \n                False\n            \n                description\n            \n                String\n            \n                The email's plain text body. This field is not necessary unless the text body is different from the HTML\n                body.\n            \n                False\n            \n                reply_to_id\n            \n                String\n            \n                Only use this field when saving a draft or sending an email that is a reply to another email. This is\n                the ID of that other email.\n            \n                False\n            \n                parent_type\n            \n                String\n            \n                The parent record's module.\n            \n                False\n            \n                parent_id\n            \n                String\n            \n                The parent record's ID.\n            \n                False\n            \n                to\n            \n                Object\n            \n                The email's recipients found in the TO field. Existing EmailParticipants records cannot be used; only\n                the create action is supported. Metadata about each recipient is required to link the records.\n                \nparent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,\n                        or Users, out out of the box. These fields are not necessary if only an email address is known", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html"}
{"id": "22c3f85f0230-13", "text": "for the recipient.\n                    \nemail_address_id is the ID of the email address the recipient used in the email. To get\n                        the ID of the email address, first make a request to /EmailAddresses POST. If this\n                        argument is not provided, then the primary email address of the parent record is used.\n                    \n                False\n            \n                cc\n            \n                Object\n            \n                The email's recipients found in the CC field. Existing EmailParticipants records cannot be used; only\n                the create action is supported. Metadata about each recipient is required to link the records.\n                \nparent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,\n                        or Users, out out of the box. These fields are not necessary if only an email address is known\n                        for the recipient.\n                    \nemail_address_id is the ID of the email address the recipient used in the email. To get\n                        the ID of the email address, first make a request to /EmailAddresses POST. If this\n                        argument is not provided, then the primary email address of the parent record is used.\n                    \n                False\n            \n                bcc\n            \n                Object\n            \n                The email's recipients found in the BCC field. Existing EmailParticipants records cannot be used; only\n                the create action is supported. Metadata about each recipient is required to link the records.\n                \nparent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,\n                        or Users, out out of the box. These fields are not necessary if only an email address is known\n                        for the recipient.\n                    \nemail_address_id is the ID of the email address the recipient used in the email. To get\n                        the ID of the email address, first make a request to /EmailAddresses POST. If this", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html"}
{"id": "22c3f85f0230-14", "text": "argument is not provided, then the primary email address of the parent record is used.\n                    \n                False\n            \n                attachments\n            \n                Object\n            \n                The email's attachments. Existing Notes records cannot be used as email attachments; only the\n                create action is supported. Metadata about each attachment is required to link the records.\n                \nfilename_guid is the temporary file ID for an uploaded file to attach as a Notes record.\n                    \nupload_id is the ID of an existing file that the Notes record should reference as the\n                        attachment. This allows files to be shared by multiple Notes records, to preserve space.\n                    \n                        When using upload_id, file_source should be provided to indicate from where the\n                        file originated. The value should be the module of the record that shares its ID with the file.\n                        So when an attachment comes from an email template, file_source should be\n                        EmailTemplates. And when an attachment comes from a document, file_source should\n                        be DocumentRevisions.\n                    \n                False\n            \nRequest\n{\n  \"state\": \"Ready\",\n  \"outbound_email_id\": \"b80adf1a-7d78-11e7-855a-3c15c2d582c6\",\n  \"name\": \"Discuss Proposal\",\n  \"description_html\": \"<p>When is a good time for us to chat?</p>\",\n  \"parent_type\": \"Leads\",\n  \"parent_id\": \"f6a0611a-7d27-11e7-9d70-3c15c2d582c6\",\n  \"to\": {\n    \"create\": [{\n      \"parent_type\": \"Leads\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html"}
{"id": "22c3f85f0230-15", "text": "\"create\": [{\n      \"parent_type\": \"Leads\",\n      \"parent_id\": \"f6a0611a-7d27-11e7-9d70-3c15c2d582c6\"\n    }]\n  },\n  \"cc\": {\n    \"create\": [{\n      \"parent_type\": \"Users\",\n      \"parent_id\": \"79c2e800-7d79-11e7-84af-3c15c2d582c6\"\n      \"email_address_id\": \"79cc341e-7d79-11e7-8748-3c15c2d582c6\"\n    }]\n  },\n  \"attachments\": {\n    \"create\": [{\n      \"upload_id\": \"a028341c-ba92-9343-55e7-56cf5beda121\",\n      \"name\": \"Contract.pdf\",\n      \"filename\": \"Contract.pdf\",\n      \"file_source\": \"DocumentRevisions\"\n    }, {\n      \"upload_id\": \"18a72782-4514-11e6-a5f7-3c15c2d582c6\",\n      \"name\": \"survey.doc\",\n      \"filename\": \"survey.doc\",\n      \"file_source\": \"EmailTemplates\"\n    }]\n  }\n}\nResponse\n{\n  \"id\": \"a7795664-7def-11e7-8add-3c15c2d582c6\",\n  \"date_entered\": \"2016-02-25T08:53:07-08:00\",\n  \"created_by\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"created_by_name\": \"Sarah Smith\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html"}
{"id": "22c3f85f0230-16", "text": "\"created_by_name\": \"Sarah Smith\",\n  \"date_modified\": \"2016-02-25T08:53:07-08:00\",\n  \"modified_by_name\": \"Sarah Smith\",\n  \"modified_user_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"deleted\": false,\n  \"assigned_user_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"assigned_user_name\": \"Sarah Smith\",\n  \"state\": \"Archived\",\n  \"outbound_email_id\": \"b80adf1a-7d78-11e7-855a-3c15c2d582c6\",\n  \"name\": \"Discuss Proposal\",\n  \"description\": \"When is a good time for us to chat?\",\n  \"description_html\": \"<p>When is a good time for us to chat?</p>\",\n  \"date_sent\": \"2012-02-17T08:53:07-08:00\",\n  \"message_id\": \"<a7795664-7def-11e7-8add-3c15c2d582c6@example.com>\",\n  \"message_uid\": \"\",\n  \"reply_to_id\": \"\",\n  \"reply_to_status\": false,\n  \"total_attachments\": 2,\n  \"parent_name\": \"Tom Davis\",\n  \"parent_type\": \"Leads\",\n  \"parent_id\": \"f6a0611a-7d27-11e7-9d70-3c15c2d582c6\"\n  \"team_count\": \"\",\n  \"team_name\": [{\n    \"id\": 1,\n    \"name\": \"Global\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html"}
{"id": "22c3f85f0230-17", "text": "\"id\": 1,\n    \"name\": \"Global\",\n    \"name_2\": \"\",\n    \"primary\": true,\n    \"selected\": false\n  }],\n  \"my_favorite\": false,\n  \"_acl\": {\n    \"fields\": {}\n  },\n  \"_module\": \"Emails\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Emails POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_POST/index.html"}
{"id": "3dfd1d651fb1-0", "text": "/Contact/:record/Cases GET\nOverview\nGet a contact's related cases, filtered by an expression, which are accessible to a contact with portal visibility.\nSummary\nThis endpoint will return a set of cases filtered by an expression which are accessible to a contact with portal visibility. The filter can be applied to multiple fields and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its ID. If both a filter definition and a filter ID are passed, the two filters will be joined with anAND. Care will need to be taken to make sure that any filters used have appropriate indexes on the server side, otherwise the runtime of the endpoint will be very long.\nRequest\n        GET /Contact/:id/Cases\nRequest Arguments\nName\nType\nDescription\nRequired\nfilter\nString\nSee the Filter API for details.\nFalse\nfilter_id\nString\nIdentifier for a pre-existing filter. See the Filter API for details.\nFalse\nmax_num\nInteger\nMax number of records that can be returned. Default is 20, unless overruled by your Sugar configuration.\nFalse\noffset\nInteger\nThe number of records to skip over before records are returned. Default is 0.\nFalse\nfields\nString\nComma delimited list of fields to return. Each field may be represented either by string, or by map containing field name and additional field parameters (applicable to link and collection fields). The field's ID and date_modified will always be returned. For more details on additional field parameters, see the Relate API and Collection API.\nFalse\norder_by\nString\nSee the Filter API.\nFalse\ndeleted\nBoolean\nBoolean to show deleted records in the result set.\nFalse\nResponse\n{\n  \"next_offset\": -1,\n  \"records\": [\n    {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ContactrecordCases_GET/index.html"}
{"id": "3dfd1d651fb1-1", "text": "{\n  \"next_offset\": -1,\n  \"records\": [\n    {\n      \"id\": \"d509b3da-29f6-7b23-7cce-56fab1a6335b\",\n      \"name\": \"Need help\",\n      \"date_modified\": \"2016-03-29T09:46:00-07:00\",\n      \"_acl\": {\n        \"fields\": {}\n      },\n      \"_module\": \"Cases\"\n    },\n    {\n      \"id\": \"cc4982cd-0bdf-bad4-d079-56fab4bdddf1\",\n      \"name\": \"Having trouble\",\n      \"date_modified\": \"2016-03-29T09:57:58-07:00\",\n      \"_acl\": {\n        \"fields\": {}\n      },\n      \"_module\": \"Cases\"\n    }\n  ]\n}\nResponse Arguments\nName\nType\nDescription\nnext_offset\nInteger\nDisplays the next offset for retrieval of additional results. -1 will be returned when there are no more records.\nrecords\nArray\nAn array of results containing matched records.\nChange Log\nVersion\nChange\nv11\nAdded /Contact/:record/Cases GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ContactrecordCases_GET/index.html"}
{"id": "59277cb7381b-0", "text": "/Activities GET\nActivities on the home page\nSummary:\n  This endpoint lists activities across the entire sytstem. It uses a subscription model, and can be queried like a normal bean collection, but without search, ordering or filtering.\nQuery Parameters:\nParamDescriptionOptionalmax_numA maximum number of records to returnOptionaloffsetHow many records to skip over before records are returnedOptional\nInput Example:\nThis endpoint does not accept any input\nOutput Example:\n{\n    \"next_offset\": 20, This will be set to -1 when there are no more records after this \"page\".\n    \"records\": [{\n        \"id\": \"22fb8b16-de1d-f1dc-b15b-51240efde177\",\n        \"date_entered\": \"2013-02-19T23:47:11+00:00\",\n        \"date_modified\": \"2013-02-19T23:47:11+00:00\",\n        \"created_by\": \"1\",\n        \"deleted\": \"0\",\n        \"parent_id\": \"f5bb0331-2c0f-5c7c-b4db-5123caac0056\",\n        \"parent_type\": \"Contacts\",\n        \"activity_type\": \"post\", This will be the type of activity performed.\n        \"data\": {\n            \"value\": \"This is a test post on a contact I'm subscribed to.\"\n        },\n        \"comment_count\": 0, This will be set to the total number of comments on the post.\n        \"last_comment\": { This will be the last comment on the post, which can be used to create a comment model on the frontend.\n            \"deleted\": 0,\n            \"data\": []\n        },\n        \"fields\": [],\n        \"first_name\": null,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Activities_GET/index.html"}
{"id": "59277cb7381b-1", "text": "},\n        \"fields\": [],\n        \"first_name\": null,\n        \"last_name\": \"Administrator\",\n        \"created_by_name\": \" Administrator\" This will be the locale-formatted full name of the user.\n    }, ... ]\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Activities_GET/index.html"}
{"id": "2c85b6253656-0", "text": "/<module>/:record/movebefore/:target PUT\nOverview\n    Move existing node before target node.\nRequest Arguments\nName\nType\nDescription\nRequired\n                module\n            \n                String\n            \n                The name of sugar module that contains a nested set data and implements the NestedSetInterface.\n            \n                True\n            \n                target\n            \n                String\n            \n                The ID of record that will be used as target to move node before\n            \n                True\n            \nResponse Arguments\n    This endpoint does not return any response arguments.\nResponse\nThis endpoint return a record GUID that was moved\n\"1b7b868d-7357-2e29-7513-54169bdc444d\"\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/movebefore/:target PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordmovebeforetarget_PUT/index.html"}
{"id": "029f909c7ea2-0", "text": "/pmse_Inbox/clearLog/:typelog PUT\nOverview\n    Clear the PMSE.log file log \nSummary\n    This endpoint clears the contents of the PMSE.log file \nRequest Arguments\nThere are no request arguments for this endpoint\nResponse Arguments\nName\nType\nDescription\nnone\nboolean\nResult of the clear operation\nResponse\ntrue\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxclearLogtypelog_PUT/index.html"}
{"id": "0d692d3dae21-0", "text": "/Emails GET\nOverview\n    Lists filtered emails.\nSummary\n    Adds additional operators to Filter API that are\n    specific to Emails. A special macro, $current_user_id, is a convenience that allows for finding emails\n    involving the current user.\nFilter By Sender\n    This will return all emails sent by the current user, by the contact whose ID is\n    fa300a0e-0ad1-b322-9601-512d0983c19a, using the email address sam@example.com, which is referenced by\n    the ID b0701501-1fab-8ae7-3942-540da93f5017, or by the lead whose ID is\n    73b1087e-4bb6-11e7-acaa-3c15c2d582c6 using the email address wally@example.com, which is referenced by\n    the ID b651d834-4bb6-11e7-bfcf-3c15c2d582c6.\n{\n  \"filter\": [{\n    \"$from\": [{\n      \"parent_type\": \"Users\",\n      \"parent_id\": \"$current_user_id\"\n    }, {\n      \"parent_type\": \"Contacts\",\n      \"parent_id\": \"fa300a0e-0ad1-b322-9601-512d0983c19a\"\n    }, {\n      \"email_address_id\": \"b0701501-1fab-8ae7-3942-540da93f5017\"\n    }, {\n      \"parent_type\": \"Leads\",\n      \"parent_id\": \"73b1087e-4bb6-11e7-acaa-3c15c2d582c6\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_GET/index.html"}
{"id": "0d692d3dae21-1", "text": "\"email_address_id\": \"b651d834-4bb6-11e7-bfcf-3c15c2d582c6\"\n    }]\n  }]\n}\n    Equivalent to:\n{\n  \"filter\": [{\n    \"from_collection\": {\n      \"$in\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }, {\n        \"parent_type\": \"Contacts\",\n        \"parent_id\": \"fa300a0e-0ad1-b322-9601-512d0983c19a\"\n      }, {\n        \"email_address_id\": \"b0701501-1fab-8ae7-3942-540da93f5017\"\n      }, {\n        \"parent_type\": \"Leads\",\n        \"parent_id\": \"73b1087e-4bb6-11e7-acaa-3c15c2d582c6\",\n        \"email_address_id\": \"b651d834-4bb6-11e7-bfcf-3c15c2d582c6\"\n      }]\n    }\n  }]\n}\nFilter By Recipients\n    This would return all archived emails received by the current user.\n{\n  \"filter\": [{\n    \"$or\": [{\n      \"$to\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }],\n      \"$cc\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }],\n      \"$bcc\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }]\n    }]\n  }, {\n    \"state\": {\n      \"$in\": [", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_GET/index.html"}
{"id": "0d692d3dae21-2", "text": "}]\n  }, {\n    \"state\": {\n      \"$in\": [\n        \"Archived\"\n      ]\n    }\n  }]\n}\n    Equivalent to:\n{\n  \"filter\": [{\n    \"$or\": [{\n      \"to_collection\": {\n        \"$in\": [{\n          \"parent_type\": \"Users\",\n          \"parent_id\": \"$current_user_id\"\n        }]\n      },\n      \"cc_collection\": {\n        \"$in\": [{\n          \"parent_type\": \"Users\",\n          \"parent_id\": \"$current_user_id\"\n        }]\n      },\n      \"bcc_collection\": {\n        \"$in\": [{\n          \"parent_type\": \"Users\",\n          \"parent_id\": \"$current_user_id\"\n        }]\n      }\n    }]\n  }, {\n    \"state\": {\n      \"$in\": [\n        \"Archived\"\n      ]\n    }\n  }]\n}\nFilter By Sender and Recipients\n    This would return all archived emails sent by a contact to the current user.\n{\n  \"filter\": [{\n    \"$from\": [{\n      \"parent_type\": \"Contacts\",\n      \"parent_id\": \"fa300a0e-0ad1-b322-9601-512d0983c19a\"\n    }]\n  }, {\n    \"$or\": [{\n      \"$to\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }],\n      \"$cc\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }],\n      \"$bcc\": [{\n        \"parent_type\": \"Users\",\n        \"parent_id\": \"$current_user_id\"\n      }]\n    }]\n  }, {\n    \"state\": {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_GET/index.html"}
{"id": "0d692d3dae21-3", "text": "}]\n    }]\n  }, {\n    \"state\": {\n      \"$in\": [\n        \"Archived\"\n      ]\n    }\n  }]\n}\n    Equivalent to:\n{\n  \"filter\": [{\n    \"from_collection\": {\n      \"$in\": [{\n        \"parent_type\": \"Contacts\",\n        \"parent_id\": \"fa300a0e-0ad1-b322-9601-512d0983c19a\"\n      }]\n    }\n  }, {\n    \"$or\": [{\n      \"to_collection\": {\n        \"$in\": [{\n          \"parent_type\": \"Users\",\n          \"parent_id\": \"$current_user_id\"\n        }]\n      },\n      \"cc_collection\": {\n        \"$in\": [{\n          \"parent_type\": \"Users\",\n          \"parent_id\": \"$current_user_id\"\n        }]\n      },\n      \"bcc_collection\": {\n        \"$in\": [{\n          \"parent_type\": \"Users\",\n          \"parent_id\": \"$current_user_id\"\n        }]\n      }\n    }]\n  }, {\n    \"state\": {\n      \"$in\": [\n        \"Archived\"\n      ]\n    }\n  }]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added the $from, $to, $cc, and $bcc operators to\n            /Emails/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emails_GET/index.html"}
{"id": "7f0cbd5d9d0f-0", "text": "/<module>/Activities/filter GET\nActivities on a module's list view\nSummary:\n  This endpoint lists activities across a particular module in the system. It uses a subscription model, and can be queried like a normal bean collection, but without search, ordering or filtering.\nQuery Parameters:\nParamDescriptionOptionalmax_numA maximum number of records to returnOptionaloffsetHow many records to skip over before records are returnedOptional\nInput Example:\nThis endpoint does not accept any input\nOutput Example:\n{\n    \"next_offset\": 20, This will be set to -1 when there are no more records after this \"page\".\n    \"records\": [{\n        \"id\": \"22fb8b16-de1d-f1dc-b15b-51240efde177\",\n        \"date_entered\": \"2013-02-19T23:47:11+00:00\",\n        \"date_modified\": \"2013-02-19T23:47:11+00:00\",\n        \"created_by\": \"1\",\n        \"deleted\": \"0\",\n        \"parent_id\": \"f5bb0331-2c0f-5c7c-b4db-5123caac0056\",\n        \"parent_type\": \"Contacts\",\n        \"activity_type\": \"post\", This will be the type of activity performed.\n        \"data\": {\n            \"value\": \"This is a test post on a contact I'm subscribed to.\"\n        },\n        \"comment_count\": 0, This will be set to the total number of comments on the post.\n        \"last_comment\": { This will be the last comment on the post, which can be used to create a comment model on the frontend.\n            \"deleted\": 0,\n            \"data\": []\n        },\n        \"fields\": [],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleActivitiesfilter_GET/index.html"}
{"id": "7f0cbd5d9d0f-1", "text": "\"data\": []\n        },\n        \"fields\": [],\n        \"first_name\": null,\n        \"last_name\": \"Administrator\",\n        \"created_by_name\": \" Administrator\" This will be the locale-formatted full name of the user.\n    }, ... ]\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleActivitiesfilter_GET/index.html"}
{"id": "29bceddd503d-0", "text": "/Teams/:record/link POST\nOverview\n    Creates relationships to a pre-existing record.\nRequest Arguments\nName\nType\nDescription\nRequired\n            <relationship link>\n        \n            <string>\n        \n            Link between targeted and related records.\n        \n            True\n        \n            <record ID>\n        \n            <string>\n        \n            The name value list of related records. Each item of the list may be either string equal to related item ID,\n            or map containing record ID (\"id\" key is required in this case)\n            and addition relationship properties.\n        \n            True\n        \nRequest\n{\n    link_name: \"accounts\"\n    ids: [\n        \"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n        {\n            \"id\": \"e689173e-c953-1e14-c215-512d0927e7a2\",\n            \"role\": \"owner\"\n        }\n    ]\n}\nResponse Arguments\nName\nType\nDescription\n            record\n        \n            Array\n        \n            The record linked to related records.\n        \n            related_records\n        \n            Array\n        \n            Records that were associated.\n        \nResponse\n    \"record\": {\n        \"id\": \"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n        \"name\": \"Slender Broadband Inc - 1000 units\",\n        \"date_entered\": \"2013-02-26T19:12:00+00:00\",\n        \"date_modified\": \"2013-02-26T19:12:00+00:00\",\n        \"modified_user_id\": \"1\",\n        \"modified_by_name\": \"Administrator\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html"}
{"id": "29bceddd503d-1", "text": "\"modified_user_id\": \"1\",\n        \"modified_by_name\": \"Administrator\",\n        \"created_by\": \"1\",\n        \"created_by_name\": \"Administrator\",\n        \"description\": \"\",\n        \"img\": \"\",\n        \"last_activity_date\": \"2013-02-28T18:21:00+00:00\",\n        \"deleted\": false,\n        \"assigned_user_id\": \"seed_max_id\",\n        \"assigned_user_name\": \"Max Jensen\",\n        \"team_name\": [\n            {\n                \"id\": \"East\",\n                \"name\": \"East\",\n                \"name_2\": \"\",\n                \"primary\": false\n            },\n            {\n                \"id\": \"West\",\n                \"name\": \"West\",\n                \"name_2\": \"\",\n                \"primary\": true\n            }\n        ],\n        \"opportunity_type\": \"\",\n        \"account_name\": \"Slender Broadband Inc\",\n        \"account_id\": \"181461c6-dc81-1115-1fe0-512d092e8f15\",\n        \"campaign_id\": \"\",\n        \"campaign_name\": \"\",\n        \"lead_source\": \"Campaign\",\n        \"amount\": \"25000\",\n        \"base_rate\": \"1\",\n        \"amount_usdollar\": \"25000\",\n        \"currency_id\": \"-99\",\n        \"currency_name\": \"\",\n        \"currency_symbol\": \"\",\n        \"date_closed\": \"2013-02-27\",\n        \"date_closed_timestamp\": \"1361992480\",\n        \"next_step\": \"\",\n        \"sales_stage\": \"Needs Analysis\",\n        \"sales_status\": \"New\",\n        \"probability\": \"90\",\n        \"best_case\": \"25000\",\n        \"worst_case\": \"25000\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html"}
{"id": "29bceddd503d-2", "text": "\"worst_case\": \"25000\",\n        \"commit_stage\": \"include\",\n        \"my_favorite\": false,\n        \"_acl\": {\n            \"fields\": {\n            }\n        }\n    },\n    \"related_records\": [\n        {\n            \"id\": \"e689173e-c953-1e14-c215-512d0927e7a2\",\n            \"name\": \"Gus Dales\",\n            \"date_entered\": \"2013-02-26T19:12:00+00:00\",\n            \"date_modified\": \"2013-02-26T19:12:00+00:00\",\n            \"modified_user_id\": \"1\",\n            \"modified_by_name\": \"Administrator\",\n            \"created_by\": \"1\",\n            \"created_by_name\": \"Administrator\",\n            \"description\": \"\",\n            \"img\": \"\",\n            \"deleted\": false,\n            \"assigned_user_id\": \"seed_sally_id\",\n            \"assigned_user_name\": \"Sally Bronsen\",\n            \"team_name\": [\n                {\n                    \"id\": \"West\",\n                    \"name\": \"West\",\n                    \"name_2\": \"\",\n                    \"primary\": true\n                }\n            ],\n            \"salutation\": \"\",\n            \"first_name\": \"Gus\",\n            \"last_name\": \"Dales\",\n            \"full_name\": \"Gus Dales\",\n            \"title\": \"Director Operations\",\n            \"linkedin\": \"\",\n            \"facebook\": \"\",\n            \"twitter\": \"\",\n            \"googleplus\": \"\",\n            \"department\": \"\",\n            \"do_not_call\": false,\n            \"phone_home\": \"(661) 120-2292\",\n            \"email\": [\n                {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html"}
{"id": "29bceddd503d-3", "text": "\"email\": [\n                {\n                    \"email_address\": \"section.sugar.section@example.it\",\n                    \"opt_out\": \"1\",\n                    \"invalid_email\": \"0\",\n                    \"primary_address\": \"0\"\n                },\n                {\n                    \"email_address\": \"support.qa.kid@example.co.uk\",\n                    \"opt_out\": \"0\",\n                    \"invalid_email\": \"0\",\n                    \"primary_address\": \"1\"\n                }\n            ],\n            \"phone_mobile\": \"(294) 447-9707\",\n            \"phone_work\": \"(036) 840-3216\",\n            \"phone_other\": \"\",\n            \"phone_fax\": \"\",\n            \"email1\": \"support.qa.kid@example.co.uk\",\n            \"email2\": \"section.sugar.section@example.it\",\n            \"invalid_email\": false,\n            \"email_opt_out\": false,\n            \"primary_address_street\": \"48920 San Carlos Ave\",\n            \"primary_address_street_2\": \"\",\n            \"primary_address_street_3\": \"\",\n            \"primary_address_city\": \"Persistance\",\n            \"primary_address_state\": \"CA\",\n            \"primary_address_postalcode\": \"54556\",\n            \"primary_address_country\": \"USA\",\n            \"alt_address_street\": \"\",\n            \"alt_address_street_2\": \"\",\n            \"alt_address_street_3\": \"\",\n            \"alt_address_city\": \"\",\n            \"alt_address_state\": \"\",\n            \"alt_address_postalcode\": \"\",\n            \"alt_address_country\": \"\",\n            \"assistant\": \"\",\n            \"assistant_phone\": \"\",\n            \"picture\": \"\",\n            \"email_and_name1\": \"\",\n            \"lead_source\": \"Support Portal User Registration\",\n            \"account_name\": \"Arts & Crafts Inc\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html"}
{"id": "29bceddd503d-4", "text": "\"account_name\": \"Arts & Crafts Inc\",\n            \"account_id\": \"d43243c6-9b8e-2973-aee2-512d09bc34b4\",\n            \"opportunity_role_fields\": \"\",\n            \"opportunity_role_id\": \"\",\n            \"opportunity_role\": \"Technical Advisor\",\n            \"reports_to_id\": \"\",\n            \"report_to_name\": \"\",\n            \"portal_name\": \"GusDales145\",\n            \"portal_active\": true,\n            \"portal_password\": \"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0\",\n            \"portal_password1\": \"\",\n            \"portal_app\": \"\",\n            \"preferred_language\": \"en_us\",\n            \"campaign_id\": \"\",\n            \"campaign_name\": \"\",\n            \"c_accept_status_fields\": \"\",\n            \"m_accept_status_fields\": \"\",\n            \"accept_status_id\": \"\",\n            \"accept_status_name\": \"\",\n            \"sync_contact\": \"\",\n            \"my_favorite\": false,\n            \"_acl\": {\n                \"fields\": {\n                }\n            }\n        },\n        {\n            \"id\": \"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n            \"name\": \"Slender Broadband Inc - 1000 units\",\n            \"date_entered\": \"2013-02-26T19:12:00+00:00\",\n            \"date_modified\": \"2013-02-26T19:12:00+00:00\",\n            \"modified_user_id\": \"1\",\n            \"modified_by_name\": \"Administrator\",\n            \"created_by\": \"1\",\n            \"created_by_name\": \"Administrator\",\n            \"description\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html"}
{"id": "29bceddd503d-5", "text": "\"created_by_name\": \"Administrator\",\n            \"description\": \"\",\n            \"img\": \"\",\n            \"last_activity_date\": \"2013-02-28T18:36:00+00:00\",\n            \"deleted\": false,\n            \"assigned_user_id\": \"seed_max_id\",\n            \"assigned_user_name\": \"Max Jensen\",\n            \"team_name\": [\n                {\n                    \"id\": \"East\",\n                    \"name\": \"East\",\n                    \"name_2\": \"\",\n                    \"primary\": false\n                },\n                {\n                    \"id\": \"West\",\n                    \"name\": \"West\",\n                    \"name_2\": \"\",\n                    \"primary\": true\n                }\n            ],\n            \"opportunity_type\": \"\",\n            \"account_name\": \"Slender Broadband Inc\",\n            \"account_id\": \"181461c6-dc81-1115-1fe0-512d092e8f15\",\n            \"campaign_id\": \"\",\n            \"campaign_name\": \"\",\n            \"lead_source\": \"Campaign\",\n            \"amount\": \"25000\",\n            \"base_rate\": \"1\",\n            \"amount_usdollar\": \"25000\",\n            \"currency_id\": \"-99\",\n            \"currency_name\": \"\",\n            \"currency_symbol\": \"\",\n            \"date_closed\": \"2013-02-27\",\n            \"date_closed_timestamp\": \"1361992480\",\n            \"next_step\": \"\",\n            \"sales_stage\": \"Needs Analysis\",\n            \"sales_status\": \"New\",\n            \"probability\": \"90\",\n            \"best_case\": \"25000\",\n            \"worst_case\": \"25000\",\n            \"commit_stage\": \"include\",\n            \"my_favorite\": false,\n            \"_acl\": {\n                \"fields\": {\n                }", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html"}
{"id": "29bceddd503d-6", "text": "\"_acl\": {\n                \"fields\": {\n                }\n            }\n        }\n    ]\n}\nChange Log\nVersion\nChange\n            v10 (7.6.0)\n        \n            Added support for additional relationship values.\n        \n            v10 (7.1.5)\n        \n            Added /<module>/:record/link POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html"}
{"id": "83fd947a57b6-0", "text": "/<module>/:record/moveafter/:target PUT\nOverview\n    Move existing node after target node.\nRequest Arguments\nName\nType\nDescription\nRequired\n                module\n            \n                String\n            \n                The name of sugar module that contains a nested set data and implements the NestedSetInterface.\n            \n                True\n            \n                target\n            \n                String\n            \n                The ID of record that will be used as target to move node after\n            \n                True\n            \nResponse Arguments\n    This endpoint does not return any response arguments.\nResponse\nThis endpoint return a record GUID that was moved\n\"1b7b868d-7357-2e29-7513-54169bdc444d\"\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/moveafter/:target PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordmoveaftertarget_PUT/index.html"}
{"id": "abd9cab39403-0", "text": "/Administration/elasticsearch/mapping GET\nOverview\n    [ADMIN] Elasticsearch mapping\nSummary\n    This endpoint returns the mapping for every available index. This endpoint is only available to administrators.\nResponse\n{\n    \"autobr2583_shared\":{\n        \"KBDocuments\":{\n            \"dynamic\":\"false\",\n            \"_all\":{\n                \"enabled\":false\n            },\n            \"properties\":{\n                \"kbdocument_name\":{\n                    \"type\":\"string\",\n                    \"index\":\"not_analyzed\",\n                    \"fields\":{\n                        \"gs_string_default\":{\n                            \"type\":\"string\",\n                            \"analyzer\":\"gs_analyzer_default\"\n                        },\n                        \"gs_string_ngram\":{\n                            \"type\":\"string\",\n                            \"index_analyzer\":\"gs_analyzer_ngram\",\n                            \"search_analyzer\":\"gs_analyzer_default\"\n                        }\n                    }\n                }\n            }\n        },\n        \"RevenueLineItems\":{\n            \"dynamic\":\"false\",\n            \"_all\":{\n                \"enabled\":false\n            },\n            \"properties\":{\n                \"date_modified\":{\n                    \"type\":\"string\",\n                    \"index\":\"not_analyzed\",\n                    \"fields\":{\n                        \"gs_datetime\":{\n                            \"type\":\"date\",\n                            \"index\":\"no\",\n                            \"format\":\"YYYY-MM-dd HH:mm:ss\"\n                        }\n                    }\n                },\n                \"description\":{\n                    \"type\":\"string\",\n                    \"index\":\"not_analyzed\",\n                    \"fields\":{\n                        \"gs_string_default\":{\n                            \"type\":\"string\",\n                            \"analyzer\":\"gs_analyzer_default\"\n                        },\n                        \"gs_string_ngram\":{\n                            \"type\":\"string\",\n                            \"index_analyzer\":\"gs_analyzer_ngram\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchmapping_GET/index.html"}
{"id": "abd9cab39403-1", "text": "\"type\":\"string\",\n                            \"index_analyzer\":\"gs_analyzer_ngram\",\n                            \"search_analyzer\":\"gs_analyzer_default\"\n                        }\n                    }\n                }\n            }\n        }\n    }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Administration/elasticsearch/mapping GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchmapping_GET/index.html"}
{"id": "176051a7d13e-0", "text": "/pmse_Project/EventDefinition/:record PUT\nOverview\n    Updates the definition data for an event\nSummary\n    This endpoint will update the Process Definition event identified by the\n    record input parameter with the data provided in the request\n    payload.\nRequest Arguments\nName\nType\nDescription\nRequired\nrecord\nString\nThe value for the evn_uid field in the pmse_bpmn_event record\nTrue\nRequest Payload\n    There are 5 event types in SugarBPMTM.\nStart Event\n{\n    \"data\":\n    {\n        \"evn_module\":\"Accounts\",\n        \"evn_params\":\"updated\",\n        \"evn_criteria\":null\n    }\n}\nTimer Event\n{\n    \"data\":\n    {\n        \"evn_timer_type\":\"duration\",\n        \"evn_duration_criteria\":\"10\",\n        \"evn_duration_params\":\"minute\",\n        \"evn_criteria\":null\n    }\n}\nReceive Message Event\n{\n    \"data\":\n    {\n        \"evn_criteria\":[\n            {\n              \"expType\":\"MODULE\",\n              \"expSubtype\":\"DropDown\",\n              \"expLabel\":\"Accounts (Industry is equal to Banking)\",\n              \"expValue\":\"Banking\",\n              \"expOperator\":\"equals\",\n              \"expModule\":\"Accounts\",\n              \"expField\":\"industry\"\n            }\n        ]\n    }\n}\nSend Message Event\n{\n    \"data\":\n    {\n        \"evn_module\":\"Accounts\",\n        \"evn_criteria\":\"8444baae-c73f-11e8-afa5-6c400895ea84\",\n        \"evn_params\":\n        {\n            \"to\":[\n               {\n                  \"type\":\"recipient\",\n                  \"module\":\"calls\",\n                  \"moduleLabel\":\"Calls\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_PUT/index.html"}
{"id": "176051a7d13e-1", "text": "\"module\":\"calls\",\n                  \"moduleLabel\":\"Calls\",\n                  \"value\":\"email1\",\n                  \"label\":\"%MODULE% : Email Address\",\n                  \"filter\":{\n                     \"expType\":\"MODULE\",\n                     \"expSubtype\":\"DropDown\",\n                     \"expLabel\":\"Calls (Status is equal to Scheduled)\",\n                     \"expValue\":\"Planned\",\n                     \"expOperator\":\"equals\",\n                     \"expModule\":\"calls\",\n                     \"expField\":\"status\"\n                  },\n                  \"chainedRelationship\":{\n                     \"module\":\"contact_parent\",\n                     \"moduleLabel\":\"Contacts\",\n                     \"filter\":{\n                        \"expType\":\"MODULE\",\n                        \"expSubtype\":\"DropDown\",\n                        \"expLabel\":\"Contacts (Lead Source is equal to Cold Call)\",\n                        \"expValue\":\"Cold Call\",\n                        \"expOperator\":\"equals\",\n                        \"expModule\":\"contact_parent\",\n                        \"expField\":\"lead_source\"\n                     }\n                  }\n               }\n            ],\n            \"cc\":[],\n            \"bcc\":[]\n        }\n    }\n}\nEnd Event\n{\n   \"data\":{\n      \"activities\":{\n      },\n      \"events\":{\n         \"4849630305bb7e68ae078d5012588603\":{\n            \"evn_uid\":\"4849630305bb7e68ae078d5012588603\",\n            \"evn_behavior\":\"THROW\",\n            \"evn_marker\":\"EMPTY\",\n            \"evn_message\":\"\",\n            \"action\":\"UPDATE\"\n         }\n      },\n      \"gateways\":{\n      },\n      \"flows\":{\n      },\n      \"artifacts\":{\n      },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_PUT/index.html"}
{"id": "176051a7d13e-2", "text": "\"flows\":{\n      },\n      \"artifacts\":{\n      },\n      \"prj_uid\":\"389d3d5a-c8ee-11e8-bc27-6c400895ea84\"\n   },\n   \"id\":\"389d3d5a-c8ee-11e8-bc27-6c400895ea84\",\n   \"operation\":\"update\",\n   \"wrapper\":\"Project\"\n}\nResponse Arguments\nName\nType\nDescription\nN/A\nResponse\nnull\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_PUT/index.html"}
{"id": "f17a38327495-0", "text": "/KBContents/duplicateCheck POST\nOverview\n    Runs a duplicate check against specified data.\nRequest Arguments\nName\nType\nDescription\nRequired\n            <record field>\n        \n            <record field type>\n        \n            The name value list of fields to populate.\n        \n            True\n        \nRequest\n{\n    \"name\":\"Airline\"\n}\nResponse Arguments\nName\nType\nDescription\n            <record field>\n        \n            <record field type>\n        \n            Returns the potential duplicate records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"c4c26496-5dbc-67dd-bf5c-512d0923889e\",\n         \"name\":\"Airline Maintenance Co\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"last_activity_date\":\"2013-02-26T19:12:00+00:00\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsduplicateCheck_POST/index.html"}
{"id": "f17a38327495-1", "text": "\"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"account_type\":\"Customer\",\n         \"industry\":\"Other\",\n         \"annual_revenue\":\"\",\n         \"phone_fax\":\"\",\n         \"billing_address_street\":\"123 Anywhere Street\",\n         \"billing_address_street_2\":\"\",\n         \"billing_address_street_3\":\"\",\n         \"billing_address_street_4\":\"\",\n         \"billing_address_city\":\"Sunnyvale\",\n         \"billing_address_state\":\"CA\",\n         \"billing_address_postalcode\":\"48566\",\n         \"billing_address_country\":\"USA\",\n         \"rating\":\"\",\n         \"phone_office\":\"(648) 452-3486\",\n         \"phone_alternate\":\"\",\n         \"website\":\"www.kidqa.it\",\n         \"ownership\":\"\",\n         \"employees\":\"\",\n         \"ticker_symbol\":\"\",\n         \"shipping_address_street\":\"123 Anywhere Street\",\n         \"shipping_address_street_2\":\"\",\n         \"shipping_address_street_3\":\"\",\n         \"shipping_address_street_4\":\"\",\n         \"shipping_address_city\":\"Sunnyvale\",\n         \"shipping_address_state\":\"CA\",\n         \"shipping_address_postalcode\":\"48566\",\n         \"shipping_address_country\":\"USA\",\n         \"email1\":\"vegan.im@example.tw\",\n         \"parent_id\":\"\",\n         \"sic_code\":\"\",\n         \"parent_name\":\"\",\n         \"email_opt_out\":false,\n         \"invalid_email\":false,\n         \"email\":[\n            {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsduplicateCheck_POST/index.html"}
{"id": "f17a38327495-2", "text": "\"invalid_email\":false,\n         \"email\":[\n            {\n               \"email_address\":\"vegan.im@example.tw\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            },\n            {\n               \"email_address\":\"phone85@example.tv\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            }\n         ],\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"duplicate_check_rank\":0\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/duplicateCheck POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsduplicateCheck_POST/index.html"}
{"id": "205f5b399519-0", "text": "/Quotes/config POST\nOverview\n    Quote Config POST Help\nSummary\n    This endpoint allows customizations to be made to the Quoted Line Items section of the Quote record.\nRequest Arguments\nName\nType\nDescription\nRequired\n            worksheet_columns\n        \n            array\n        \n            A viewdef \"fields\"-style definition of the columns you want to display in the QLI section. These get\n            written out to the custom/Products/clients/base/views/quote-data-group-list/quote-data-group-list.php file.\n        \n            True\n        \n            worksheet_column_related_fields\n        \n            array\n        \n            Array of the related field names needed for data to be returned for use by the quote-data-group-list\n        \n            True\n        \n            summary_columns\n        \n            array\n        \n            A viewdef \"fields\"-style definition of the columns you want to display in the Quote Summary header section.\n            These get written out to the\n            custom/Quotes/clients/base/views/quote-data-grand-totals-header/quote-data-grand-totals-header.php file.\n        \n            True\n        \n            summary_columns_related_fields\n        \n            array\n        \n            Array of the related field names needed for data to be\n            returned for use by the quote-data-grand-totals-header\n        \n            True\n        \n            footer_rows\n        \n            array\n        \n            A viewdef \"fields\"-style definition of the columns you want to display in the Quote Grand Totals\n            Footer section. These get written out to the\n            custom/Quotes/clients/base/views/quote-data-grand-totals-footer/quote-data-grand-totals-footer.php file.\n        \n            True\n        \n            footer_rows_related_fields\n        \n            array\n        \n            Array of the related field names needed for data to be", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html"}
{"id": "205f5b399519-1", "text": "array\n        \n            Array of the related field names needed for data to be\n            returned for use by the quote-data-grand-totals-footer\n        \n            True\n        \nSample Request\n{\n    \"summary_columns\": [\n        {\n            \"name\": \"deal_tot\",\n            \"label\": \"LBL_LIST_DEAL_TOT\",\n            \"css_class\": \"quote-totals-row-item\",\n            \"related_fields\": [\n                \"deal_tot_discount_percentage\"\n            ],\n            \"type\": \"currency\",\n            \"labelModule\": \"Quotes\"\n        },\n        {\n            \"name\": \"new_sub\",\n            \"css_class\": \"quote-totals-row-item\",\n            \"type\": \"currency\",\n            \"label\": \"LBL_NEW_SUB\",\n            \"labelModule\": \"Quotes\"\n        },\n        {\n            \"name\": \"tax\",\n            \"label\": \"LBL_TAX_TOTAL\",\n            \"css_class\": \"quote-totals-row-item\",\n            \"type\": \"currency\",\n            \"labelModule\": \"Quotes\"\n        },\n        {\n            \"name\": \"shipping\",\n            \"css_class\": \"quote-totals-row-item\",\n            \"type\": \"currency\",\n            \"label\": \"LBL_SHIPPING\",\n            \"labelModule\": \"Quotes\"\n        },\n        {\n            \"name\": \"total\",\n            \"label\": \"LBL_LIST_GRAND_TOTAL\",\n            \"css_class\": \"quote-totals-row-item\",\n            \"type\": \"currency\",\n            \"labelModule\": \"Quotes\"\n        }\n    ],\n    \"summary_columns_related_fields\": [\n        \"base_rate\",\n        \"deal_tot\",\n        \"deal_tot_usdollar\",\n        \"shipping\",\n        \"subtotal\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html"}
{"id": "205f5b399519-2", "text": "\"deal_tot_usdollar\",\n        \"shipping\",\n        \"subtotal\",\n        \"subtotal_usdollar\",\n        \"tax\",\n        \"taxable_subtotal\"\n    ],\n    \"worksheet_columns\": [\n        {\n            \"name\": \"line_num\",\n            \"label\": null,\n            \"widthClass\": \"cell-xsmall\",\n            \"css_class\": \"line_num tcenter\",\n            \"type\": \"line-num\",\n            \"readonly\": true\n        },\n        {\n            \"name\": \"quantity\",\n            \"label\": \"LBL_QUANTITY\",\n            \"widthClass\": \"cell-small\",\n            \"css_class\": \"quantity\",\n            \"type\": \"float\",\n            \"labelModule\": \"Products\"\n        },\n        {\n            \"name\": \"product_template_name\",\n            \"label\": \"LBL_ITEM_NAME\",\n            \"widthClass\": \"cell-large\",\n            \"type\": \"quote-data-relate\",\n            \"required\": true,\n            \"labelModule\": \"Quotes\"\n        },\n        {\n            \"name\": \"mft_part_num\",\n            \"label\": \"LBL_MFT_PART_NUM\",\n            \"type\": \"base\",\n            \"labelModule\": \"Products\"\n        },\n        {\n            \"name\": \"discount_price\",\n            \"label\": \"LBL_DISCOUNT_PRICE\",\n            \"type\": \"currency\",\n            \"convertToBase\": true,\n            \"showTransactionalAmount\": true,\n            \"related_fields\": [\n                \"discount_price\",\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"labelModule\": \"Products\"\n        },\n        {\n            \"name\": \"discount\",\n            \"type\": \"fieldset\",\n            \"css_class\": \"quote-discount-percent\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html"}
{"id": "205f5b399519-3", "text": "\"type\": \"fieldset\",\n            \"css_class\": \"quote-discount-percent\",\n            \"label\": \"LBL_DISCOUNT_AMOUNT\",\n            \"fields\": [\n                {\n                    \"name\": \"discount_amount\",\n                    \"label\": \"LBL_DISCOUNT_AMOUNT\",\n                    \"type\": \"discount\",\n                    \"convertToBase\": true,\n                    \"showTransactionalAmount\": true\n                },\n                {\n                    \"type\": \"discount-select\",\n                    \"name\": \"discount_select\",\n                    \"no_default_action\": true,\n                    \"buttons\": [\n                        {\n                            \"type\": \"rowaction\",\n                            \"name\": \"select_discount_amount_button\",\n                            \"label\": \"LBL_DISCOUNT_AMOUNT\",\n                            \"event\": \"button:discount_select_change:click\"\n                        },\n                        {\n                            \"type\": \"rowaction\",\n                            \"name\": \"select_discount_percent_button\",\n                            \"label\": \"LBL_DISCOUNT_PERCENT\",\n                            \"event\": \"button:discount_select_change:click\"\n                        }\n                    ],\n                    \"label\": \"LBL_DISCOUNT_AS_PERCENT\"\n                }\n            ],\n            \"labelModule\": \"Products\"\n        },\n        {\n            \"name\": \"total_amount\",\n            \"label\": \"LBL_LINE_ITEM_TOTAL\",\n            \"type\": \"currency\",\n            \"widthClass\": \"cell-medium\",\n            \"showTransactionalAmount\": true,\n            \"related_fields\": [\n                \"total_amount\",\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"labelModule\": \"Quotes\"\n        }\n    ],\n    \"worksheet_columns_related_fields\": [\n        \"base_rate\",\n        \"deal_calc\",\n        \"discount_amount\",\n        \"discount_price\",\n        \"discount_select\",\n        \"quantity\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html"}
{"id": "205f5b399519-4", "text": "\"discount_price\",\n        \"discount_select\",\n        \"quantity\",\n        \"subtotal\",\n        \"tax_class\",\n        \"total_amount\",\n        \"description\",\n        \"quote_id\",\n        \"name\",\n        \"product_template_id\",\n        \"product_template_name\"\n    ],\n    \"footer_rows\": [\n        {\n            \"name\": \"new_sub\",\n            \"type\": \"currency\"\n        },\n        {\n            \"name\": \"tax\",\n            \"type\": \"currency\"\n        },\n        {\n            \"name\": \"shipping\",\n            \"type\": \"quote-footer-currency\",\n            \"css_class\": \"quote-footer-currency\",\n            \"default\": \"0.00\"\n        },\n        {\n            \"name\": \"total\",\n            \"type\": \"currency\",\n            \"css_class\": \"grand-total\"\n        }\n    ],\n    \"footer_rows_related_fields\": [\n        \"deal_tot\",\n        \"deal_tot_usdollar\",\n        \"shipping\",\n        \"subtotal\",\n        \"subtotal_usdollar\",\n        \"tax\",\n        \"taxable_subtotal\"\n    ]\n}\nResponse Arguments\nNONE\nResponse\nSaved Config or SugarApiExceptionInvalidParameter\n{\n    \"summary_columns\": [\n        {\n            \"name\": \"deal_tot\",\n            \"label\": \"LBL_LIST_DEAL_TOT\",\n            \"css_class\": \"quote-totals-row-item\",\n            \"related_fields\": [\n                \"deal_tot_discount_percentage\"\n            ],\n            \"type\": \"currency\",\n            \"labelModule\": \"Quotes\"\n        },\n        {\n            \"name\": \"new_sub\",\n            \"css_class\": \"quote-totals-row-item\",\n            \"type\": \"currency\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html"}
{"id": "205f5b399519-5", "text": "\"type\": \"currency\",\n            \"label\": \"LBL_NEW_SUB\",\n            \"labelModule\": \"Quotes\"\n        },\n        {\n            \"name\": \"tax\",\n            \"label\": \"LBL_TAX_TOTAL\",\n            \"css_class\": \"quote-totals-row-item\",\n            \"type\": \"currency\",\n            \"labelModule\": \"Quotes\"\n        },\n        {\n            \"name\": \"shipping\",\n            \"css_class\": \"quote-totals-row-item\",\n            \"type\": \"currency\",\n            \"label\": \"LBL_SHIPPING\",\n            \"labelModule\": \"Quotes\"\n        },\n        {\n            \"name\": \"total\",\n            \"label\": \"LBL_LIST_GRAND_TOTAL\",\n            \"css_class\": \"quote-totals-row-item\",\n            \"type\": \"currency\",\n            \"labelModule\": \"Quotes\"\n        }\n    ],\n    \"worksheet_columns\": [\n        {\n            \"name\": \"line_num\",\n            \"label\": null,\n            \"widthClass\": \"cell-xsmall\",\n            \"css_class\": \"line_num tcenter\",\n            \"type\": \"line-num\",\n            \"readonly\": true\n        },\n        {\n            \"name\": \"quantity\",\n            \"label\": \"LBL_QUANTITY\",\n            \"widthClass\": \"cell-small\",\n            \"css_class\": \"quantity\",\n            \"type\": \"float\",\n            \"labelModule\": \"Products\"\n        },\n        {\n            \"name\": \"product_template_name\",\n            \"label\": \"LBL_ITEM_NAME\",\n            \"widthClass\": \"cell-large\",\n            \"type\": \"quote-data-relate\",\n            \"required\": true,\n            \"labelModule\": \"Quotes\"\n        },\n        {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html"}
{"id": "205f5b399519-6", "text": "\"labelModule\": \"Quotes\"\n        },\n        {\n            \"name\": \"mft_part_num\",\n            \"label\": \"LBL_MFT_PART_NUM\",\n            \"type\": \"base\",\n            \"labelModule\": \"Products\"\n        },\n        {\n            \"name\": \"discount_price\",\n            \"label\": \"LBL_DISCOUNT_PRICE\",\n            \"type\": \"currency\",\n            \"convertToBase\": true,\n            \"showTransactionalAmount\": true,\n            \"related_fields\": [\n                \"discount_price\",\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"labelModule\": \"Products\"\n        },\n        {\n            \"name\": \"discount\",\n            \"type\": \"fieldset\",\n            \"css_class\": \"quote-discount-percent\",\n            \"label\": \"LBL_DISCOUNT_AMOUNT\",\n            \"fields\": [\n                {\n                    \"name\": \"discount_amount\",\n                    \"label\": \"LBL_DISCOUNT_AMOUNT\",\n                    \"type\": \"discount\",\n                    \"convertToBase\": true,\n                    \"showTransactionalAmount\": true\n                },\n                {\n                    \"type\": \"discount-select\",\n                    \"name\": \"discount_select\",\n                    \"no_default_action\": true,\n                    \"buttons\": [\n                        {\n                            \"type\": \"rowaction\",\n                            \"name\": \"select_discount_amount_button\",\n                            \"label\": \"LBL_DISCOUNT_AMOUNT\",\n                            \"event\": \"button:discount_select_change:click\"\n                        },\n                        {\n                            \"type\": \"rowaction\",\n                            \"name\": \"select_discount_percent_button\",\n                            \"label\": \"LBL_DISCOUNT_PERCENT\",\n                            \"event\": \"button:discount_select_change:click\"\n                        }\n                    ],\n                    \"label\": \"LBL_DISCOUNT_AS_PERCENT\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html"}
{"id": "205f5b399519-7", "text": "}\n                    ],\n                    \"label\": \"LBL_DISCOUNT_AS_PERCENT\"\n                }\n            ],\n            \"labelModule\": \"Products\"\n        },\n        {\n            \"name\": \"total_amount\",\n            \"label\": \"LBL_LINE_ITEM_TOTAL\",\n            \"type\": \"currency\",\n            \"widthClass\": \"cell-medium\",\n            \"showTransactionalAmount\": true,\n            \"related_fields\": [\n                \"total_amount\",\n                \"currency_id\",\n                \"base_rate\"\n            ],\n            \"labelModule\": \"Quotes\"\n        }\n    ],\n    \"footer_rows\": [\n        {\n            \"name\": \"new_sub\",\n            \"type\": \"currency\"\n        },\n        {\n            \"name\": \"tax\",\n            \"type\": \"currency\"\n        },\n        {\n            \"name\": \"shipping\",\n            \"type\": \"quote-footer-currency\",\n            \"css_class\": \"quote-footer-currency\",\n            \"default\": \"0.00\"\n        },\n        {\n            \"name\": \"total\",\n            \"type\": \"currency\",\n            \"css_class\": \"grand-total\"\n        }\n    ],\n    \"summary_columns_related_fields\": [\n        \"base_rate\",\n        \"deal_tot\",\n        \"deal_tot_usdollar\",\n        \"shipping\",\n        \"subtotal\",\n        \"subtotal_usdollar\",\n        \"tax\",\n        \"taxable_subtotal\"\n    ],\n    \"worksheet_columns_related_fields\": [\n        \"base_rate\",\n        \"deal_calc\",\n        \"discount_amount\",\n        \"discount_price\",\n        \"discount_select\",\n        \"quantity\",\n        \"subtotal\",\n        \"tax_class\",\n        \"total_amount\",\n        \"description\",\n        \"quote_id\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html"}
{"id": "205f5b399519-8", "text": "\"total_amount\",\n        \"description\",\n        \"quote_id\",\n        \"name\",\n        \"product_template_id\",\n        \"product_template_name\"\n    ],\n    \"footer_rows_related_fields\": [\n        \"deal_tot\",\n        \"deal_tot_usdollar\",\n        \"shipping\",\n        \"subtotal\",\n        \"subtotal_usdollar\",\n        \"tax\",\n        \"taxable_subtotal\"\n    ]\n}\nChange Log\nVersion\nChange\n            v11.3\n        \n            Added /Quotes/config POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html"}
{"id": "81de8ae25111-0", "text": "/Meetings POST\nOverview\n    Create a single event or a series of event records.\nRequest Arguments\nName\nType\nDescription\nRequired\n            <record field>\n        \n            <record field type>\n        \n            The name value list of fields to populate.\n        \n            True\n        \nRequest\n{\n    \"name\":\"Department Meeting\",\n    \"description\":\"Weekly Department Meeting\",\n    \"date_start\":\"yyyy-mm-ddThh:mm:ss-00:00\",\n    \"date_end\":\"yyyy-mm-ddThh:mm:ss-00:00\",\n    \"repeat_type\":\"Weekly\",\n    \"repeat_interval\":\"1\",  /* Every Week */\n    \"repeat_dow\":\"25\",      /* Tue and Fri */\n    \"repeat_count\":\"4\",     /* 4 Recurrences */\n    \"repeat_until\":\"\",\n}\nResponse Arguments\nName\nDescription\nStart Date\nEnd Date\n            <record field>\n        \n            Returns the fields for the newly created record.\n        \nResponse\n{\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module> POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Meetings_POST/index.html"}
{"id": "f89a4854cc4b-0", "text": "/Mail/recipients/find GET\nOverview\n    Finds recipients that match the search term.\nRequest Arguments\nName\nType\nDescription\nRequired\n            q\n        \n            string\n        \n            The search string\n        \n            False\n        \n            module_list\n        \n            string\n        \n            One of the following strings: users, accounts, contacts, leads, prospects, all\n            Will determine which modules are searched using the given search string.\n        \n            False\n        \n            order_by\n        \n            string\n        \n            columns to sort by (one or more of $sortableColumns) with direction\n            Example: name:asc,id:desc (will sort by last_name ASC and then id DESC)\n        \n            False\n        \n            offset\n        \n            int\n        \n            Offset of first record to return\n        \n            False\n        \n            max_num\n        \n            int\n        \n            Maximum records to return\n        \n            False\n        \nRequest\n    ?q=foo&module_list=all&order_by=name:asc,id:desc&offset=1&max_num=4\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            int\n        \n            Returns the next offset to be used if paging ahead for more records\n        \n            records\n        \n            Array\n        \n            Array of records found based on the search string and module_list. Each record contains the ID, module,\n            name, email address and it's ID, opt out flag of the email address, and _acl of the recipient found.\n        \nResponse\n{\n    \"next_offset\": 3,\n    \"records\": [\n        {\n            \"id\": \"seed_sarah_id\",\n            \"_module\": \"Users\",\n            \"name\": \"Sarah Smith\",\n            \"email\": \"sarah@example.com\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailrecipientsfind_GET/index.html"}
{"id": "f89a4854cc4b-1", "text": "\"name\": \"Sarah Smith\",\n            \"email\": \"sarah@example.com\",\n            \"email_address_id\": \"962cefa8-2f1t-11e6-9bee-80e6577b09a3\",\n            \"opt_out\": false\n            \"_acl\": {\n                \"fields\": {\n                    \"assigned_user_id\": {\n                        \"write\":\"no\",\n                        \"create\":\"no\"\n                    },\n                    \"date_sent\": {\n                        \"write\":\"no\",\n                        \"create\":\"no\"\n                    }\n                }\n            }\n        },\n        {\n            \"id\": \"962cefa8-2f1f-11e6-9ade-80e6500b09a0\",\n            \"_module\": \"Leads\",\n            \"name\": \"Antonia Piermarini\",\n            \"email\": \"support.sales.vegan@example.name\",\n            \"email_address_id\": \"756yafa8-2f1t-11e6-9bee-80e6577b09a3\",\n            \"opt_out\": true\n            \"_acl\": {\n                \"fields\": {\n                    \"assigned_user_id\": {\n                        \"write\":\"no\",\n                        \"create\":\"no\"\n                    },\n                    \"date_sent\": {\n                        \"write\":\"no\",\n                        \"create\":\"no\"\n                    }\n                }\n            }\n        },\n        {\n            \"id\": \"962850e2-2f1f-11e6-804e-80e6500b09a0\",\n            \"_module\": \"Leads\",\n            \"name\": \"Santa Leffingwell\",\n            \"email\": \"vegan.vegan@example.info\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailrecipientsfind_GET/index.html"}
{"id": "f89a4854cc4b-2", "text": "\"email\": \"vegan.vegan@example.info\",\n            \"email_address_id\": \"211uhhg4-2f1t-11e6-9bee-80e6577b09a3\",\n            \"opt_out\": false\n            \"_acl\": {\n                \"fields\": {\n                    \"assigned_user_id\": {\n                        \"write\":\"no\",\n                        \"create\":\"no\"\n                    },\n                    \"date_sent\": {\n                        \"write\":\"no\",\n                        \"create\":\"no\"\n                    }\n                }\n            }\n        }\n    ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Mail/recipients/find GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailrecipientsfind_GET/index.html"}
{"id": "8cb39103441a-0", "text": "/Mail/attachment/cache DELETE\nOverview\n    Clears the user's attachment cache directory\nQuery Parameters:\n    This endpoint does not accept any parameters.\nInput Example:\n    This endpoint does not accept any input.\nOutput Example:\n    If successful, the endpoint responds with a bool of true.\nChange Log\nVersion\nChange\n            v11\n        \n            Last version in which /Mail/attachment/cache DELETE is available. Attachments are no longer\n            written as temporary files to the current user's cache directory.\n        \n            v10\n        \n            Added /Mail/attachment/cache DELETE endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailattachmentcache_DELETE/index.html"}
{"id": "2de81023794e-0", "text": "/Forecasts/init GET\nForecastsApi - init\nSummary:\n    This endpoint is used to return initialization data for the Forecasts module.\nQuery Parameters:\nParam\nDescription\nOptional\nThis endpoint does not accept any parameters.\nInput Example:\nOutput Example:\n{\n    \"initData\":\n    {\n        \"selectedUser\":\n        {\n            \"preferences\":\n            {\n                \"timezone\":\"GMT\",\n                \"datepref\":\"m\\/d\\/Y\",\n                \"timepref\":\"h:ia\",\n                \"currency_id\":\"-99\",\n                \"currency_name\":\"US Dollars\",\n                \"currency_symbol\":\"$\",\n                \"currency_iso\":\"USD\",\n                \"currency_rate\":1,\n                \"decimal_precision\":\"2\",\n                \"decimal_separator\":\".\",\n                \"number_grouping_separator\":\",\",\n                \"language\":\"en_us\",\n                \"default_teams\":\n                [{\n                    \"id\":1,\n                    \"display_name\":\"Global\",\n                    \"name\":\"Global\",\n                    \"name_2\":\"\",\n                    \"primary\":true\n                }]\n            },\n            \"module_list\":\n            [\n                \"Home\",\n                \"Accounts\",\n                \"Contacts\",\n                \"Opportunities\",\n                \"Leads\",\"Calendar\",\n                \"Reports\",\n                \"Quotes\",\n                \"Documents\",\n                \"Emails\",\n                \"Campaigns\",\n                \"Calls\",\n                \"Meetings\",\n                \"Tasks\",\n                \"Notes\",\n                \"Forecasts\",\n                \"Cases\",\n                \"Prospects\",\n                \"ProspectLists\",\n                \"Bugs\",\n                \"Employees\"\n            ],\n            \"type\":\"user\",\n            \"id\":\"seed_jim_id\",\n            \"full_name\":\"Jim Brennan\",\n            \"user_name\":\"jim\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsinit_GET/index.html"}
{"id": "2de81023794e-1", "text": "\"full_name\":\"Jim Brennan\",\n            \"user_name\":\"jim\",\n            \"picture\":\"46d1fbfb-c258-ce81-fa3a-50f809925709\",\n            \"acl\":\n            {\n                \"Forecasts\":{\"fields\":[],\"admin\":\"no\",\"_hash\":\"095777549714234c8192a7a7963c38b8\"},\n                \"ForecastWorksheets\":{\"fields\":[],\"admin\":\"no\",\"_hash\":\"095777549714234c8192a7a7963c38b8\"},\n                \"ForecastManagerWorksheets\":{\"fields\":[],\"admin\":\"no\",\"_hash\":\"095777549714234c8192a7a7963c38b8\"},\n            },\n            \"my_teams\":\n            [\n                {\"id\":\"8833dfef-c1f4-e8b3-ca3b-50f8093616be\",\"name\":\"Chris Olliver\"},\n                {\"id\":\"East\",\"name\":\"East\"},{\"id\":1,\"name\":\"Global\"},\n                {\"id\":\"4ae6baba-f356-7374-7eb4-50f809745551\",\"name\":\"Jim Brennan\"},\n                {\"id\":\"707a642a-710b-37f1-88f6-50f8098205c0\",\"name\":\"Max Jensen\"},\n                {\"id\":\"63308ab9-f663-bae8-90a5-50f80951c0fe\",\"name\":\"Sally Bronsen\"},\n                {\"id\":\"5776c705-8e6e-4bfc-44e5-50f809d12c0e\",\"name\":\"Sarah Smith\"},\n                {\"id\":\"West\",\"name\":\"West\"},", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsinit_GET/index.html"}
{"id": "2de81023794e-2", "text": "{\"id\":\"West\",\"name\":\"West\"},\n                {\"id\":\"7cf7ee0b-f88e-b566-d4d3-50f809dcb717\",\"name\":\"Will Westin\"}\n            ],\n            \"showOpps\":false,\n            \"first_name\":\"Jim\",\n            \"last_name\":\"Brennan\",\n            \"admin\":\"yes\"\n        },\n        \"forecasts_setup\":1\n    },\n    \"defaultSelections\":\n    {\n        \"timeperiod_id\":\n        {\n            \"id\":\"a2ab9ad3-2101-36f8-7ba3-50f809b3b62c\",\n            \"label\":\"Q1 (01\\/01\\/2013 - 03\\/31\\/2013)\"\n        },\n            \"ranges\":[\"include\"],\n            \"group_by\":\"forecast\",\n            \"dataset\":\"likely\"\n        }\n    }\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsinit_GET/index.html"}
{"id": "562a206e034a-0", "text": "/pmse_Emails_Templates/:/find_modules GET\nOverview\n    Get the related module list for a module\nSummary\n    This endpoint will retrieve a list of related modules that can be accessed in\n    the Process Email Templates definition from the specified module.  Input\n    parameters are passed in as the URL query string.  Pagination is supported.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule_list\nString\n                The name of the module the retrieved module list is related to.\n            \nTrue\nRequest\nrest/v11/pmse_Emails_Templates/Quotes/find_modules?module_list=Quotes\nResponse Arguments\nName\nType\nDescription\nsearch\nString\nThe value of the input module_list parameter.\nsuccess\nBoolean\nWhether the related module list has been successfully retrieved.\nresult\nArray\nAn array of related module objects.\nResponse\n{\n    \"search\":\"Quotes\",\n    \"success\":true,\n    \"result\":[\n        {\n            \"value\":\"Quotes\",\n            \"text\":\"\\u003CQuotes\\u003E\",\n            \"module\":\"Quotes\",\n            \"module_label\":\"Quotes\",\n            \"module_name\":\"Quotes\",\n            \"relationship\":\"Quotes\"\n        },\n        {\n            \"value\":\"billing_accounts\",\n            \"text\":\"Accounts (Bill to Account: billing_accounts)\",\n            \"module\":\"Accounts\",\n            \"module_label\":\"Accounts\",\n            \"module_name\":\"Accounts\",\n            \"relationship\":\"quotes_billto_accounts\"\n        },\n        {\n            \"value\":\"shipping_accounts\",\n            \"text\":\"Accounts (Ship to Account: shipping_accounts)\",\n            \"module\":\"Accounts\",\n            \"module_label\":\"Accounts\",\n            \"module_name\":\"Accounts\",\n            \"relationship\":\"quotes_shipto_accounts\"\n        },\n        {\n            \"value\":\"billing_contacts\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesfind_modules_GET/index.html"}
{"id": "562a206e034a-1", "text": "},\n        {\n            \"value\":\"billing_contacts\",\n            \"text\":\"Contacts (Bill to Contact: billing_contacts)\",\n            \"module\":\"Contacts\",\n            \"module_label\":\"Contacts\",\n            \"module_name\":\"Contacts\",\n            \"relationship\":\"quotes_contacts_billto\"\n        },\n        {\n            \"value\":\"shipping_contacts\",\n            \"text\":\"Contacts (Ship to Contact: shipping_contacts)\",\n            \"module\":\"Contacts\",\n            \"module_label\":\"Contacts\",\n            \"module_name\":\"Contacts\",\n            \"relationship\":\"quotes_contacts_shipto\"\n        },\n        {\n            \"value\":\"contracts\",\n            \"text\":\"Contracts (Contracts: contracts)\",\n            \"module\":\"Contracts\",\n            \"module_label\":\"Contracts\",\n            \"module_name\":\"Contracts\",\n            \"relationship\":\"contracts_quotes\"\n        },\n        {\n            \"value\":\"opportunities\",\n            \"text\":\"Opportunities (Opportunity: opportunities)\",\n            \"module\":\"Opportunities\",\n            \"module_label\":\"Opportunities\",\n            \"module_name\":\"Opportunities\",\n            \"relationship\":\"quotes_opportunities\"\n        },\n        {\n            \"value\":\"assigned_user_link\",\n            \"text\":\"Users (Assigned to User: assigned_user_link)\",\n            \"module\":\"Users\",\n            \"module_label\":\"Users\",\n            \"module_name\":\"Users\",\n            \"relationship\":\"quotes_assigned_user\"\n        },\n        {\n            \"value\":\"created_by_link\",\n            \"text\":\"Users (Created by User: created_by_link)\",\n            \"module\":\"Users\",\n            \"module_label\":\"Users\",\n            \"module_name\":\"Users\",\n            \"relationship\":\"quotes_created_by\"\n        },\n        {\n            \"value\":\"modified_user_link\",\n            \"text\":\"Users (Modified by User: modified_user_link)\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesfind_modules_GET/index.html"}
{"id": "562a206e034a-2", "text": "\"text\":\"Users (Modified by User: modified_user_link)\",\n            \"module\":\"Users\",\n            \"module_label\":\"Users\",\n            \"module_name\":\"Users\",\n            \"relationship\":\"quotes_modified_user\"\n        }\n    ]\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesfind_modules_GET/index.html"}
{"id": "79335b7f8051-0", "text": "/TimePeriods/filter GET\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n            Note that JSON-encoded filters can be specified as query parameters\n            in one of two ways for GET requests:\n            \n                    By specifying individual filter arguments as distinct parameters.\n                    Example: filter[0][id]=1.\n                \n                    By specifying the whole filter as a single JSON-encoded string.\n                    Note that this syntax is currently not supported on certain modules.\n                    Example: filter=[{\"id\":\"1\"}].\n                \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriodsfilter_GET/index.html"}
{"id": "79335b7f8051-1", "text": "False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. Each field may be represented either by string, or by map\n            containing field name and additional field parameters (applicable to link and collection fields).\n            The fields id and date_modified will always be returned.\n            \n            Example: name,account_type,description,{\"name\":\"opportunities\",\"fields\":[\"id\",\"name\",\"sales_status\"],\"order_by\":\"date_closed:desc\"}\n            For more details on additional field parameters, see\n            Relate API and\n            Collection API.\n        \n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \n            q\n        \n            String\n        \n            A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.\n        \n            False\n        \n            deleted\n        \n            Boolean\n        \n            Boolean to show deleted records in the result set.\n        \n            False\n        \n            nulls_last\n        \n            Boolean", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriodsfilter_GET/index.html"}
{"id": "79335b7f8051-2", "text": "False\n        \n            nulls_last\n        \n            Boolean\n        \n            Boolean to return records with null values in order_by fields last in the result set.\n        \n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\nExample\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriodsfilter_GET/index.html"}
{"id": "79335b7f8051-3", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriodsfilter_GET/index.html"}
{"id": "79335b7f8051-4", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\",\n               \"id\": \"b0701501-1fab-8ae7-3942-540da93f5017\",\n               \"name\": \"360 Vacations - 228 Units\",\n               \"date_modified\": \"2014-09-08T16:05:00+03:00\",\n               \"sales_status\": \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriodsfilter_GET/index.html"}
{"id": "79335b7f8051-5", "text": "{\n               _module: \"Opportunities\"\n               date_modified: \"2014-09-08T16:05:00+03:00\"\n               id: \"9ce7c088-8ee4-7cd3-18f1-540da944d4c0\"\n               name: \"360 Vacations - 312 Units\"\n               sales_status: \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriodsfilter_GET/index.html"}
{"id": "5c698c39e33c-0", "text": "/<module>/:record/link/:link_name/:remote_id DELETE\nOverview\n    Deletes an existing relationship between two records.\nRequest Arguments\n    This endpoint does not accept any arguments.\nResponse Arguments\nName\nType\nDescription\n            record\n        \n            Array\n        \n            The record to disassociate from the related record.\n        \n            related_record\n        \n            Array\n        \n            The record that was disassociated.\n        \nResponse\n{\n   \"record\":{\n      \"id\":\"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n      \"name\":\"Slender Broadband Inc - 1000 units\",\n      \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n      \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n      \"modified_user_id\":\"1\",\n      \"modified_by_name\":\"Administrator\",\n      \"created_by\":\"1\",\n      \"created_by_name\":\"Administrator\",\n      \"description\":\"\",\n      \"img\":\"\",\n      \"last_activity_date\":\"2013-02-28T18:36:00+00:00\",\n      \"deleted\":false,\n      \"assigned_user_id\":\"seed_max_id\",\n      \"assigned_user_name\":\"Max Jensen\",\n      \"team_name\":[\n         {\n            \"id\":\"East\",\n            \"name\":\"East\",\n            \"name_2\":\"\",\n            \"primary\":false\n         },\n         {\n            \"id\":\"West\",\n            \"name\":\"West\",\n            \"name_2\":\"\",\n            \"primary\":true\n         }\n      ],\n      \"opportunity_type\":\"\",\n      \"account_name\":\"Slender Broadband Inc\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_DELETE/index.html"}
{"id": "5c698c39e33c-1", "text": "\"opportunity_type\":\"\",\n      \"account_name\":\"Slender Broadband Inc\",\n      \"account_id\":\"181461c6-dc81-1115-1fe0-512d092e8f15\",\n      \"campaign_id\":\"\",\n      \"campaign_name\":\"\",\n      \"lead_source\":\"Campaign\",\n      \"amount\":\"25000\",\n      \"base_rate\":\"1\",\n      \"amount_usdollar\":\"25000\",\n      \"currency_id\":\"-99\",\n      \"currency_name\":\"\",\n      \"currency_symbol\":\"\",\n      \"date_closed\":\"2013-02-27\",\n      \"date_closed_timestamp\":\"1361992480\",\n      \"next_step\":\"\",\n      \"sales_stage\":\"Needs Analysis\",\n      \"sales_status\":\"New\",\n      \"probability\":\"90\",\n      \"best_case\":\"25000\",\n      \"worst_case\":\"25000\",\n      \"commit_stage\":\"include\",\n      \"my_favorite\":false,\n      \"_acl\":{\n         \"fields\":{\n         }\n      }\n   },\n   \"related_record\":{\n      \"id\":\"e689173e-c953-1e14-c215-512d0927e7a2\",\n      \"name\":\"Gus Dales\",\n      \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n      \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n      \"modified_user_id\":\"1\",\n      \"modified_by_name\":\"Administrator\",\n      \"created_by\":\"1\",\n      \"created_by_name\":\"Administrator\",\n      \"description\":\"\",\n      \"img\":\"\",\n      \"deleted\":false,\n      \"assigned_user_id\":\"seed_sally_id\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_DELETE/index.html"}
{"id": "5c698c39e33c-2", "text": "\"deleted\":false,\n      \"assigned_user_id\":\"seed_sally_id\",\n      \"assigned_user_name\":\"Sally Bronsen\",\n      \"team_name\":[\n         {\n            \"id\":\"West\",\n            \"name\":\"West\",\n            \"name_2\":\"\",\n            \"primary\":true\n         }\n      ],\n      \"salutation\":\"\",\n      \"first_name\":\"Gus\",\n      \"last_name\":\"Dales\",\n      \"full_name\":\"Gus Dales\",\n      \"title\":\"Director Operations\",\n      \"linkedin\":\"\",\n      \"facebook\":\"\",\n      \"twitter\":\"\",\n      \"googleplus\":\"\",\n      \"department\":\"\",\n      \"do_not_call\":false,\n      \"phone_home\":\"(661) 120-2292\",\n      \"email\":[\n         {\n            \"email_address\":\"section.sugar.section@example.it\",\n            \"opt_out\":\"1\",\n            \"invalid_email\":\"0\",\n            \"primary_address\":\"0\"\n         },\n         {\n            \"email_address\":\"support.qa.kid@example.co.uk\",\n            \"opt_out\":\"0\",\n            \"invalid_email\":\"0\",\n            \"primary_address\":\"1\"\n         }\n      ],\n      \"phone_mobile\":\"(294) 447-9707\",\n      \"phone_work\":\"(036) 840-3216\",\n      \"phone_other\":\"\",\n      \"phone_fax\":\"\",\n      \"email1\":\"support.qa.kid@example.co.uk\",\n      \"email2\":\"section.sugar.section@example.it\",\n      \"invalid_email\":false,\n      \"email_opt_out\":false,\n      \"primary_address_street\":\"48920 San Carlos Ave\",\n      \"primary_address_street_2\":\"\",\n      \"primary_address_street_3\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_DELETE/index.html"}
{"id": "5c698c39e33c-3", "text": "\"primary_address_street_2\":\"\",\n      \"primary_address_street_3\":\"\",\n      \"primary_address_city\":\"Persistance\",\n      \"primary_address_state\":\"CA\",\n      \"primary_address_postalcode\":\"54556\",\n      \"primary_address_country\":\"USA\",\n      \"alt_address_street\":\"\",\n      \"alt_address_street_2\":\"\",\n      \"alt_address_street_3\":\"\",\n      \"alt_address_city\":\"\",\n      \"alt_address_state\":\"\",\n      \"alt_address_postalcode\":\"\",\n      \"alt_address_country\":\"\",\n      \"assistant\":\"\",\n      \"assistant_phone\":\"\",\n      \"picture\":\"\",\n      \"email_and_name1\":\"\",\n      \"lead_source\":\"Support Portal User Registration\",\n      \"account_name\":\"Arts & Crafts Inc\",\n      \"account_id\":\"d43243c6-9b8e-2973-aee2-512d09bc34b4\",\n      \"opportunity_role_fields\":\"\",\n      \"opportunity_role_id\":\"\",\n      \"opportunity_role\":\"\",\n      \"reports_to_id\":\"\",\n      \"report_to_name\":\"\",\n      \"portal_name\":\"GusDales145\",\n      \"portal_active\":true,\n      \"portal_password\":\"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0\",\n      \"portal_password1\":\"\",\n      \"portal_app\":\"\",\n      \"preferred_language\":\"en_us\",\n      \"campaign_id\":\"\",\n      \"campaign_name\":\"\",\n      \"c_accept_status_fields\":\"\",\n      \"m_accept_status_fields\":\"\",\n      \"accept_status_id\":\"\",\n      \"accept_status_name\":\"\",\n      \"sync_contact\":\"\",\n      \"my_favorite\":false,\n      \"_acl\":{\n         \"fields\":{\n         }", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_DELETE/index.html"}
{"id": "5c698c39e33c-4", "text": "\"_acl\":{\n         \"fields\":{\n         }\n      }\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/link/:link_name/:remote_id DELETE endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_DELETE/index.html"}
{"id": "19b22d3aaff6-0", "text": "/Forecasts/config POST\nCreates and/or updates the config settings for the Forecasts module\nSummary:\n    This endpoint is used to create and/or update the config settings for the Forecasts module as json data.  It extends\n    the core config endpoint by adding the functionality to create\n    the Timeperiods and updates existing Opportunities for use in the Forecasts module.\nQuery Parameters:\nParam\nDescription\nOptional\nInput Example:\n        {\n            \"is_setup\": 1,\n            \"is_upgrade\": 0,\n            \"has_commits\": 1,\n            \"timeperiod_type\": \"chronological\",\n            \"timeperiod_interval\": \"Annual\",\n            \"timeperiod_leaf_interval\": \"Quarter\",\n            \"timeperiod_start_date\": \"2013-01-01\",\n            \"timeperiod_shown_forward\": 2,\n            \"timeperiod_shown_backward\": 2,\n            \"forecast_ranges\": \"show_binary\",\n            \"buckets_dom\": \"commit_stage_binary_dom\",\n            \"show_binary_ranges\": {\n                \"include\": {\n                    \"min\": 70,\n                    \"max\": 100\n                },\n                \"exclude\": {\n                    \"min\": 0,\n                    \"max\": 69\n                }\n            },\n            \"show_buckets_ranges\": {\n                \"include\": {\n                    \"min\": 85,\n                    \"max\": 100\n                },\n                \"upside\": {\n                    \"min\": 70,\n                    \"max\": 84\n                },\n                \"exclude\": {\n                    \"min\": 0,\n                    \"max\": 69\n                }\n            },\n            \"sales_stage_won\": [\n                \"Closed Won\"\n            ],\n            \"sales_stage_lost\": [\n                \"Closed Lost\"\n            ],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsconfig_POST/index.html"}
{"id": "19b22d3aaff6-1", "text": "],\n            \"sales_stage_lost\": [\n                \"Closed Lost\"\n            ],\n            \"show_worksheet_likely\": 1,\n            \"show_worksheet_best\": 1,\n            \"show_worksheet_worst\": 0,\n            \"show_projected_likely\": 1,\n            \"show_projected_best\": 1,\n            \"show_projected_worst\": 0,\n            \"show_forecasts_commit_warnings\": 1\n        }\n    \nOutput Example:\n        {\n            \"is_setup\": 1,\n            \"is_upgrade\": 0,\n            \"has_commits\": 1,\n            \"timeperiod_type\": \"chronological\",\n            \"timeperiod_interval\": \"Annual\",\n            \"timeperiod_leaf_interval\": \"Quarter\",\n            \"timeperiod_start_date\": \"2013-01-01\",\n            \"timeperiod_shown_forward\": 2,\n            \"timeperiod_shown_backward\": 2,\n            \"forecast_ranges\": \"show_binary\",\n            \"buckets_dom\": \"commit_stage_binary_dom\",\n            \"show_binary_ranges\": {\n                \"include\": {\n                    \"min\": 70,\n                    \"max\": 100\n                },\n                \"exclude\": {\n                    \"min\": 0,\n                    \"max\": 69\n                }\n            },\n            \"show_buckets_ranges\": {\n                \"include\": {\n                    \"min\": 85,\n                    \"max\": 100\n                },\n                \"upside\": {\n                    \"min\": 70,\n                    \"max\": 84\n                },\n                \"exclude\": {\n                    \"min\": 0,\n                    \"max\": 69\n                }\n            },\n            \"sales_stage_won\": [\n                \"Closed Won\"\n            ],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsconfig_POST/index.html"}
{"id": "19b22d3aaff6-2", "text": "\"sales_stage_won\": [\n                \"Closed Won\"\n            ],\n            \"sales_stage_lost\": [\n                \"Closed Lost\"\n            ],\n            \"show_worksheet_likely\": 1,\n            \"show_worksheet_best\": 1,\n            \"show_worksheet_worst\": 0,\n            \"show_projected_likely\": 1,\n            \"show_projected_best\": 1,\n            \"show_projected_worst\": 0,\n            \"show_forecasts_commit_warnings\": 1\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsconfig_POST/index.html"}
{"id": "00698362cccf-0", "text": "/<module>/:record/subscribe POST\nSummary:\nThis endpoint creates a subscription record in the Subscriptions table, from a specified record and module. It allows the user to be subscribed to activity stream messages for the record being subscribed to, or \"followed\".\nQuery Parameters:\nThis endpoint does not accept any parameters.\nInput Example:\nThis endpoint does not accept any input.\nOutput Example:\n  If successful, the endpoint responds with the GUID of the subscription record.\n\"96ad733c-df51-dd9d-1888-514112ef0595\"\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordsubscribe_POST/index.html"}
{"id": "d02a1411032e-0", "text": "/me/following GET\nOverview\n    Returns all of the current users followed records\nRequest Arguments\n    limit and offset are available query parameters.\nResponse Arguments\nName\nType\nDescription\n            \u00c2\u00a0\n        \n            \u00c2\u00a0\n        \n            \u00c2\u00a0\n        \nResponse\n{\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /me/following GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mefollowing_GET/index.html"}
{"id": "4e52db436e01-0", "text": "/Users/:record/freebusy GET\n    Get a user's FreeBusy schedule\nSummary:\n    This endpoint returns a list of time slots for which the specified person is busy.\nRequest\n        GET /Users/:id/freebusy\n    \nResponse\n    {\n      \"id\": \"foo\"\n      \"module\": \"Users\",\n      \"freebusy\": [\n                    {\n                      \"start\": \"2014-08-24T08:45:00-04:00\",\n                      \"end\": \"2014-08-24T09:15:00-04:00\"\n                    },\n                    {\n                      \"start\": \"2014-08-30T05:45:00-04:00\",\n                      \"end\": \"2014-08-30T06:15:00-04:00\"\n                    },\n                    {\n                      \"start\": \"2014-09-12T15:45:00-04:00\",\n                      \"end\": \"2014-09-12T16:15:00-04:00\"\n                    }\n                  ]\n    }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordfreebusy_GET/index.html"}
{"id": "9897e84b1b33-0", "text": "/pmse_Project/GatewayDefinition/:record PUT\nOverview\n    Updates the definition data for a gateway\nSummary\n    This endpoint will update the Process Definition gateway identified by the\n    record input parameter with the data provided by the request\n    payload.\nRequest Arguments\nName\nType\nDescription\nRequired\nrecord\nString\nThe value for the gat_uid field in the pmse_bpmn_gateway record\nTrue\nRequest Payload\n{\n    \"data\":\n    [\n        {\n            \"flo_uid\":\"985528634573cabc8901d04029355451\",\n            \"flo_condition\":\"\"\n        }\n    ]\n}\nResponse Arguments\nName\nType\nDescription\nsuccess\nBoolean\nThe status of the update operation\nResponse\n{\n    \"success\":true\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectGatewayDefinitionrecord_PUT/index.html"}
{"id": "e9c263922b49-0", "text": "/DataArchiver/:id/run POST\nOverview\n[ADMIN] Performs the archiving process.\nSummary\nPerforms the archiving process for the given archive definition. This endpoint is only available to administrators.\nRequest Arguments\nThis endpoint does not accept any request arguments.\nResponse\nThis API returns the ID of the created ArchiveRun bean.\nChange Log\nVersion\nChange\nv11_11\nAdded /DataArchiver/:id/run\u00c2\u00a0POST endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/DataArchiveridrun_POST/index.html"}
{"id": "d149b2ae7948-0", "text": "/pmse_Inbox/delete_notes/:id DELETE\nOverview\n    Deletes a process note \nSummary\nTBD\nRequest Arguments\nName\nType\nDescription\nRequired\nid\nstring\nThe note id to delete\ntrue\nResponse Arguments\nName\nType\nDescription\nid\nstring\nId of the deleted note\nResponse\n{\n    \"id\":\"da13553a-298a-11e6-b125-6c4008960436\"\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxdelete_notesid_DELETE/index.html"}
{"id": "0a21354f104a-0", "text": "/ForecastWorksheets/:timeperiod_id GET\nReturns a collection of ForecastWorksheet models\nSummary:\nThis end point is used to return the Worksheets for a user at a given timeperiod.  If no timeperiod is provide it\n    will use the default timeperiod, likewise if no user is provided, it will default to the logged in user.\nAlso this end points use the visibility requirements set forth by the application, that if the records being requested\n    belong to you, you will get the draft version,  If the worksheet is not yours, you will only see the committed version.\nUrl Parameters:\nParam\nDescription\nOptional\ntimeperiod_id\nShow for a specific time period, defaults to the current time period if one is not passed\nOptional\nuser_id\nShow for a specific user, defaults to current user if not defined\nOptional\nQuery Parameters:\nParam\nDescription\nOptional\ntype\nWhich type to return, currently the ones that are supported are, opportunity and product\nOptional\nPossible Errors\nError\nDescription\n412 - Invalid Parameter\nWhen the passed in timeperiod and/or user can not be found\n403 - Not Authorized\nIf you are not a manager, but you are tyring to view another sales rep forecast worksheet, you will receive a 403 Not Authorized Error\nUrl Example:\n        /rest/v10/ForecastWorksheets/:timeperiod_id/:user_id\n    \nOutput Example:\n        { \"next_offset\": -1,\n        \"records\": [\n            {\n                \"id\": \"ad3908c7-83a3-f360-c223-51117844c208\",\n                \"name\": \"Grow-Fast Inc - 1000 units\",\n                \"date_entered\": \"2013-02-05T21:22:00+00:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetstimeperiod_id_GET/index.html"}
{"id": "0a21354f104a-1", "text": "\"date_modified\": \"2013-02-05T21:22:00+00:00\",\n                \"modified_user_id\": \"1\",\n                \"modified_by_name\": \"Administrator\",\n                \"created_by\": \"1\",\n                \"created_by_name\": \"Administrator\",\n                \"description\": \"\",\n                \"img\": \"\",\n                \"deleted\": \"0\",\n                \"assigned_user_id\": \"seed_jim_id\",\n                \"assigned_user_name\": \"Jim Brennan\",\n                \"team_name\": [\n                    {\n                        \"id\": \"East\",\n                        \"name\": \"East\",\n                        \"name_2\": \"\",\n                        \"primary\": true\n                    }\n                ],\n                \"parent_id\": \"50b90565-e748-ed77-d9d7-511178f5acae\",\n                \"parent_type\": \"Opportunities\",\n                \"account_name\": \"\",\n                \"account_id\": \"\",\n                \"likely_case\": \"75000\",\n                \"best_case\": \"75000\",\n                \"worst_case\": \"75000\",\n                \"base_rate\": \"1\",\n                \"currency_id\": \"-99\",\n                \"currency_name\": \"\",\n                \"currency_symbol\": \"\",\n                \"date_closed\": \"2013-02-10\",\n                \"date_closed_timestamp\": \"1360531443\",\n                \"sales_stage\": \"Perception Analysis\",\n                \"probability\": \"70\",\n                \"commit_stage\": \"include\",\n                \"draft\": \"1\",\n                \"my_favorite\": false,\n                \"_acl\": {\n                    \"fields\": {}\n                }\n            }]\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetstimeperiod_id_GET/index.html"}
{"id": "830580884fdf-0", "text": "/EmailAddresses/:record PUT\nOverview\n    Update an existing email address.\nSummary\n    The email_address parameter is not supported as email addresses are immutable.\nRequest Arguments\nName\nType\nDescription\nRequired\n                invalid_email\n            \n                Boolean\n            \ntrue if the email address is invalid.\n            \n                False\n            \n                opt_out\n            \n                Boolean\n            \ntrue if the email address is opted out.\n            \n                False\n            \nRequest\n{\n  \"opt_out\": true\n}\nResponse Arguments\nName\nType\nDescription\n                <record field>\n            \n                <record field type>\n            \n                Returns the fields for the updated record.\n            \nResponse\n{\n  \"id\": \"a028341c-ba92-9343-55e7-56cf5beda121\",\n  \"date_created\": \"2016-02-25T11:53:07-08:00\",\n  \"date_modified\": \"2016-02-25T11:53:07-08:00\",\n  \"deleted\": false,\n  \"email_address\": \"eharmon@example.com\",\n  \"email_address_caps\": \"EHARMON@EXAMPLE.COM\",\n  \"invalid_email\": false,\n  \"opt_out\": true,\n  \"_acl\": {\n    \"fields\": {}\n  },\n  \"_module\": \"EmailAddresses\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /EmailAddresses/:record PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmailAddressesrecord_PUT/index.html"}
{"id": "bd7fce9ff647-0", "text": "/help/exceptions GET\nOverview\n    Fetches the documentation on which exceptions are thrown by the API, their \n    HTTP codes, their default messages and a brief description of what the exception\n    means.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            <html>\n        \n            String\n        \n            Returns the html of the help doc\n        \nResponse\n    The HTML document of the exception help page.\nChange Log\nVersion\nChange\n            v10\n        \n            Added /help/exceptions GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/helpexceptions_GET/index.html"}
{"id": "46f4a5877ab1-0", "text": "/Emails/:record PUT\nOverview\n    Update an existing Emails record.\nSummary\n    Used for updating an archived email, updating a draft to send later, or sending a draft.\nUpdating an Archived Email\nRequest Arguments\nName\nType\nDescription\nRequired\n                message_uid\n            \n                String\n            \n                Only use this field for updating emails imported from an IMAP server, as this is the email's IMAP UID.\n            \n                False\n            \n                assigned_user_id\n            \n                String\n            \n                The assigned user's ID.\n            \n                False\n            \n                parent_type\n            \n                String\n            \n                The parent record's module.\n            \n                False\n            \n                parent_id\n            \n                String\n            \n                The parent record's ID.\n            \n                False\n            \n                team_name\n            \n                List\n            \n                List of teams that can access the email.\n            \n                False\n            \nRequest\n{\n  \"assigned_user_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"parent_type\": \"Leads\",\n  \"parent_id\": \"f6a0611a-7d27-11e7-9d70-3c15c2d582c6\",\n  \"team_name\": [{\n    \"id\": \"1\",\n    \"display_name\": \"Global\",\n    \"name\": \"Global\",\n    \"name_2\": \"\",\n    \"primary\": true,\n    \"selected\": false\n  }]\n}\nResponse\n{\n  \"id\": \"a028341c-ba92-9343-55e7-56cf5beda121\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html"}
{"id": "46f4a5877ab1-1", "text": "\"date_entered\": \"2016-02-25T11:53:07-08:00\",\n  \"created_by\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"created_by_name\": \"Sarah Smith\",\n  \"date_modified\": \"2016-02-25T11:53:07-08:00\",\n  \"modified_by_name\": \"Sarah Smith\",\n  \"modified_user_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"deleted\": false,\n  \"assigned_user_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"assigned_user_name\": \"Sarah Smith\",\n  \"state\": \"Archived\",\n  \"name\": \"Re: Discuss Proposal\",\n  \"description\": \"Now is a good time\",\n  \"description_html\": \"<p>Now is a good time</p>\",\n  \"date_sent\": \"2012-02-17T06:53:00-08:00\",\n  \"message_id\": \"\",\n  \"message_uid\": \"\",\n  \"reply_to_status\": false,\n  \"total_attachments\": 1,\n  \"parent_name\": \"Tom Davis\",\n  \"parent_type\": \"Leads\",\n  \"parent_id\": \"f6a0611a-7d27-11e7-9d70-3c15c2d582c6\"\n  \"team_count\": \"\",\n  \"team_name\": [{\n    \"id\": 1,\n    \"name\": \"Global\",\n    \"name_2\": \"\",\n    \"primary\": true,\n    \"selected\": false\n  }],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html"}
{"id": "46f4a5877ab1-2", "text": "\"primary\": true,\n    \"selected\": false\n  }],\n  \"my_favorite\": false,\n  \"_acl\": {\n    \"fields\": {}\n  },\n  \"_module\": \"Emails\"\n}\nUpdating a Draft\nRequest Arguments\nName\nType\nDescription\nRequired\n                outbound_email_id\n            \n                String\n            \n                The ID of the chosen SMTP configuration for sending an email. Only use this field when saving a draft\n                or sending an email. The user's default SMTP configuration is used if one hasn't been chosen prior to\n                sending.\n            \n                False\n            \n                name\n            \n                String\n            \n                The email's subject.\n            \n                False\n            \n                description_html\n            \n                String\n            \n                The email's HTML body.\n            \n                False\n            \n                description\n            \n                String\n            \n                The email's plain text body. This field is not necessary unless the text body is different from the HTML\n                body.\n            \n                False\n            \n                reply_to_id\n            \n                String\n            \n                Only use this field when saving a draft or sending an email that is a reply to another email. This is\n                the ID of that other email.\n            \n                False\n            \n                parent_type\n            \n                String\n            \n                The parent record's module.\n            \n                False\n            \n                parent_id\n            \n                String\n            \n                The parent record's ID.\n            \n                False\n            \n                to\n            \n                Object\n            \n                The email's recipients found in the TO field. Existing EmailParticipants records cannot be used; only\n                the create and delete actions are supported. Metadata about each recipient is required to\n                link the records.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html"}
{"id": "46f4a5877ab1-3", "text": "link the records.\n                \nparent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,\n                        or Users, out out of the box. These fields are not necessary if only an email address is known\n                        for the recipient.\n                    \nemail_address_id is the ID of the email address the recipient used in the email. To get\n                        the ID of the email address, first make a request to /EmailAddresses POST. If this\n                        argument is not provided, then the primary email address of the parent record is used.\n                    \n                False\n            \n                cc\n            \n                Object\n            \n                The email's recipients found in the CC field. Existing EmailParticipants records cannot be used; only\n                the create and delete actions are supported. Metadata about each recipient is required to\n                link the records.\n                \nparent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,\n                        or Users, out out of the box. These fields are not necessary if only an email address is known\n                        for the recipient.\n                    \nemail_address_id is the ID of the email address the recipient used in the email. To get\n                        the ID of the email address, first make a request to /EmailAddresses POST. If this\n                        argument is not provided, then the primary email address of the parent record is used.\n                    \n                False\n            \n                bcc\n            \n                Object\n            \n                The email's recipients found in the BCC field. Existing EmailParticipants records cannot be used; only\n                the create and delete actions are supported. Metadata about each recipient is required to\n                link the records.\n                \nparent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,\n                        or Users, out out of the box. These fields are not necessary if only an email address is known", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html"}
{"id": "46f4a5877ab1-4", "text": "for the recipient.\n                    \nemail_address_id is the ID of the email address the recipient used in the email. To get\n                        the ID of the email address, first make a request to /EmailAddresses POST. If this\n                        argument is not provided, then the primary email address of the parent record is used.\n                    \n                False\n            \n                attachments\n            \n                Object\n            \n                The email's attachments. Existing Notes records cannot be used as email attachments; only the\n                create and delete actions are supported. Metadata about each attachment is required to\n                link the records.\n                \nfilename_guid is the temporary file ID for an uploaded file to attach as a Notes record.\n                    \nupload_id is the ID of an existing file that the Notes record should reference as the\n                        attachment. This allows files to be shared by multiple Notes records, to preserve space.\n                    \n                        When using upload_id, file_source should be provided to indicate from where the\n                        file originated. The value should be the module of the record that shares its ID with the file.\n                        So when an attachment comes from an email template, file_source should be\n                        EmailTemplates. And when an attachment comes from a document, file_source should\n                        be DocumentRevisions.\n                    \n                False\n            \nRequest\n{\n  \"outbound_email_id\": \"b80adf1a-7d78-11e7-855a-3c15c2d582c6\",\n  \"name\": \"Re: Discuss Proposal (new time)\",\n  \"description_html\": \"<p>I will call you in 10 minutes.</p>\",\n  \"parent_type\": \"Contacts\",\n  \"parent_id\": \"79b9c194-7d79-11e7-8fc5-3c15c2d582c6\",\n  \"to\": {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html"}
{"id": "46f4a5877ab1-5", "text": "\"to\": {\n    \"create\": [{\n      \"parent_type\": \"Contacts\",\n      \"parent_id\": \"79b9c194-7d79-11e7-8fc5-3c15c2d582c6\"\n    }],\n    \"delete\": [\n      \"ea1cec7e-7d27-11e7-9845-3c15c2d582c6\"\n    ]\n  },\n  \"cc\": {\n    \"delete\": [\n      \"eafa7e9a-7d27-11e7-aa2b-3c15c2d582c6\"\n    ]\n  },\n  \"attachments\": {\n    \"create\": [{\n      \"upload_id\": \"a028341c-ba92-9343-55e7-56cf5beda121\",\n      \"name\": \"Contract.pdf\",\n      \"filename\": \"Contract.pdf\",\n      \"file_source\": \"DocumentRevisions\"\n    }],\n    \"delete\": [\n      \"e087e79a-7d27-11e7-b02c-3c15c2d582c6\"\n    ]\n  }\n}\nResponse\n{\n  \"id\": \"f3c85966-7d27-11e7-9e9e-3c15c2d582c6\",\n  \"date_entered\": \"2016-02-25T11:53:07-08:00\",\n  \"created_by\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"created_by_name\": \"Sarah Smith\",\n  \"date_modified\": \"2016-02-25T12:53:07-08:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html"}
{"id": "46f4a5877ab1-6", "text": "\"modified_by_name\": \"Sarah Smith\",\n  \"modified_user_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"deleted\": false,\n  \"assigned_user_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"assigned_user_name\": \"Sarah Smith\",\n  \"state\": \"Draft\",\n  \"outbound_email_id\": \"b80adf1a-7d78-11e7-855a-3c15c2d582c6\",\n  \"name\": \"Re: Discuss Proposal (new time)\",\n  \"description\": \"I will call you in 10 minutes.\",\n  \"description_html\": \"<p>I will call you in 10 minutes.</p>\",\n  \"date_sent\": \"2012-02-17T12:53:07-08:00\",\n  \"message_id\": \"\",\n  \"message_uid\": \"\",\n  \"reply_to_id\": \"a028341c-ba92-9343-55e7-56cf5beda121\",\n  \"reply_to_status\": false,\n  \"total_attachments\": 1,\n  \"parent_name\": \"Jack Horner\",\n  \"parent_type\": \"Contacts\",\n  \"parent_id\": \"79b9c194-7d79-11e7-8fc5-3c15c2d582c6\"\n  \"team_count\": \"\",\n  \"team_name\": [{\n    \"id\": 1,\n    \"name\": \"Global\",\n    \"name_2\": \"\",\n    \"primary\": true,\n    \"selected\": false\n  }],\n  \"my_favorite\": false,\n  \"_acl\": {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html"}
{"id": "46f4a5877ab1-7", "text": "}],\n  \"my_favorite\": false,\n  \"_acl\": {\n    \"fields\": {}\n  },\n  \"_module\": \"Emails\"\n}\nSending an Email\nRequest Arguments\nName\nType\nDescription\nRequired\n                state\n            \n                String\n            \n                Use \"Ready\" to send an email.\n            \n                True\n            \n                outbound_email_id\n            \n                String\n            \n                The ID of the chosen SMTP configuration for sending an email. Only use this field when saving a draft\n                or sending an email. The user's default SMTP configuration is used if one hasn't been chosen prior to\n                sending.\n            \n                False\n            \n                name\n            \n                String\n            \n                The email's subject.\n            \n                False\n            \n                description_html\n            \n                String\n            \n                The email's HTML body.\n            \n                False\n            \n                description\n            \n                String\n            \n                The email's plain text body. This field is not necessary unless the text body is different from the HTML\n                body.\n            \n                False\n            \n                reply_to_id\n            \n                String\n            \n                Only use this field when saving a draft or sending an email that is a reply to another email. This is\n                the ID of that other email.\n            \n                False\n            \n                parent_type\n            \n                String\n            \n                The parent record's module.\n            \n                False\n            \n                parent_id\n            \n                String\n            \n                The parent record's ID.\n            \n                False\n            \n                to\n            \n                Object\n            \n                The email's recipients found in the TO field. Existing EmailParticipants records cannot be used; only\n                the create and delete actions are supported. Metadata about each recipient is required to", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html"}
{"id": "46f4a5877ab1-8", "text": "the create and delete actions are supported. Metadata about each recipient is required to\n                link the records.\n                \nparent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,\n                        or Users, out out of the box. These fields are not necessary if only an email address is known\n                        for the recipient.\n                    \nemail_address_id is the ID of the email address the recipient used in the email. To get\n                        the ID of the email address, first make a request to /EmailAddresses POST. If this\n                        argument is not provided, then the primary email address of the parent record is used.\n                    \n                False\n            \n                cc\n            \n                Object\n            \n                The email's recipients found in the CC field. Existing EmailParticipants records cannot be used; only\n                the create and delete actions are supported. Metadata about each recipient is required to\n                link the records.\n                \nparent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,\n                        or Users, out out of the box. These fields are not necessary if only an email address is known\n                        for the recipient.\n                    \nemail_address_id is the ID of the email address the recipient used in the email. To get\n                        the ID of the email address, first make a request to /EmailAddresses POST. If this\n                        argument is not provided, then the primary email address of the parent record is used.\n                    \n                False\n            \n                bcc\n            \n                Object\n            \n                The email's recipients found in the BCC field. Existing EmailParticipants records cannot be used; only\n                the create and delete actions are supported. Metadata about each recipient is required to\n                link the records.\n                \nparent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html"}
{"id": "46f4a5877ab1-9", "text": "parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,\n                        or Users, out out of the box. These fields are not necessary if only an email address is known\n                        for the recipient.\n                    \nemail_address_id is the ID of the email address the recipient used in the email. To get\n                        the ID of the email address, first make a request to /EmailAddresses POST. If this\n                        argument is not provided, then the primary email address of the parent record is used.\n                    \n                False\n            \n                attachments\n            \n                Object\n            \n                The email's attachments. Existing Notes records cannot be used as email attachments; only the\n                create and delete actions are supported. Metadata about each attachment is required to\n                link the records.\n                \nfilename_guid is the temporary file ID for an uploaded file to attach as a Notes record.\n                    \nupload_id is the ID of an existing file that the Notes record should reference as the\n                        attachment. This allows files to be shared by multiple Notes records, to preserve space.\n                    \n                        When using upload_id, file_source should be provided to indicate from where the\n                        file originated. The value should be the module of the record that shares its ID with the file.\n                        So when an attachment comes from an email template, file_source should be\n                        EmailTemplates. And when an attachment comes from a document, file_source should\n                        be DocumentRevisions.\n                    \n                False\n            \nRequest\n{\n  \"state\": \"Ready\"\n}\nResponse\n{\n  \"id\": \"a7795664-7def-11e7-8add-3c15c2d582c6\",\n  \"date_entered\": \"2016-02-25T08:53:07-08:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html"}
{"id": "46f4a5877ab1-10", "text": "\"created_by\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"created_by_name\": \"Sarah Smith\",\n  \"date_modified\": \"2016-02-25T08:53:07-08:00\",\n  \"modified_by_name\": \"Sarah Smith\",\n  \"modified_user_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"deleted\": false,\n  \"assigned_user_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n  \"assigned_user_name\": \"Sarah Smith\",\n  \"state\": \"Archived\",\n  \"outbound_email_id\": \"b80adf1a-7d78-11e7-855a-3c15c2d582c6\",\n  \"name\": \"Discuss Proposal\",\n  \"description\": \"When is a good time for us to chat?\",\n  \"description_html\": \"<p>When is a good time for us to chat?</p>\",\n  \"date_sent\": \"2012-02-17T08:53:07-08:00\",\n  \"message_id\": \"<a7795664-7def-11e7-8add-3c15c2d582c6@example.com>\",\n  \"message_uid\": \"\",\n  \"reply_to_id\": \"\",\n  \"reply_to_status\": false,\n  \"total_attachments\": 2,\n  \"parent_name\": \"Tom Davis\",\n  \"parent_type\": \"Leads\",\n  \"parent_id\": \"f6a0611a-7d27-11e7-9d70-3c15c2d582c6\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html"}
{"id": "46f4a5877ab1-11", "text": "\"team_count\": \"\",\n  \"team_name\": [{\n    \"id\": 1,\n    \"name\": \"Global\",\n    \"name_2\": \"\",\n    \"primary\": true,\n    \"selected\": false\n  }],\n  \"my_favorite\": false,\n  \"_acl\": {\n    \"fields\": {}\n  },\n  \"_module\": \"Emails\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Emails/:record PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html"}
{"id": "be9aac1d9339-0", "text": "/<module>/:record/audit GET\nOverview\nReturns data changes for a specific record.\nRequest Arguments\nName\nType\nDescription\nRequired\nrecord\nString\nThe record id.\nTrue\nmodule\nString\nThe name of the module.\nTrue\nQuery Parameters\nName\nType\nDescription\nRequired\nmax_num\nInteger\nA maximum number of records to return. The default is all records.\nFalse\noffset\nInteger\nThe number of records to skip over before records are returned. The default is 0. The parameter will be ignored if the max_num parameter is missing.\nFalse\nResponse Arguments\nName\nType\nDescription\nnext_offset\nInteger\nDisplays the next offset for retrieval of additional results. -1 will be returned when there are no more records.\nrecords\nArray\nAn array of results containing matched records.\nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"b569e480-237a-5921-4382-512ff555fee7\",\n         \"parent_id\":\"ef1b40aa-5815-4f8d-e909-512d09617ac8\",\n         \"date_created\":\"03\\/01\\/2013 12:26am\",\n         \"created_by\":\"admin\",\n         \"field_name\":\"Team ID:\",\n         \"data_type\":\"team_list\",\n         \"before_value_string\":\"East\",\n         \"after_value_string\":\"Will\"\n      },\n      {\n         \"id\":\"bc0bee72-8398-a0a6-d731-512ff5bfebc7\",\n         \"parent_id\":\"ef1b40aa-5815-4f8d-e909-512d09617ac8\",\n         \"date_created\":\"03\\/01\\/2013 12:26am\",\n         \"created_by\":\"admin\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordaudit_GET/index.html"}
{"id": "be9aac1d9339-1", "text": "\"created_by\":\"admin\",\n         \"field_name\":\"Teams\",\n         \"data_type\":\"id\",\n         \"before_value_string\":\"East, Global, West\",\n         \"after_value_string\":\"Jim, Will\"\n      }\n   ]\n}\nChange Log\nVersion\nChange\nv11_11\nAdded optional max_num and offset parameters to /Audit GET endpoint.\nv10\nAdded /Audit GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordaudit_GET/index.html"}
{"id": "b1b4b46391c4-0", "text": "/Administration/settings/idmMode DELETE\nOverview\n    [ADMIN] Turn IDM-mode off.\nSummary\n    This endpoint switches IDM mode off. This is only available to administrators when IDM migration is turned on and intended for internal use for IDM integration.\nResponse when IDM mode has been disabled\n[]\nChange Log\nVersion\nChange\n            v11_2\n        \n            Added /Administration/settings/idmMode DELETE endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/AdministrationsettingsidmMode_DELETE/index.html"}
{"id": "1e1b7f19a85a-0", "text": "/css/preview GET\nOverview\n    Runs LessPHP for a platform and a theme and outputs the compiled CSS. It only allows to preview the theme because\n    the file is not saved on the server.\nRequest Arguments\nName\nType\nDescription\nRequired\nplatform\nString\nThe theme platform - /themes/clients/***PLATFORM***/themeName/. Accepted values are 'base' and 'portal'.\nNo. (defaults to base)\nthemeName\nString\nThe theme name - /themes/clients/platform/***THEMENAME***/.\nNo. (defaults to default)\nmin\nBoolean\nWhether or not to minify the css\nNo. (defaults to false)\nRequest\n{\n    platform: 'portal',\n    themeName: 'default',\n    min: false\n}\nResponse Arguments\nResponse\nContent-type: text/css\n.someClass {\n    any-property: any-value;\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /css/preview GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/csspreview_GET/index.html"}
{"id": "4ecdce4d4bc7-0", "text": "/Employees GET\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n            Note that JSON-encoded filters can be specified as query parameters\n            in one of two ways for GET requests:\n            \n                    By specifying individual filter arguments as distinct parameters.\n                    Example: filter[0][id]=1.\n                \n                    By specifying the whole filter as a single JSON-encoded string.\n                    Note that this syntax is currently not supported on certain modules.\n                    Example: filter=[{\"id\":\"1\"}].\n                \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html"}
{"id": "4ecdce4d4bc7-1", "text": "False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. Each field may be represented either by string, or by map\n            containing field name and additional field parameters (applicable to link and collection fields).\n            The fields id and date_modified will always be returned.\n            \n            Example: name,account_type,description,{\"name\":\"opportunities\",\"fields\":[\"id\",\"name\",\"sales_status\"],\"order_by\":\"date_closed:desc\"}\n            For more details on additional field parameters, see\n            Relate API and\n            Collection API.\n        \n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \n            q\n        \n            String\n        \n            A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.\n        \n            False\n        \n            deleted\n        \n            Boolean\n        \n            Boolean to show deleted records in the result set.\n        \n            False\n        \n            nulls_last\n        \n            Boolean", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html"}
{"id": "4ecdce4d4bc7-2", "text": "False\n        \n            nulls_last\n        \n            Boolean\n        \n            Boolean to return records with null values in order_by fields last in the result set.\n        \n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\nExample\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html"}
{"id": "4ecdce4d4bc7-3", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html"}
{"id": "4ecdce4d4bc7-4", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\",\n               \"id\": \"b0701501-1fab-8ae7-3942-540da93f5017\",\n               \"name\": \"360 Vacations - 228 Units\",\n               \"date_modified\": \"2014-09-08T16:05:00+03:00\",\n               \"sales_status\": \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html"}
{"id": "4ecdce4d4bc7-5", "text": "{\n               _module: \"Opportunities\"\n               date_modified: \"2014-09-08T16:05:00+03:00\"\n               id: \"9ce7c088-8ee4-7cd3-18f1-540da944d4c0\"\n               name: \"360 Vacations - 312 Units\"\n               sales_status: \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html"}
{"id": "fcaf67f35d55-0", "text": "/Administration/elasticsearch/indices GET\nOverview\n    [ADMIN] Elasticsearch index statistics\nSummary\n    This endpoint returns the index statistics for the Elasticsearch backend. This endpoint is only available to\n    administrators.\nResponse\n{\n    \"autobr2583_shared\":{\n        \"_shards\":{\n            \"total\":1,\n            \"successful\":1,\n            \"failed\":0\n        },\n        \"indices\":{\n            \"autobr2583_shared\":{\n                \"index\":{\n                    \"primary_size_in_bytes\":1134148,\n                    \"size_in_bytes\":1134148\n                },\n                \"translog\":{\n                    \"operations\":1100\n                },\n                \"docs\":{\n                    \"num_docs\":1100,\n                    \"max_doc\":1100,\n                    \"deleted_docs\":0\n                },\n                \"merges\":{\n                    \"current\":0,\n                    \"current_docs\":0,\n                    \"current_size_in_bytes\":0,\n                    \"total\":1,\n                    \"total_time_in_millis\":103,\n                    \"total_docs\":1000,\n                    \"total_size_in_bytes\":1138070\n                },\n                \"refresh\":{\n                    \"total\":13,\n                    \"total_time_in_millis\":177\n                },\n                \"flush\":{\n                    \"total\":0,\n                    \"total_time_in_millis\":0\n                },\n                \"shards\":[[{\n                    \"routing\":{\n                        \"state\":\"STARTED\",\n                        \"primary\":true,\n                        \"node\":\"4rjVEVuYQQqKl4sT1FUxNA\",\n                        \"relocating_node\":null,\n                        \"shard\":0,\n                        \"index\":\"autobr2583_shared\"\n                    },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchindices_GET/index.html"}
{"id": "fcaf67f35d55-1", "text": "\"index\":\"autobr2583_shared\"\n                    },\n                    \"state\":\"STARTED\",\n                    \"index\":{\n                        \"size_in_bytes\":1134148\n                    },\n                    \"translog\":{\n                        \"id\":1427003304006,\n                        \"operations\":1100\n                    },\n                    \"docs\":{\n                        \"num_docs\":1100,\n                        \"max_doc\":1100,\n                        \"deleted_docs\":0\n                    },\n                    \"merges\":{\n                        \"current\":0,\n                        \"current_docs\":0,\n                        \"current_size_in_bytes\":0,\n                        \"total\":1,\n                        \"total_time_in_millis\":103,\n                        \"total_docs\":1000,\n                        \"total_size_in_bytes\":1138070\n                    },\n                    \"refresh\":{\n                        \"total\":13,\n                        \"total_time_in_millis\":177\n                    },\n                    \"flush\":{\n                        \"total\":0,\n                        \"total_time_in_millis\":0\n                    }\n                }]]\n            }\n        }\n    }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Administration/elasticsearch/indices GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchindices_GET/index.html"}
{"id": "8bbf0336f289-0", "text": "/help GET\nOverview\n    Fetches the help documentation\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            <html>\n        \n            String\n        \n            Returns the html of the help doc\n        \nResponse\n    The HTML for this help document.\nChange Log\nVersion\nChange\n            v10\n        \n            Added /help GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/help_GET/index.html"}
{"id": "6b1b693969d4-0", "text": "/ExpressionEngine/:record/related POST\nRetrieve a Forecasting Information In SugarChart Format\nSummary:\n    This endpoint is used to return the json Data for SugarCharts to use to display the needed chart.\nQuery Parameters:\nParam\nDescription\nOptional\ntimeperiod_id\nShow for a specific time period\n\u00c2\u00a0\nuser_id\nShow for a specific user\n\u00c2\u00a0\ndisplay_manager\nPipeline or Committed are valid values.\n\u00c2\u00a0\ndataset\nWhich Forecast dataset to show, valid values are likely, best, worst. Defaults to likely if one is not specified\nOptional\ngroup_by\nShow Which fields the y-axis shows on the chart.  Can be any field in the opportunity module, defaults to Sales Stage\nOptional\nranges\nPipeline or Committed are valid values.\nOptional\nInput Example:\n{\n    'user_id':'seed_max_id,\n    'timeperiod_id':'36f7085a-5889-ea75-84c8-50f42bd1a5ba',\n    'display_manager':'false',\n    'group_by': 'forecast',\n    'dataset': 'likely',\n    'ranges': 'include',\n}\n    \nOutput Example:\n        { \"color\" : [ \"#8c2b2b\",\n              \"#468c2b\",\n              \"#2b5d8c\",\n              \"#cd5200\",\n              \"#e6bf00\",\n              \"#7f3acd\",\n              \"#00a9b8\",\n              \"#572323\",\n              \"#004d00\",\n              \"#000087\",\n              \"#e48d30\",\n              \"#9fba09\",\n              \"#560066\",\n              \"#009f92\",\n              \"#b36262\",\n              \"#38795c\",\n              \"#3D3D99\",\n              \"#99623d\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_POST/index.html"}
{"id": "6b1b693969d4-1", "text": "\"#3D3D99\",\n              \"#99623d\",\n              \"#998a3d\",\n              \"#994e78\",\n              \"#3d6899\",\n              \"#CC0000\",\n              \"#00CC00\",\n              \"#0000CC\",\n              \"#cc5200\",\n              \"#ccaa00\",\n              \"#6600cc\",\n              \"#005fcc\"\n            ],\n          \"label\" : [ \"Include\" ],\n          \"properties\" : [ { \"gauge_target_list\" : \"Array\",\n                \"goal_marker_color\" : [ \"#000000\",\n                    \"#7D12B2\"\n                  ],\n                \"goal_marker_label\" : [ \"Quota\",\n                    \"Likely Case\"\n                  ],\n                \"goal_marker_type\" : [ \"group\",\n                    \"pareto\"\n                  ],\n                \"label_name\" : \"Include in Forecast\",\n                \"labels\" : \"value\",\n                \"legend\" : \"on\",\n                \"print\" : \"on\",\n                \"subtitle\" : \"\",\n                \"thousands\" : \"\",\n                \"title\" : null,\n                \"type\" : \"bar chart\",\n                \"value_name\" : \"Likely Case\"\n              } ],\n          \"values\" : [ { \"goalmarkervalue\" : [ \"111000.00\",\n                    \"36000.00\"\n                  ],\n                \"goalmarkervaluelabel\" : [ \"$111,000.00\",\n                    \"$36,000.00\"\n                  ],\n                \"gvalue\" : 36000,\n                \"gvaluelabel\" : \"$36,000.00\",\n                \"label\" : \"January 2013\",\n                \"links\" : [ \"\" ],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_POST/index.html"}
{"id": "6b1b693969d4-2", "text": "\"links\" : [ \"\" ],\n                \"valuelabels\" : [ \"$36,000.00\" ],\n                \"values\" : [ 36000 ]\n              },\n              { \"goalmarkervalue\" : [ \"111000.00\",\n                    \"61500.00\"\n                  ],\n                \"goalmarkervaluelabel\" : [ \"$111,000.00\",\n                    \"$61,500.00\"\n                  ],\n                \"gvalue\" : 25500,\n                \"gvaluelabel\" : \"$25,500.00\",\n                \"label\" : \"February 2013\",\n                \"links\" : [ \"\" ],\n                \"valuelabels\" : [ \"$25,500.00\" ],\n                \"values\" : [ 25500 ]\n              },\n              { \"goalmarkervalue\" : [ \"111000.00\",\n                    \"61500.00\"\n                  ],\n                \"goalmarkervaluelabel\" : [ \"$111,000.00\",\n                    \"$61,500.00\"\n                  ],\n                \"gvalue\" : 0,\n                \"gvaluelabel\" : \"$0.00\",\n                \"label\" : \"March 2013\",\n                \"links\" : [ \"\" ],\n                \"valuelabels\" : [ \"$0.00\" ],\n                \"values\" : [ 0 ]\n              }\n            ]\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_POST/index.html"}
{"id": "df2177ab91c7-0", "text": "/ExpressionEngine/:record/related GET\nRetrieve a Forecasting Information In SugarChart Format\nSummary:\n    This endpoint is used to return the json Data for SugarCharts to use to display the needed chart.\nQuery Parameters:\nParam\nDescription\nOptional\ntimeperiod_id\nShow for a specific time period\n\u00c2\u00a0\nuser_id\nShow for a specific user\n\u00c2\u00a0\ndisplay_manager\nPipeline or Committed are valid values.\n\u00c2\u00a0\ndataset\nWhich Forecast dataset to show, valid values are likely, best, worst. Defaults to likely if one is not specified\nOptional\ngroup_by\nShow Which fields the y-axis shows on the chart.  Can be any field in the opportunity module, defaults to Sales Stage\nOptional\nranges\nPipeline or Committed are valid values.\nOptional\nInput Example:\n{\n    'user_id':'seed_max_id,\n    'timeperiod_id':'36f7085a-5889-ea75-84c8-50f42bd1a5ba',\n    'display_manager':'false',\n    'group_by': 'forecast',\n    'dataset': 'likely',\n    'ranges': 'include',\n}\n    \nOutput Example:\n        { \"color\" : [ \"#8c2b2b\",\n              \"#468c2b\",\n              \"#2b5d8c\",\n              \"#cd5200\",\n              \"#e6bf00\",\n              \"#7f3acd\",\n              \"#00a9b8\",\n              \"#572323\",\n              \"#004d00\",\n              \"#000087\",\n              \"#e48d30\",\n              \"#9fba09\",\n              \"#560066\",\n              \"#009f92\",\n              \"#b36262\",\n              \"#38795c\",\n              \"#3D3D99\",\n              \"#99623d\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_GET/index.html"}
{"id": "df2177ab91c7-1", "text": "\"#3D3D99\",\n              \"#99623d\",\n              \"#998a3d\",\n              \"#994e78\",\n              \"#3d6899\",\n              \"#CC0000\",\n              \"#00CC00\",\n              \"#0000CC\",\n              \"#cc5200\",\n              \"#ccaa00\",\n              \"#6600cc\",\n              \"#005fcc\"\n            ],\n          \"label\" : [ \"Include\" ],\n          \"properties\" : [ { \"gauge_target_list\" : \"Array\",\n                \"goal_marker_color\" : [ \"#000000\",\n                    \"#7D12B2\"\n                  ],\n                \"goal_marker_label\" : [ \"Quota\",\n                    \"Likely Case\"\n                  ],\n                \"goal_marker_type\" : [ \"group\",\n                    \"pareto\"\n                  ],\n                \"label_name\" : \"Include in Forecast\",\n                \"labels\" : \"value\",\n                \"legend\" : \"on\",\n                \"print\" : \"on\",\n                \"subtitle\" : \"\",\n                \"thousands\" : \"\",\n                \"title\" : null,\n                \"type\" : \"bar chart\",\n                \"value_name\" : \"Likely Case\"\n              } ],\n          \"values\" : [ { \"goalmarkervalue\" : [ \"111000.00\",\n                    \"36000.00\"\n                  ],\n                \"goalmarkervaluelabel\" : [ \"$111,000.00\",\n                    \"$36,000.00\"\n                  ],\n                \"gvalue\" : 36000,\n                \"gvaluelabel\" : \"$36,000.00\",\n                \"label\" : \"January 2013\",\n                \"links\" : [ \"\" ],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_GET/index.html"}
{"id": "df2177ab91c7-2", "text": "\"links\" : [ \"\" ],\n                \"valuelabels\" : [ \"$36,000.00\" ],\n                \"values\" : [ 36000 ]\n              },\n              { \"goalmarkervalue\" : [ \"111000.00\",\n                    \"61500.00\"\n                  ],\n                \"goalmarkervaluelabel\" : [ \"$111,000.00\",\n                    \"$61,500.00\"\n                  ],\n                \"gvalue\" : 25500,\n                \"gvaluelabel\" : \"$25,500.00\",\n                \"label\" : \"February 2013\",\n                \"links\" : [ \"\" ],\n                \"valuelabels\" : [ \"$25,500.00\" ],\n                \"values\" : [ 25500 ]\n              },\n              { \"goalmarkervalue\" : [ \"111000.00\",\n                    \"61500.00\"\n                  ],\n                \"goalmarkervaluelabel\" : [ \"$111,000.00\",\n                    \"$61,500.00\"\n                  ],\n                \"gvalue\" : 0,\n                \"gvaluelabel\" : \"$0.00\",\n                \"label\" : \"March 2013\",\n                \"links\" : [ \"\" ],\n                \"valuelabels\" : [ \"$0.00\" ],\n                \"values\" : [ 0 ]\n              }\n            ]\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_GET/index.html"}
{"id": "d6147d24440c-0", "text": "/pmse_Inbox/filter GET\nOverview\n    Returns a list of Processes by user \nSummary\n    This endpoint gets a list of processes by user \nRequest Arguments\nName\nType\nDescription\nRequired\norder_by\nstring\nHow to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon.\nfalse\nq\nstring\nA search expression, will search on this module. Cannot be used at the same time as a filter expression or id.\nfalse\nfilter\nstring\nThe filter expression\nfalse\nfilter_id\nstring\nIdentifier for a preexisting filter. If filter is also set, the two filters are joined with an AND\nfalse\nmax_num\ninteger\nA maximum number of records to return. Default is 20.\nfalse\noffset\ninteger\nThe number of records to skip over before records are returned. Default is 0.\nfalse\nfields\nstring\nComma delimited list of fields to return\nfalse\ndeleted\nboolean\nBoolean to show deleted records in the result set.\nfalse\nResponse Arguments\nName\nType\nDescription\nrecords\n<field>:<value>\nProcess records\nnext_offset\ninteger\nNext offset for results\nResponse\n{\n    \"next_offset\":-1,\n    \"records\":\n    [\n        {\n            \"id\":\"839ccd22-2925-11e6-83f3-6c4008960436\",\n            \"date_modified\":\"2016-06-02T17:52:55-07:00\",\n            \"created_by\":\"1\",\n            \"cas_finish_date\":\"\",\n            \"assigned_user_id\":\"1\",\n            \"assigned_user_name\":\"Administrator\",\n            \"assigned_user_link\":\n            {\n                \"full_name\":\"Administrator\",\n                \"id\":\"1\",\n                \"_acl\":\n                {\n                    \"fields\":", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxfilter_GET/index.html"}
{"id": "d6147d24440c-1", "text": "\"id\":\"1\",\n                \"_acl\":\n                {\n                    \"fields\":\n                    {\n                        \"pwd_last_changed\":\n                        {\n                            \"write\":\"no\",\n                            \"create\":\"no\"\n                        },\n                        \"last_login\":\n                        {\n                            \"write\":\"no\",\n                            \"create\":\"no\"\n                        }\n                    },\n                    \"delete\":\"no\",\n                    \"_hash\":\"08b99a97c2e8d792f7a44d8882b5af6d\"\n                }\n            },\n            \"_acl\":\n            {\n                \"fields\":{}\n            },\n            \"_module\":\"pmse_Project\\/pmse_BpmFlow\",\n            \"_locked_fields\":[],\n            \"cas_id\":\"4\",\n            \"act_assignment_method\":\"static\",\n            \"cas_title\":\"PQR1\",\n            \"pro_title\":\"PD1\",\n            \"date_entered\":\"2016-06-02T17:52:55-07:00\",\n            \"name\":\"PQR1\",\n            \"cas_create_date\":\"2016-06-02T17:52:55-07:00\",\n            \"flow_id\":\"839ccd22-2925-11e6-83f3-6c4008960436\",\n            \"id2\":\"8380e512-2925-11e6-9600-6c4008960436\",\n            \"task_name\":\"Activity # 1\",\n            \"cas_assignment_method\":\"static\",\n            \"cas_sugar_module\":\"Accounts\",\n            \"cas_sugar_object_id\":\"82d5c470-2925-11e6-a269-6c4008960436\",\n            \"prj_id\":\"6e025038-2842-11e6-b4f7-6c4008960436\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxfilter_GET/index.html"}
{"id": "d6147d24440c-2", "text": "\"in_time\":true,\n            \"cas_user_id\":\"1\",\n            \"prj_created_by\":\"1\",\n            \"cas_user_id_full_name\":\"Administrator\",\n            \"prj_user_id_full_name\":\"Administrator\"\n        },\n    ]\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxfilter_GET/index.html"}
{"id": "b6232c171bf0-0", "text": "/Documents/:record/file/:field POST\nOverview\n    Attaches a file to a field on a record.\nRequest Arguments\nName\nType\nDescription\nRequired\n            format\n        \n            String\n        \n            The data format. Currently accepts 'sugar-html-json'.\n        \n            True\n        \n            delete_if_fails\n        \n            Boolean\n        \n            Indicates whether the API is to mark related record deleted if the file upload fails.\n        \n            False\n        \n            oauth_token\n        \n            String\n        \n            The oauth_token value.\n        \n            False - Required if only if delete_if_fails is true.\n        \n            <attachment field>\n        \n            String\n        \n            The field and file to populate.\n            \n            Example: {\"\":\"@\\/path\\/to\\/ExampleDocument.txt\"}\n            True\n        \nRequest\n{\n   \"format\":\"sugar-html-json\",\n   \"delete_if_fails\":true,\n   \"oauth_token\":\"43b6b327-cc70-c301-3299-512ffb99ad97\",\n   \"<attachment field>\":\"@\\/path\\/to\\/ExampleDocument.txt\"\n}\nResponse Arguments\nName\nType\nDescription\n            content-type\n        \n            String\n        \n            The files content type.\n        \n            content-length\n        \n            Integer\n        \n            The files content length.\n        \n            name\n        \n            String\n        \n            The files name.\n        \n            uri\n        \n            String\n        \n            The URI of the file.\n        \nResponse\n{\n   \"content-type\":\"text\\/plain\",\n   \"content-length\":16,\n   \"name\":\"ExampleDocument.txt\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Documentsrecordfilefield_POST/index.html"}
{"id": "b6232c171bf0-1", "text": "\"content-length\":16,\n   \"name\":\"ExampleDocument.txt\",\n   \"uri\":\"http:\\/\\/sugarcrm\\/rest\\/v10\\/Notes\\/ca66c92f-5a8b-28b4-4fc8-512d099b790b\\/file\\/<attachment field>?format=sugar-html-json&delete_if_fails=1&oauth_token=6ec91cf3-1f97-25b9-e0b1-512f8971b2d4\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/file/:field POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Documentsrecordfilefield_POST/index.html"}
{"id": "1d2ade7434cf-0", "text": "/Meetings/:record PUT\nOverview\n    Update a calendar event record of the specified type.\nRequest Arguments\nName\nType\nDescription\nRequired\n            all_recurrences\n        \n            Boolean\n        \n            Flag to update all events in a series.\n        \n            False\n        \nRequest\nhttp://{site_url}/rest/v10/Meetings/2c9e5c09-6824-0d14-f5cb-5130321ac3cf?all_recurrences=true\n{\n    \"name\":\"Department Meeting\",\n    \"description\":\"Weekly Department Meeting\",\n    \"date_start\":\"yyyy-mm-ddThh:mm:ss-00:00\",\n    \"date_end\":\"yyyy-mm-ddThh:mm:ss-00:00\",\n    \"repeat_type\":\"Weekly\",\n    \"repeat_interval\":\"1\",  /* Every Week */\n    \"repeat_dow\":\"25\",      /* Tue and Fri */\n    \"repeat_count\":\"4\",     /* 4 Recurrences */\n    \"repeat_until\":\"\",\n}\nResponse Arguments\nName\nDescription\nStart Date\nEnd Date\n            <record field>\n        \n            Returns the fields for the updated record.\n        \nResponse\n{\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Meetingsrecord_PUT/index.html"}
{"id": "0bff206380d4-0", "text": "/<module>/sync_key/:sync_key_field_value GET\nOverview\nRetrieves the record with the given sync_key.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule\nString\nThe module the record belongs to\nTrue\nsync_key_field_value\nString\nA unique ID for the record identifying it in an external system\nTrue\nRequest\n/<module>/sync_key/:sync_key_field_value\nResponse Arguments\nBody: formatted JSON object.\nResponse\nSuccessful Response\nStatus 200\nFailed Response\nStatus 422\n{\n    \"error\": \"invalid_parameter\",\n    \"error_message\": \"Could not find record with :sync_key_field_value in module: <module>\"\n}\nChange Log\nVersion\nChange\nv11_10\nAdded /<module>/sync_key/:sync_key_field_value\u00c2\u00a0GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulesync_keysync_key_field_value_GET/index.html"}
{"id": "97a50f4f0380-0", "text": "/KBContents/:record/notuseful PUT\nOverview\n    Vote for Knowledge Base article.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            <record field>\n        \n            <record field type>\n        \n            Returns the fields for the updated record.\n        \nResponse\n{\n    \"active_date\": \"2014-01-01\",\n    \"active_rev\": 1,\n    \"approved\": false,\n    \"assigned_user_id\": \"seed_will_id\",\n    \"assigned_user_link\": {\"full_name\": \"Will Westin\", \"id\": \"seed_will_id\"},\n    \"assigned_user_name\": \"Will Westin\",\n    \"attachment_list\": [],\n    \"cases\": {\"name\": \"\", \"id\": \"\"},\n    \"category_id\": \"3e844f1c-5ce1-6d6d-496d-5714901e6666\",\n    \"category_name\": \"Database\",\n    \"created_by\": \"1\",\n    \"created_by_link\": {\"full_name\": \"Administrator\", \"id\": \"1\"},\n    \"created_by_name\": \"Administrator\",\n    \"date_entered\": \"2016-04-18T07:43:43+00:00\",\n    \"date_modified\": \"2016-04-18T07:43:43+00:00\",\n    \"deleted\": false,\n    \"description\": \"\",\n    \"exp_date\": \"2014-12-31\",\n    \"file_mime_type\": \"\",\n    \"following\": false,\n    \"id\": \"87758ab5-75eb-451f-2bd7-571490d29d7a\",\n    \"is_external\": false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordnotuseful_PUT/index.html"}
{"id": "97a50f4f0380-1", "text": "\"is_external\": false,\n    \"kbarticle_id\": \"8862943c-022e-0385-908e-5714908ac792\",\n    \"kbarticle_name\": \"Resetting the device\",\n    \"kbarticles_kbcontents\": {\"name\": \"Resetting the device\", \"id\": \"8862943c-022e-0385-908e-5714908ac792\"},\n    \"kbdocument_body\": \"When things are not working as expected...\",\n    \"kbdocument_id\": \"87a20b6b-3172-ad19-0ca5-571490bec118\",\n    \"kbdocument_name\": \"Resetting the device\",\n    \"kbdocuments_kbcontents\": {\"name\": \"Resetting the device\", \"id\": \"87a20b6b-3172-ad19-0ca5-571490bec118\"},\n    \"kbsapprover_id\": \"\",\n    \"kbsapprover_name\": \"\",\n    \"kbsapprovers_kbcontents\": {\"full_name\": \"\", \"id\": \"\"},\n    \"kbscase_id\": \"\",\n    \"kbscase_name\": \"\",\n    \"language\": \"en\",\n    \"modified_by_name\": \"Administrator\",\n    \"modified_user_id\": \"1\",\n    \"modified_user_link\": {\"full_name\": \"Administrator\", \"id\": \"1\"},\n    \"my_favorite\": false,\n    \"name\": \"Resetting the device\",\n    \"notuseful\": 1\n    \"related_languages\": [\"en\"],\n    \"revision\": 1\n    \"status\": \"in-review\",\n    \"tag\": [],\n    \"team_count\": \"\",\n    \"team_count_link\": {\"team_count\": \"\", \"id\": \"1\"},", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordnotuseful_PUT/index.html"}
{"id": "97a50f4f0380-2", "text": "\"team_count_link\": {\"team_count\": \"\", \"id\": \"1\"},\n    \"team_name\": [{\"id\": 1, \"name\": \"Global\", \"name_2\": \"\", \"primary\": true}],\n    \"useful\": 0,\n    \"usefulness_user_vote\": \"-1\",\n    \"viewcount\": 4\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /KBContents/:record/useful PUT endpoint.\n        \n            v10\n        \n            Added /KBContents/:record/notuseful PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordnotuseful_PUT/index.html"}
{"id": "224c31c73e39-0", "text": "/integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value POST\nOverview\nCreates a relationship based on lhs_sync_key_field_name and rhs_sync_key_field_name. If both the LHS and RHS records can be found with the respective fields, then relate the RHS record to the LHS record.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule\nString\nThe module the record belongs to\nTrue\nlhs_sync_key_field_name\nString\nThe name of the LHS field that contains lhs_sync_key_field_value (the default field is named\u00c2\u00a0sync_key but can be renamed via code customization)\nTrue\nlhs_sync_key_field_value\nString\nA unique ID for the LHS record identifying it in an external system\nTrue\nlink_name\nString\nA name for the link\nTrue\nrhs_sync_key_field_name\nString\nThe name of the RHS field that contains rhs_sync_key_field_value (the default field is named\u00c2\u00a0sync_key but can be renamed via code customization)\nTrue\nrhs_sync_key_field_value\nString\nA unique ID for the RHS record identifying it in an external system\nTrue\nRequest\n/integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value\nResponse Arguments\nName\nType\nDescription\nrecord\nString\nThe ID of the record.\nrelated_record\nString\nThe ID of the related record.\nResponse\nStatus 200\n{\n    \"record\": \"a0328573-a252-a27c-3530-4e4297d4c9e1\",\n    \"related_record\": \"a0328573-bc54-a554-3530-4e4297d4c9e1\"\n}\nStatus 422\n{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulelhs_sync_key_field_namelhs_sync_key_field_valuelinklink_namerhs_sync_key_field_namerhs_sync_key_field_value_POST/index.html"}
{"id": "224c31c73e39-1", "text": "}\nStatus 422\n{\n    \"error\": \"invalid_parameter\",\n    \"error_message\": \"Could not find record with :xhs_sync_key_field_name::xhs_sync_key_field_value in module: <module>\"\n}\nChange Log\nVersion\nChange\nv11_10\nAdded /integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value\u00c2\u00a0POST endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulelhs_sync_key_field_namelhs_sync_key_field_valuelinklink_namerhs_sync_key_field_namerhs_sync_key_field_value_POST/index.html"}
{"id": "54c5e31f05ed-0", "text": "/me/preference/:preference_name PUT\nOverview\n    Updates a specific preference for the current user.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            \u00c2\u00a0\n        \n            \u00c2\u00a0\n        \n            \u00c2\u00a0\n        \nResponse\n{\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /me/preference/:preference_name PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mepreferencepreference_name_PUT/index.html"}
{"id": "ccda56fec1e0-0", "text": "/<module>/record_list/:record_list_id DELETE\nOverview\n    An API to delete lists of records\nSummary\n    Delete record list. Only DELETE request allowed.\nRequest Arguments\nName\nType\nDescription\nRequired\nmodule\nstring\n            Module name\n        \nTrue\nrecord_list_id\nguid\n            record list id\n        \nTrue\nRequest Example\nDELETE /rest/v10/:module/record_list/:id\nResponse Arguments\n    Return boolean true.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_listrecord_list_id_DELETE/index.html"}
{"id": "c596b12dc46b-0", "text": "/<module>/filter GET\nOverview\n    Lists filtered records.\nSummary\n    This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields\n    and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.\n    If both a filter definition and a filter id are passed, the two filters will be joined with an AND.\n    Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise\n    the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:\n    \"link_name.remote_field\", so if you wished to search the Accounts module by a related member account you would\n    use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n            Note that JSON-encoded filters can be specified as query parameters\n            in one of two ways for GET requests:\n            \n                    By specifying individual filter arguments as distinct parameters.\n                    Example: filter[0][id]=1.\n                \n                    By specifying the whole filter as a single JSON-encoded string.\n                    Note that this syntax is currently not supported on certain modules.\n                    Example: filter=[{\"id\":\"1\"}].\n                \n            False\n        \n            filter_id\n        \n            String\n        \n            Identifier for a preexisting filter. If filter is also set, the two\n            filters are joined with an AND.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html"}
{"id": "c596b12dc46b-1", "text": "False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. Each field may be represented either by string, or by map\n            containing field name and additional field parameters (applicable to link and collection fields).\n            The fields id and date_modified will always be returned.\n            \n            Example: name,account_type,description,{\"name\":\"opportunities\",\"fields\":[\"id\",\"name\",\"sales_status\"],\"order_by\":\"date_closed:desc\"}\n            For more details on additional field parameters, see\n            Relate API and\n            Collection API.\n        \n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \n            q\n        \n            String\n        \n            A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.\n        \n            False\n        \n            deleted\n        \n            Boolean\n        \n            Boolean to show deleted records in the result set.\n        \n            False\n        \n            nulls_last\n        \n            Boolean", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html"}
{"id": "c596b12dc46b-2", "text": "False\n        \n            nulls_last\n        \n            Boolean\n        \n            Boolean to return records with null values in order_by fields last in the result set.\n        \n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\nExample\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.\n            \n                $is_null", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html"}
{"id": "c596b12dc46b-3", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\nExample\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html"}
{"id": "c596b12dc46b-4", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nResponse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\",\n               \"id\": \"b0701501-1fab-8ae7-3942-540da93f5017\",\n               \"name\": \"360 Vacations - 228 Units\",\n               \"date_modified\": \"2014-09-08T16:05:00+03:00\",\n               \"sales_status\": \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n         \"description\":\"\",\n         \"opportunities\": [\n            {\n               _module: \"Opportunities\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html"}
{"id": "c596b12dc46b-5", "text": "{\n               _module: \"Opportunities\"\n               date_modified: \"2014-09-08T16:05:00+03:00\"\n               id: \"9ce7c088-8ee4-7cd3-18f1-540da944d4c0\"\n               name: \"360 Vacations - 312 Units\"\n               sales_status: \"New\"\n            },\n         ],\n         \"_acl\": {\n            \"fields\": {\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_GET/index.html"}
{"id": "2c2a688cd8ef-0", "text": "/pmse_Project/:record/verify GET\nOverview\n    Verifies whether the Process Definition has any pending processes\nSummary\n    This endpoint will verify whether the Process Definition identified by the\n    record input parameter has any currently pending processes\n    based on it.\nRequest Arguments\nName\nType\nDescription\nRequired\nrecord\nString\nThe Process Definition record ID\nTrue\nResponse Arguments\nName\nType\nDescription\nN/A\nResponse\nNote: The response is a string of either \"true\" or \"false\"\nindicating whether any pending processes exist.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectrecordverify_GET/index.html"}
{"id": "9c846e44aead-0", "text": "/Calls/:record DELETE\nOverview\n    Deletes either a single event record or a series of event records\nRequest Arguments\nName\nType\nDescription\nRequired\n            all_recurrences\n        \n            Boolean\n        \n            Flag to delete all events in a series.\n        \n            False\n        \nRequest\nhttp://{site_url}/rest/v10/Meetings/2c9e5c09-6824-0d14-f5cb-5130321ac3cf?all_recurrences=true\nResponse Arguments\nName\nType\nDescription\n            id\n        \n            String\n        \n            Returns the ID of the deleted record.\n        \nResponse\n{\n    \"id\": \"11cf0d0a-40af-8cb1-9da0-5057a5f511f9\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record DELETE endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Callsrecord_DELETE/index.html"}
{"id": "163cd95ad413-0", "text": "/ProductTemplates/tree GET\nProductTemplate API\nSummary:\n    This endpoint is designed to return a paged recordset of one level of product templates and product categories in\n    a N-level deep tree representing the relationship between categories and templates.  The results are loosely\n    filtered (wildcard before and after).\nQuery Parameters:\nParam\nDescription\nOptional\nfilter\nThe filter used to search Product Template and Product Category names.  %filter% \ntrue\nroot\nThe ID of the root node you wish to retrieve.  Defaults to null (the root level)\ntrue\noffset\nSpecifies the numeric value of the offset you wish to retrieve\ntrue\nmax_num\nSpecifies the numeric value of the max number of records you wish to receive. Default is 20.\ntrue\nResponse Parameters:\nParam\nDescription\nid\nThe id of the item (Product Category/Template) \nData\nThe name of the item\nstate\nSpecifies the open or closed state of the element. (used for categories)\nindex\nSpecifies the index of this element in the current level.\nResponse:\n        { \n            \"records\":[\n                {\n                    \"id\":\"023d316a-d9d0-11e7-9f54-02425392a518\",\n                    \"type\":\"category\",\n                    \"data\":\"Christen Widgets\",\n                    \"state\":\"closed\",\n                    \"index\":0\n                },\n                {\n                    \"id\":\"01828a4a-d9d0-11e7-8989-02425392a518\",\n                    \"type\":\"category\",\n                    \"data\":\"Desktops\",\n                    \"state\":\"closed\",\n                    \"index\":1\n                }\n            ],\n            \"next_offset\":2\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ProductTemplatestree_GET/index.html"}
{"id": "934f34b1aa79-0", "text": "/Mail/archive POST\nOverview\n    Archives an email.\nQuery String Parameters\n    This endpoint does not accept any query string parameters.\nInput Parameters\nName\nType\nDescription\nRequired\n            date_sent\n        \n            String\n        \n            Date of email sent\n        \n            True\n        \n            from_address\n        \n            String\n        \n            From email address\n        \n            True\n        \n            to_addresses\n        \n            Array\n        \n            Array of name/email address pairs for the TO field, when present, only email subfield is required (not name).\n        \n            True\n        \n            cc_addresses\n        \n            Array\n        \n            Array of name/email address pairs for the CC field, when present, email subfield is required.\n        \n            False\n        \n            bcc_addresses\n        \n            Array\n        \n            Array of name/email address pairs for the BCC field, when present, email subfield is required.\n        \n            False\n        \n            subject\n        \n            String\n        \n            Subject of the email\n        \n            True\n        \n            html_body\n        \n            String\n        \n            HTML body of the email\n        \n            False\n        \n            text_body\n        \n            String\n        \n            Text body of the email\n        \n            False\n        \n            status\n        \n            String\n        \n            Indicates the status of the email - 'draft' or 'ready' (ready to be sent)\n        \n            True\n        \n            related\n        \n            Object\n        \n            Contains 'parent_type' and 'parent_id' to relate this email to (for example 'Contact' and a contact's id)\n        \n            False\n        \n            teams\n        \n            Object", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailarchive_POST/index.html"}
{"id": "934f34b1aa79-1", "text": "False\n        \n            teams\n        \n            Object\n        \n            Team(s) to assign this email to. 'primary' attribute is an id string for the primary team and 'other' attribute is an array of id strings for the other teams - only primary is required\n        \n            True\n        \n            assigned_user_id\n        \n            String\n        \n            ID of a user this record is assigned to.\n        \n            False\n        \n            attachments\n        \n            Array\n        \n            Array of file attachments - each attachment consists of a 'type' (where the attachment came from: upload, document, or template), 'id' (of the file upload, note, document revision, etc), and 'name' (the file name)\n        \n            False\n        \nInput Example\n{\n  \"date_sent\":\"2014-02-07T00:00:00\",\n  \"from_address\":\"test@foo.com\"\n  \"to_addresses\":[\n    {\n      \"name\":\"John Doe\",\n      \"email\":\"john_doe@foo.com\",\n      \"module\":\"Leads\"\n    },\n    {\n      \"name\":\"David Madison\",\n      \"email\":\"david_madison@bar.com\",\n      \"module\":\"Leads\"\n    }\n  ],\n  \"cc_addresses\":[\n    {\n      \"name\":\"Tom Swift\",\n      \"email\":\"tswift@baz.com\"\n    }\n  ],\n  \"bcc_addresses\":null,\n  \"subject\":\"Minneapolis Convention\",\n  \"html_body\":\"<html><body>Hello World<\\/body><\\/html>\",\n  \"text_body\":\"Hello World\"\n  \"status\":\"archive\",\n  \"related\": {\n    \"type\":\"Contacts\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailarchive_POST/index.html"}
{"id": "934f34b1aa79-2", "text": "\"status\":\"archive\",\n  \"related\": {\n    \"type\":\"Contacts\",\n    \"id\":\"61cf0f8d-938c-c9b2-53ad-51ed7bbcf83b\"\n  },\n  \"teams\": {\n    \"primary\": \"dabec868-696c-f458-e204-50227995ab50\",\n    \"others\": [\n      \"c3094c88-c95f-2e17-4553-50227996ad20\",\n      \"abcde868-696c-f458-e704-58369095ab62\"\n    ]\n  },\n  \"assigned_user_id\":\"seed_jim_id\",\n  \"attachments\": [\n    {\n       \"type\": \"upload\",\n       \"id\": \"cfbe4551-548d-f602-b228-45387645fc12\",\n       \"name\": \"company_logo.jpg\"\n    },\n    {\n       \"type\": \"document\",\n       \"id\": \"876112a4-89c1-4ba7-a05a-7729a7a76818\"\n    },\n    {\n       \"type\": \"template\",\n       \"id\": \"002cfe6c-98e9-4342-bdb1-1660d0788872\"\n    }\n  ],\n}\nResult\nName\nType\nDescription\n            <email record field>\n        \n            <email record field type>\n        \n            Returns the fields for the newly created email record.\n        \nOutput Example\n{\n    \"team_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailarchive_POST/index.html"}
{"id": "934f34b1aa79-3", "text": "\"team_set_id\": \"9c61c46a-a7c5-df71-481c-51d48232f820\",\n    \"id\": \"d9c165d0-8863-ba61-dc85-51ed8016c476\",\n    \"date_entered\": \"2013-07-22 18:57:57\",\n    \"date_modified\": \"2013-07-22 18:57:57\",\n    \"assigned_user_id\": \"1\",\n    \"assigned_user_name\": \"\",\n    \"modified_user_id\": \"1\",\n    \"modified_by_name\": \"admin\",\n    \"created_by\": \"1\",\n    \"created_by_name\": \"\",\n    \"deleted\": 0,\n    \"from_addr_name\": \"SugarCRM\",\n    \"reply_to_addr\": \"\",\n    \"to_addrs_names\": \"john_doe@foo.com, david_madison@bar.com\",\n    \"cc_addrs_names\": \"tswift@baz.com\",\n    \"description_html\": \"<html><body>Hello World<\\/body><\\/html>\",\n    \"description\": \"Hello World\",\n    \"date_sent\": \"2013-07-22 18:57:00\",\n    \"name\": \"Minneapolis Convention\",\n    \"type\": \"out\",\n    \"status\": \"sent\",\n    \"parent_type\": \"Contacts\",\n    \"parent_id\": \"61cf0f8d-938c-c9b2-53ad-51ed7bbcf83b\",\n    \"from_address\":\"test@foo.com\"\n}\nChange Log\nVersion\nChange\n            v11\n        \n            Last version in which /Mail/archive POST is available. Use /Emails POST with\n            {\"state\": \"Archived\"} instead.\n        \n            v10", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailarchive_POST/index.html"}
{"id": "934f34b1aa79-4", "text": "{\"state\": \"Archived\"} instead.\n        \n            v10\n        \n            Added /Mail/archive POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailarchive_POST/index.html"}
{"id": "b653e5d56bfe-0", "text": "/Administration/elasticsearch/refresh/trigger POST\nOverview\n    [ADMIN] Elasticsearch trigger explicit index refresh on all indices\nSummary\n    Trigger an explicit index refresh for all indices managed by SugarCRM. This endpoint is only\n    available to administrators.\nResponse\n{\n  \"aabbcc_contactsleads\": 200,\n  \"aabbcc_accountsonly\": 200,\n  \"aabbcc_shared\": 200\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Administration/elasticsearch/refresh/trigger POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchrefreshtrigger_POST/index.html"}
{"id": "76e8363db03c-0", "text": "/<module>/recent-product POST\nOverview\n    Opportunity Recent Product Help\nSummary\n    This endpoint retrieves top 10 recently used Quoted/Revenue Line Items based on the module to display them in the\n    \"Product Catalog Quick Picks\" dashlet in the reverse chronological order.\nRequest Arguments\nNone\nResponse Arguments\nNONE\nResponse\n{\n    \"next_offset\":-1,\n    \"records\":[\n                {\n                    \"id\":\"c1b4680e-c7f2-11e8-9380-7831c1c14620\",\n                    \"name\":\"Brain Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c1b3bf58-c7f2-11e8-92e7-7831c1c14620\",\n                    \"mft_part_num\":\"Smallville Resources Inc 362299XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"370.000000\",\n                    \"discount_price\":\"854.370000\",\n                    \"list_price\":\"863.000000\",\n                    \"cost_usdollar\":\"370.000000\",\n                    \"discount_usdollar\":\"854.370000\",\n                    \"list_usdollar\":\"863.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html"}
{"id": "76e8363db03c-1", "text": "\"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"10.00\",\n                    \"qty_in_stock\":106,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"PercentageDiscount\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"Base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c186a612-c7f2-11e8-9fee-7831c1c14620\",\n                    \"name\":\"Bradford Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c185dbb0-c7f2-11e8-a6b7-7831c1c14620\",\n                    \"mft_part_num\":\"Mississippi Bank Group 133834XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"528.000000\",\n                    \"discount_price\":\"533.333333\",\n                    \"list_price\":\"745.000000\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html"}
{"id": "76e8363db03c-2", "text": "\"list_price\":\"745.000000\",\n                    \"cost_usdollar\":\"528.000000\",\n                    \"discount_usdollar\":\"533.333333\",\n                    \"list_usdollar\":\"745.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"33.00\",\n                    \"qty_in_stock\":70,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"ProfitMargin\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"Base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c1b60434-c7f2-11e8-8964-7831c1c14620\",\n                    \"name\":\"Billie Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c1b3bf58-c7f2-11e8-92e7-7831c1c14620\",\n                    \"mft_part_num\":\"Kringle Bell IncK.A. Tower \\u0026 Co 694143XYZ987\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html"}
{"id": "76e8363db03c-3", "text": "\"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"403.000000\",\n                    \"discount_price\":\"927.000000\",\n                    \"list_price\":\"927.000000\",\n                    \"cost_usdollar\":\"403.000000\",\n                    \"discount_usdollar\":\"927.000000\",\n                    \"list_usdollar\":\"927.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"16.00\",\n                    \"qty_in_stock\":148,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"IsList\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"Base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c18e0448-c7f2-11e8-86b0-7831c1c14620\",\n                    \"name\":\"Arla Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html"}
{"id": "76e8363db03c-4", "text": "\"category_id\":\"c18b8b64-c7f2-11e8-8c1a-7831c1c14620\",\n                    \"mft_part_num\":\"24\\/7 Couriers 795391XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"398.000000\",\n                    \"discount_price\":\"402.020202\",\n                    \"list_price\":\"941.000000\",\n                    \"cost_usdollar\":\"398.000000\",\n                    \"discount_usdollar\":\"402.020202\",\n                    \"list_usdollar\":\"941.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"22.00\",\n                    \"qty_in_stock\":145,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"ProfitMargin\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"Base_rate\":\"1.000000\"\n                },\n                {\n                    \"id\":\"c181bd32-c7f2-11e8-b4eb-7831c1c14620\",\n                    \"name\":\"Allyson Gadget\",\n                    \"date_entered\":\"2018-10-04 16:28:37\",\n                    \"date_modified\":\"2018-10-04 16:28:37\",\n                    \"modified_user_id\":\"1\",\n                    \"created_by\":\"1\",\n                    \"description\":null,\n                    \"deleted\":0,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html"}
{"id": "76e8363db03c-5", "text": "\"description\":null,\n                    \"deleted\":0,\n                    \"type_id\":null,\n                    \"manufacturer_id\":\"c03f952a-c7f2-11e8-b410-7831c1c14620\",\n                    \"category_id\":\"c18112d8-c7f2-11e8-b753-7831c1c14620\",\n                    \"mft_part_num\":\"Ink Conglomerate Inc 921535XYZ987\",\n                    \"vendor_part_num\":null,\n                    \"date_cost_price\":null,\n                    \"cost_price\":\"534.000000\",\n                    \"discount_price\":\"842.000000\",\n                    \"list_price\":\"905.000000\",\n                    \"cost_usdollar\":\"534.000000\",\n                    \"discount_usdollar\":\"842.000000\",\n                    \"list_usdollar\":\"905.000000\",\n                    \"status\":\"Available\",\n                    \"tax_class\":\"Taxable\",\n                    \"date_available\":\"2004-10-15\",\n                    \"website\":null,\n                    \"weight\":\"20.00\",\n                    \"qty_in_stock\":26,\n                    \"support_name\":null,\n                    \"support_description\":null,\n                    \"support_contact\":null,\n                    \"support_term\":null,\n                    \"pricing_formula\":\"Fixed\",\n                    \"pricing_factor\":\"1.00\",\n                    \"assigned_user_id\":null,\n                    \"currency_id\":\"-99\",\n                    \"base_rate\":\"1.000000\"\n                }\n            ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /Opportunities/recent_product POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html"}
{"id": "c3eeba0a5d68-0", "text": "/me/preference/:preference_name POST\nOverview\n    Creates a preference for the current user.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            \u00c2\u00a0\n        \n            \u00c2\u00a0\n        \n            \u00c2\u00a0\n        \nResponse\n{\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /me/preference/:preference_name POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mepreferencepreference_name_POST/index.html"}
{"id": "298f8c8f9baf-0", "text": "/KBContents/:record/useful PUT\nOverview\n    Vote for Knowledge Base article.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\nName\nType\nDescription\n            <record field>\n        \n            <record field type>\n        \n            Returns the fields for the updated record.\n        \nResponse\n{\n    \"active_date\": \"2014-01-01\",\n    \"active_rev\": 1,\n    \"approved\": false,\n    \"assigned_user_id\": \"seed_will_id\",\n    \"assigned_user_link\": {\"full_name\": \"Will Westin\", \"id\": \"seed_will_id\"},\n    \"assigned_user_name\": \"Will Westin\",\n    \"attachment_list\": [],\n    \"cases\": {\"name\": \"\", \"id\": \"\"},\n    \"category_id\": \"3e844f1c-5ce1-6d6d-496d-5714901e6666\",\n    \"category_name\": \"Database\",\n    \"created_by\": \"1\",\n    \"created_by_link\": {\"full_name\": \"Administrator\", \"id\": \"1\"},\n    \"created_by_name\": \"Administrator\",\n    \"date_entered\": \"2016-04-18T07:43:43+00:00\",\n    \"date_modified\": \"2016-04-18T07:43:43+00:00\",\n    \"deleted\": false,\n    \"description\": \"\",\n    \"exp_date\": \"2014-12-31\",\n    \"file_mime_type\": \"\",\n    \"following\": false,\n    \"id\": \"87758ab5-75eb-451f-2bd7-571490d29d7a\",\n    \"is_external\": false,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecorduseful_PUT/index.html"}
{"id": "298f8c8f9baf-1", "text": "\"is_external\": false,\n    \"kbarticle_id\": \"8862943c-022e-0385-908e-5714908ac792\",\n    \"kbarticle_name\": \"Resetting the device\",\n    \"kbarticles_kbcontents\": {\"name\": \"Resetting the device\", \"id\": \"8862943c-022e-0385-908e-5714908ac792\"},\n    \"kbdocument_body\": \"When things are not working as expected...\",\n    \"kbdocument_id\": \"87a20b6b-3172-ad19-0ca5-571490bec118\",\n    \"kbdocument_name\": \"Resetting the device\",\n    \"kbdocuments_kbcontents\": {\"name\": \"Resetting the device\", \"id\": \"87a20b6b-3172-ad19-0ca5-571490bec118\"},\n    \"kbsapprover_id\": \"\",\n    \"kbsapprover_name\": \"\",\n    \"kbsapprovers_kbcontents\": {\"full_name\": \"\", \"id\": \"\"},\n    \"kbscase_id\": \"\",\n    \"kbscase_name\": \"\",\n    \"language\": \"en\",\n    \"modified_by_name\": \"Administrator\",\n    \"modified_user_id\": \"1\",\n    \"modified_user_link\": {\"full_name\": \"Administrator\", \"id\": \"1\"},\n    \"my_favorite\": false,\n    \"name\": \"Resetting the device\",\n    \"notuseful\": 1\n    \"related_languages\": [\"en\"],\n    \"revision\": 1\n    \"status\": \"in-review\",\n    \"tag\": [],\n    \"team_count\": \"\",\n    \"team_count_link\": {\"team_count\": \"\", \"id\": \"1\"},", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecorduseful_PUT/index.html"}
{"id": "298f8c8f9baf-2", "text": "\"team_count_link\": {\"team_count\": \"\", \"id\": \"1\"},\n    \"team_name\": [{\"id\": 1, \"name\": \"Global\", \"name_2\": \"\", \"primary\": true}],\n    \"useful\": 0,\n    \"usefulness_user_vote\": \"-1\",\n    \"viewcount\": 4\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /KBContents/:record/useful PUT endpoint.\n        \n            v10\n        \n            Added /KBContents/:record/notuseful PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecorduseful_PUT/index.html"}
{"id": "641a193888c5-0", "text": "/<module> POST\nOverview\n    Create a new record of a specified type.\nRequest Arguments\nName\nType\nDescription\nRequired\n                <record field>\n            \n                <record field type>\n            \n                The name value list of fields to populate.\n            \n                True\n            \nRequest\n{\n    \"name\":\"Example Account\",\n    \"account_type\":\"Customer\",\n    \"description\":\"My Example Account\",\n    \"meetings\": {\n    {\n        \"add\": [\"21e3385e-404f-b470-407e-54044e3d8023\"],\n        \"create\": [\n        {\n            \"name\": \"Test Meeting\"\n        }\n      ]\n    }\n  }\n}\nLink fields\n    It is possible to add record relations to other records and create new related records.\nAction\nType\nDescription\nadd\n            List\n        \n            List of related records ID. See RelateRecordApi\n            for details.\n        \ncreate\n            List\n        \n            List of name to value arrays of related records.\n        \nResponse Arguments\nName\nType\nDescription\n                <record field>\n            \n                <record field type>\n            \n                Returns the fields for the newly created record.\n            \nResponse\n{\n   \"id\":\"e91b1fa7-1bd8-3c71-be96-512e643f9ca4\",\n   \"name\":\"Example Account\",\n   \"date_entered\":\"2013-02-27T19:56:00+00:00\",\n   \"date_modified\":\"2013-02-27T19:56:00+00:00\",\n   \"modified_user_id\":\"1\",\n   \"modified_by_name\":\"Administrator\",\n   \"created_by\":\"1\",\n   \"created_by_name\":\"Administrator\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_POST/index.html"}
{"id": "641a193888c5-1", "text": "\"created_by\":\"1\",\n   \"created_by_name\":\"Administrator\",\n   \"description\":\"My Example Account\",\n   \"img\":\"\",\n   \"deleted\":false,\n   \"assigned_user_id\":\"\",\n   \"assigned_user_name\":\"\",\n   \"team_name\":[\n      {\n         \"id\":1,\n         \"name\":\"Global\",\n         \"name_2\":\"\",\n         \"primary\":true\n      }\n   ],\n   \"linkedin\":\"\",\n   \"facebook\":\"\",\n   \"twitter\":\"\",\n   \"googleplus\":\"\",\n   \"account_type\":\"Customer\",\n   \"industry\":\"\",\n   \"annual_revenue\":\"\",\n   \"phone_fax\":\"\",\n   \"billing_address_street\":\"\",\n   \"billing_address_street_2\":\"\",\n   \"billing_address_street_3\":\"\",\n   \"billing_address_street_4\":\"\",\n   \"billing_address_city\":\"\",\n   \"billing_address_state\":\"\",\n   \"billing_address_postalcode\":\"\",\n   \"billing_address_country\":\"\",\n   \"rating\":\"\",\n   \"phone_office\":\"\",\n   \"phone_alternate\":\"\",\n   \"website\":\"\",\n   \"ownership\":\"\",\n   \"employees\":\"\",\n   \"ticker_symbol\":\"\",\n   \"shipping_address_street\":\"\",\n   \"shipping_address_street_2\":\"\",\n   \"shipping_address_street_3\":\"\",\n   \"shipping_address_street_4\":\"\",\n   \"shipping_address_city\":\"\",\n   \"shipping_address_state\":\"\",\n   \"shipping_address_postalcode\":\"\",\n   \"shipping_address_country\":\"\",\n   \"email1\":\"\",\n   \"parent_id\":\"\",\n   \"sic_code\":\"\",\n   \"parent_name\":\"\",\n   \"email_opt_out\":\"\",\n   \"invalid_email\":\"\",\n   \"email\":[\n   ],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_POST/index.html"}
{"id": "641a193888c5-2", "text": "\"invalid_email\":\"\",\n   \"email\":[\n   ],\n   \"campaign_id\":\"\",\n   \"campaign_name\":\"\",\n   \"my_favorite\":false,\n   \"_acl\":{\n      \"fields\":{\n      }\n   }\n}\nChange Log\nVersion\nChange\n            v10 (7.6.0)\n        \n            Added support for link fields.\n        \n            v10\n        \n            Added /<module> POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_POST/index.html"}
{"id": "ea47e638c11b-0", "text": "/<module>/temp/file/:field POST\nOverview\n    Saves an image to a temporary folder.\nRequest Arguments\nName\nType\nDescription\nRequired\n            format\n        \n            String\n        \n            The data format. Currently accepts 'sugar-html-json'.\n        \n            True\n        \n            delete_if_fails\n        \n            Boolean\n        \n            Indicates whether the API is to mark related record deleted if the file upload fails.\n        \n            False\n        \n            oauth_token\n        \n            String\n        \n            The oauth_token value.\n        \n            False - Required if only if delete_if_fails is true.\n        \n            <image field>\n        \n            String\n        \n            The field and file to populate.\n            \n            Example: {\"\":\"@\\/path\\/to\\/ExampleImage.png\"}\n            True\n        \nRequest\n{\n   \"format\":\"sugar-html-json\",\n   \"delete_if_fails\":true,\n   \"oauth_token\":\"8d240d9d-04ea-571b-35ea-513037ed5857\",\n   \"<image field>\":\"@\\/path\\/to\\/\\/ExampleImage.png\"\n}\nResponse Arguments\nName\nType\nDescription\n            guid\n        \n            String\n        \n            The temp ID of the image.\n        \nResponse\n{\n   \"picture\":{\n      \"guid\":\"50a8760d-966f-9d7e-f45c-513037fac8fc\"\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/temp/file/:field POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefield_POST/index.html"}
{"id": "a52b0cb1c01f-0", "text": "/EmbeddedFiles/:record/file/:field GET\nOverview\n    Retrieves an attached file for a specific field on a record.\nRequest Arguments\n    This endpoint does not accept any request arguments.\nResponse Arguments\n    The response from this request is an HTTP response with a forced download. This can be used in rendering images through the API or in offering immediate file downloads.\nResponse\nCache-Control: no-cache, must-revalidate Connection: keep-alive Content-Encoding: gzip Content-Type: application/octet-stream Date: Mon, 30 Jan 2012 17:00:46 GMT Expires: Mon, 30 Jan 2012 17:00:45 GMT Last-Modified: Thu, 10 Nov 2011 19:01:31 GMT Transfer-Encoding: chunked Vary: Accept-Encoding...\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/file/:field GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmbeddedFilesrecordfilefield_GET/index.html"}
{"id": "6490f5b65809-0", "text": "/pmse_Project/ActivityDefinition/:record GET\nOverview\n    Retrieves the definition data for an activity\nSummary\n    This endpoint will retrieve the JSON encoded definition data for the Process\n    Definition activity identified by the record input parameter.\nRequest Arguments\nName\nType\nDescription\nRequired\nrecord\nString\nThe value for the act_uid field in the pmse_bpmn_activity record\nTrue\nResponse Arguments\nName\nType\nDescription\nsuccess\nBoolean\nThe status of the response\n<field>\n<value>\nField value in the pmse_bpmn_activity record\nResponse\n{\n    \"success\":true,\n    \"id\":\"566f0156-0ce3-75b4-da56-573cb73984aa\",\n    \"name\":\"Action # 1\",\n    \"date_entered\":\"2016-05-18 18:41:29\",\n    \"date_modified\":\"2016-05-18 18:42:00\",\n    \"modified_user_id\":\"1\",\n    \"created_by\":\"1\",\n    \"description\":null,\n    \"deleted\":\"0\",\n    \"pro_id\":\"9f8c4fcd-8d4c-949d-50b8-573caddf8c0c\",\n    \"act_type\":\"TASK\",\n    \"act_duration\":\"0\",\n    \"act_duration_unit\":\"DAYS\",\n    \"act_send_notification\":\"0\",\n    \"act_assignment_method\":\"balanced\",\n    \"act_assign_team\":\"\",\n    \"act_assign_user\":\"\",\n    \"act_value_based_assignment\":\"\",\n    \"act_reassign\":\"0\",\n    \"act_reassign_team\":\"\",\n    \"act_adhoc\":\"0\",\n    \"act_adhoc_behavior\":\"\",\n    \"act_adhoc_team\":\"\",\n    \"act_response_buttons\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html"}
{"id": "6490f5b65809-1", "text": "\"act_adhoc_team\":\"\",\n    \"act_response_buttons\":\"\",\n    \"act_last_user_assigned\":\"\",\n    \"act_field_module\":\"Accounts\",\n    \"act_fields\":\"[{\\u0022name\\u0022:\\u0022Assigned to\\u0022,\\u0022field\\u0022:\\u0022assigned_user_id\\u0022,\\u0022value\\u0022:\\u0022currentuser\\u0022,\\u0022type\\u0022:\\u0022user\\u0022,\\u0022label\\u0022:\\u0022Current user\\u0022}]\",\n    \"act_readonly_fields\":\n    [\n        {\n            \"name\":\"phone_alternate\",\n            \"label\":\"Alternate Phone\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"annual_revenue\",\n            \"label\":\"Annual Revenue\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"billing_address_city\",\n            \"label\":\"Billing City\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"billing_address_country\",\n            \"label\":\"Billing Country\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"billing_address_postalcode\",\n            \"label\":\"Billing Postal Code\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"billing_address_state\",\n            \"label\":\"Billing State\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"billing_address_street\",\n            \"label\":\"Billing Street\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"created_by\",\n            \"label\":\"Created By\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"description\",\n            \"label\":\"Description\",\n            \"readonly\":false\n        },", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html"}
{"id": "6490f5b65809-2", "text": "\"label\":\"Description\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"duns_num\",\n            \"label\":\"DUNS\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"employees\",\n            \"label\":\"Employees\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"facebook\",\n            \"label\":\"Facebook Account\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"phone_fax\",\n            \"label\":\"Fax\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"googleplus\",\n            \"label\":\"Google Plus ID\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"industry\",\n            \"label\":\"Industry\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"modified_user_id\",\n            \"label\":\"Modified By\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"name\",\n            \"label\":\"Name\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"phone_office\",\n            \"label\":\"Office Phone\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"ownership\",\n            \"label\":\"Ownership\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"rating\",\n            \"label\":\"Rating\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"shipping_address_city\",\n            \"label\":\"Shipping City\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"shipping_address_country\",\n            \"label\":\"Shipping Country\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"shipping_address_postalcode\",\n            \"label\":\"Shipping Postal Code\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html"}
{"id": "6490f5b65809-3", "text": "\"name\":\"shipping_address_postalcode\",\n            \"label\":\"Shipping Postal Code\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"shipping_address_state\",\n            \"label\":\"Shipping State\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"shipping_address_street\",\n            \"label\":\"Shipping Street\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"sic_code\",\n            \"label\":\"SIC Code\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"ticker_symbol\",\n            \"label\":\"Ticker Symbol\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"twitter\",\n            \"label\":\"Twitter Account\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"account_type\",\n            \"label\":\"Type\",\n            \"readonly\":false\n        },\n        {\n            \"name\":\"website\",\n            \"label\":\"Website\",\n            \"readonly\":false\n        }\n    ],\n    \"act_expected_time\":\n    {\n        \"time\":\"\",\n        \"unit\":\"hour\"\n    },\n    \"act_required_fields\":\n    [\n        {\n            \"name\":\"phone_alternate\",\n            \"label\":\"Alternate Phone\",\n            \"required\":false\n        },\n        {\n            \"name\":\"annual_revenue\",\n            \"label\":\"Annual Revenue\",\n            \"required\":false\n        },\n        {\n            \"name\":\"billing_address_city\",\n            \"label\":\"Billing City\",\n            \"required\":false\n        },\n        {\n            \"name\":\"billing_address_country\",\n            \"label\":\"Billing Country\",\n            \"required\":false\n        },\n        {\n            \"name\":\"billing_address_postalcode\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html"}
{"id": "6490f5b65809-4", "text": "},\n        {\n            \"name\":\"billing_address_postalcode\",\n            \"label\":\"Billing Postal Code\",\n            \"required\":false\n        },\n        {\n            \"name\":\"billing_address_state\",\n            \"label\":\"Billing State\",\n            \"required\":false\n        },\n        {\n            \"name\":\"billing_address_street\",\n            \"label\":\"Billing Street\",\n            \"required\":false\n        },\n        {\n            \"name\":\"created_by\",\n            \"label\":\"Created By\",\n            \"required\":false\n        },\n        {\n            \"name\":\"description\",\n            \"label\":\"Description\",\n            \"required\":false\n        },\n        {\n            \"name\":\"duns_num\",\n            \"label\":\"DUNS\",\n            \"required\":false\n        },\n        {\n            \"name\":\"employees\",\n            \"label\":\"Employees\",\n            \"required\":false\n        },\n        {\n            \"name\":\"facebook\",\n            \"label\":\"Facebook Account\",\n            \"required\":false\n        },\n        {\n            \"name\":\"phone_fax\",\n            \"label\":\"Fax\",\n            \"required\":false\n        },\n        {\n            \"name\":\"googleplus\",\n            \"label\":\"Google Plus ID\",\n            \"required\":false\n        },\n        {\n            \"name\":\"industry\",\n            \"label\":\"Industry\",\n            \"required\":false\n        },\n        {\n            \"name\":\"modified_user_id\",\n            \"label\":\"Modified By\",\n            \"required\":false\n        },\n        {\n            \"name\":\"phone_office\",\n            \"label\":\"Office Phone\",\n            \"required\":false\n        },\n        {\n            \"name\":\"ownership\",\n            \"label\":\"Ownership\",\n            \"required\":false\n        },\n        {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html"}
{"id": "6490f5b65809-5", "text": "\"label\":\"Ownership\",\n            \"required\":false\n        },\n        {\n            \"name\":\"rating\",\n            \"label\":\"Rating\",\n            \"required\":false\n        },\n        {\n            \"name\":\"shipping_address_city\",\n            \"label\":\"Shipping City\",\n            \"required\":false\n        },\n        {\n            \"name\":\"shipping_address_country\",\n            \"label\":\"Shipping Country\",\n            \"required\":false\n        },\n        {\n            \"name\":\"shipping_address_postalcode\",\n            \"label\":\"Shipping Postal Code\",\n            \"required\":false\n        },\n        {\n            \"name\":\"shipping_address_state\",\n            \"label\":\"Shipping State\",\n            \"required\":false\n        },\n        {\n            \"name\":\"shipping_address_street\",\n            \"label\":\"Shipping Street\",\n            \"required\":false\n        },\n        {\n            \"name\":\"sic_code\",\n            \"label\":\"SIC Code\",\n            \"required\":false\n        },\n        {\n            \"name\":\"ticker_symbol\",\n            \"label\":\"Ticker Symbol\",\n            \"required\":false\n        },\n        {\n            \"name\":\"twitter\",\n            \"label\":\"Twitter Account\",\n            \"required\":false\n        },\n        {\n            \"name\":\"account_type\",\n            \"label\":\"Type\",\n            \"required\":false\n        },\n        {\n            \"name\":\"website\",\n            \"label\":\"Website\",\n            \"required\":false\n        }\n    ],\n    \"act_related_modules\":[],\n    \"act_service_url\":null,\n    \"act_service_params\":null,\n    \"act_service_method\":null,\n    \"act_update_record_owner\":null,\n    \"execution_mode\":\"DEFAULT\",\n    \"assigned_user_id\":\"\",\n    \"au_first_name\":null,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html"}
{"id": "6490f5b65809-6", "text": "\"assigned_user_id\":\"\",\n    \"au_first_name\":null,\n    \"au_last_name\":null,\n    \"cbu_first_name\":null,\n    \"cbu_last_name\":\"Administrator\",\n    \"mbu_first_name\":null,\n    \"mbu_last_name\":\"Administrator\",\n    \"my_favorite\":null\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html"}
{"id": "8373b7897e85-0", "text": "/Users/:record/link/:link_name/:remote_id DELETE\nOverview\n    Deletes an existing relationship between two records.\nRequest Arguments\n    This endpoint does not accept any arguments.\nResponse Arguments\nName\nType\nDescription\n            record\n        \n            Array\n        \n            The record to disassociate from the related record.\n        \n            related_record\n        \n            Array\n        \n            The record that was disassociated.\n        \nResponse\n{\n   \"record\":{\n      \"id\":\"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n      \"name\":\"Slender Broadband Inc - 1000 units\",\n      \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n      \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n      \"modified_user_id\":\"1\",\n      \"modified_by_name\":\"Administrator\",\n      \"created_by\":\"1\",\n      \"created_by_name\":\"Administrator\",\n      \"description\":\"\",\n      \"img\":\"\",\n      \"last_activity_date\":\"2013-02-28T18:36:00+00:00\",\n      \"deleted\":false,\n      \"assigned_user_id\":\"seed_max_id\",\n      \"assigned_user_name\":\"Max Jensen\",\n      \"team_name\":[\n         {\n            \"id\":\"East\",\n            \"name\":\"East\",\n            \"name_2\":\"\",\n            \"primary\":false\n         },\n         {\n            \"id\":\"West\",\n            \"name\":\"West\",\n            \"name_2\":\"\",\n            \"primary\":true\n         }\n      ],\n      \"opportunity_type\":\"\",\n      \"account_name\":\"Slender Broadband Inc\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_DELETE/index.html"}
{"id": "8373b7897e85-1", "text": "\"opportunity_type\":\"\",\n      \"account_name\":\"Slender Broadband Inc\",\n      \"account_id\":\"181461c6-dc81-1115-1fe0-512d092e8f15\",\n      \"campaign_id\":\"\",\n      \"campaign_name\":\"\",\n      \"lead_source\":\"Campaign\",\n      \"amount\":\"25000\",\n      \"base_rate\":\"1\",\n      \"amount_usdollar\":\"25000\",\n      \"currency_id\":\"-99\",\n      \"currency_name\":\"\",\n      \"currency_symbol\":\"\",\n      \"date_closed\":\"2013-02-27\",\n      \"date_closed_timestamp\":\"1361992480\",\n      \"next_step\":\"\",\n      \"sales_stage\":\"Needs Analysis\",\n      \"sales_status\":\"New\",\n      \"probability\":\"90\",\n      \"best_case\":\"25000\",\n      \"worst_case\":\"25000\",\n      \"commit_stage\":\"include\",\n      \"my_favorite\":false,\n      \"_acl\":{\n         \"fields\":{\n         }\n      }\n   },\n   \"related_record\":{\n      \"id\":\"e689173e-c953-1e14-c215-512d0927e7a2\",\n      \"name\":\"Gus Dales\",\n      \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n      \"date_modified\":\"2013-02-26T19:12:00+00:00\",\n      \"modified_user_id\":\"1\",\n      \"modified_by_name\":\"Administrator\",\n      \"created_by\":\"1\",\n      \"created_by_name\":\"Administrator\",\n      \"description\":\"\",\n      \"img\":\"\",\n      \"deleted\":false,\n      \"assigned_user_id\":\"seed_sally_id\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_DELETE/index.html"}
{"id": "8373b7897e85-2", "text": "\"deleted\":false,\n      \"assigned_user_id\":\"seed_sally_id\",\n      \"assigned_user_name\":\"Sally Bronsen\",\n      \"team_name\":[\n         {\n            \"id\":\"West\",\n            \"name\":\"West\",\n            \"name_2\":\"\",\n            \"primary\":true\n         }\n      ],\n      \"salutation\":\"\",\n      \"first_name\":\"Gus\",\n      \"last_name\":\"Dales\",\n      \"full_name\":\"Gus Dales\",\n      \"title\":\"Director Operations\",\n      \"linkedin\":\"\",\n      \"facebook\":\"\",\n      \"twitter\":\"\",\n      \"googleplus\":\"\",\n      \"department\":\"\",\n      \"do_not_call\":false,\n      \"phone_home\":\"(661) 120-2292\",\n      \"email\":[\n         {\n            \"email_address\":\"section.sugar.section@example.it\",\n            \"opt_out\":\"1\",\n            \"invalid_email\":\"0\",\n            \"primary_address\":\"0\"\n         },\n         {\n            \"email_address\":\"support.qa.kid@example.co.uk\",\n            \"opt_out\":\"0\",\n            \"invalid_email\":\"0\",\n            \"primary_address\":\"1\"\n         }\n      ],\n      \"phone_mobile\":\"(294) 447-9707\",\n      \"phone_work\":\"(036) 840-3216\",\n      \"phone_other\":\"\",\n      \"phone_fax\":\"\",\n      \"email1\":\"support.qa.kid@example.co.uk\",\n      \"email2\":\"section.sugar.section@example.it\",\n      \"invalid_email\":false,\n      \"email_opt_out\":false,\n      \"primary_address_street\":\"48920 San Carlos Ave\",\n      \"primary_address_street_2\":\"\",\n      \"primary_address_street_3\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_DELETE/index.html"}
{"id": "8373b7897e85-3", "text": "\"primary_address_street_2\":\"\",\n      \"primary_address_street_3\":\"\",\n      \"primary_address_city\":\"Persistance\",\n      \"primary_address_state\":\"CA\",\n      \"primary_address_postalcode\":\"54556\",\n      \"primary_address_country\":\"USA\",\n      \"alt_address_street\":\"\",\n      \"alt_address_street_2\":\"\",\n      \"alt_address_street_3\":\"\",\n      \"alt_address_city\":\"\",\n      \"alt_address_state\":\"\",\n      \"alt_address_postalcode\":\"\",\n      \"alt_address_country\":\"\",\n      \"assistant\":\"\",\n      \"assistant_phone\":\"\",\n      \"picture\":\"\",\n      \"email_and_name1\":\"\",\n      \"lead_source\":\"Support Portal User Registration\",\n      \"account_name\":\"Arts & Crafts Inc\",\n      \"account_id\":\"d43243c6-9b8e-2973-aee2-512d09bc34b4\",\n      \"opportunity_role_fields\":\"\",\n      \"opportunity_role_id\":\"\",\n      \"opportunity_role\":\"\",\n      \"reports_to_id\":\"\",\n      \"report_to_name\":\"\",\n      \"portal_name\":\"GusDales145\",\n      \"portal_active\":true,\n      \"portal_password\":\"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0\",\n      \"portal_password1\":\"\",\n      \"portal_app\":\"\",\n      \"preferred_language\":\"en_us\",\n      \"campaign_id\":\"\",\n      \"campaign_name\":\"\",\n      \"c_accept_status_fields\":\"\",\n      \"m_accept_status_fields\":\"\",\n      \"accept_status_id\":\"\",\n      \"accept_status_name\":\"\",\n      \"sync_contact\":\"\",\n      \"my_favorite\":false,\n      \"_acl\":{\n         \"fields\":{\n         }", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_DELETE/index.html"}
{"id": "8373b7897e85-4", "text": "\"_acl\":{\n         \"fields\":{\n         }\n      }\n   }\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/link/:link_name/:remote_id DELETE endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_DELETE/index.html"}
{"id": "420cab7e608b-0", "text": "/OutboundEmail/:record PUT\nOverview\n    Update an OutboundEmail configuration.\nSummary\n    Each configuration that is saved is validated first by attempting to connect to the server.\nRequest Arguments\nName\nType\nDescription\nRequired\n                name\n            \n                String\n            \n                The display name of the configuration.\n            \n                False\n            \n                mail_sendtype\n            \n                String\n            \n                Only SMTP is supported. It is recommended that you do not change this from smtp.\n            \n                False\n            \n                mail_smtptype\n            \n                String\n            \n                The email provider through which emails are sent. This is merely a convenience which allows for\n                prepopulating data in the UI. Possible values are: google, exchange, outlook, other.\n            \n                False\n            \n                mail_smtpserver\n            \n                String\n            \n                The address of the SMTP server.\n            \n                False\n            \n                mail_smtpport\n            \n                Integer\n            \n                The port on which to connect to the SMTP server.\n            \n                False\n            \n                mail_smtpuser\n            \n                String\n            \n                The username for authenticating with the SMTP server. It is only required if mail_smtpauth_req is\n                true.\n            \n                False\n            \n                mail_smtppass\n            \n                String\n            \n                The password for authenticating with the SMTP server. It is only required if\n                mail_smtpauth_req is true.\n            \n                False\n            \n                mail_smtpauth_req\n            \n                Boolean\n            \n                Indicates whether or not the SMTP server requires authentication.\n            \n                False\n            \n                mail_smtpssl\n            \n                String\n            \n                The encryption protocol used for connecting to the SMTP server. \"0\" represents no encryption.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmailrecord_PUT/index.html"}
{"id": "420cab7e608b-1", "text": "The encryption protocol used for connecting to the SMTP server. \"0\" represents no encryption.\n                \"1\" represents SSL. \"2\" represents TLS.\n            \n                False\n            \nRequest\n{\n  \"mail_smtpport\": 587,\n  \"mail_smtpssl\": \"2\"\n}\nResponse Arguments\nName\nType\nDescription\n            name\n        \n            String\n        \n            The display name of the configuration.\n        \n            type\n        \n            String\n        \n            Possible values are: user, system, system-override. Only the administrator may update the system\n            configuration. This field may never change.\n        \n            user_id\n        \n            String\n        \n            The current user's ID. The current user may only update configurations that he or she owns.\n        \n            mail_sendtype\n        \n            String\n        \n            Only SMTP is supported, smtp will always be returned.\n        \n            mail_smtptype\n        \n            String\n        \n            The email provider through which emails are sent. Possible values are: google, exchange, outlook, other.\n        \n            mail_smtpserver\n        \n            String\n        \n            The address of the SMTP server.\n        \n            mail_smtpport\n        \n            Integer\n        \n            The port on which to connect to the SMTP server.\n        \n            mail_smtpuser\n        \n            String\n        \n            The username for authenticating with the SMTP server.\n        \n            mail_smtppass\n        \n            Boolean\n        \n            Indicates whether or not a password exists. true is returned for this field when a password does\n            exist. This field is not included in the response when a password does not exist.\n        \n            mail_smtpauth_req\n        \n            Boolean", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmailrecord_PUT/index.html"}
{"id": "420cab7e608b-2", "text": "mail_smtpauth_req\n        \n            Boolean\n        \n            Indicates whether or not the SMTP server requires authentication.\n        \n            mail_smtpssl\n        \n            String\n        \n            The encryption protocol used for connecting to the SMTP server.\n        \nResponse\n{\n  \"id\": \"e04ce998-960e-11e6-8628-3c15c2d582c6\",\n  \"name\": \"My Exchange Account\",\n  \"type\": \"user\",\n  \"user_id\": \"e91b1fa7-1bd8-3c71-be96-512e643f9ca4\",\n  \"mail_sendtype\": \"smtp\",\n  \"mail_smtptype\": \"exchange\",\n  \"mail_smtpserver\": \"smtp.example.com\",\n  \"mail_smtpport\": 587,\n  \"mail_smtpuser\": \"foo@example.com\",\n  \"mail_smtppass\": true,\n  \"mail_smtpauth_req\": true,\n  \"mail_smtpssl\": \"2\",\n  \"deleted\": false,\n  \"my_favorite\": false,\n  \"_acl\": {\n    \"fields\": {}\n  },\n  \"_module\": \"OutboundEmail\"\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /OutboundEmail/:record PUT endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmailrecord_PUT/index.html"}
{"id": "73bd53b61120-0", "text": "/me/password POST\nOverview\n    Create a new record of a specified type.\nSummary\nThis endpoint allows for verification of the user's password. If client type is support_portal, it will update the corrending Contact. Otherwise, it will update User\nRequest Arguments\nName\nType\nDescription\nRequired\n            password_to_verify\n        \n            String\n        \n            The password to verify\n        \n            True\n        \nRequest\n{\n   \"password_to_verify\":\"mycurrentpassword\"\n}\nResponse Arguments\nName\nType\nDescription\n            valid\n        \n            Boolean\n        \n            Returns the success of the password verification.\n        \nResponse\n{\n    \"valid\":true\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /me/password POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mepassword_POST/index.html"}
{"id": "3823c6e5a01d-0", "text": "/login/content GET\nOverview\n    Returns information to facilitate receiving marketing content from SugarCRM.\nRequest Arguments\nName\nType\nDescription\nRequired\n            selected_language\n        \n            String\n        \n            Code for the desired marketing content language. (Eg. \"en_us\", \"fr_FR\").\n            Providing a certain language code does not guarantee that content returned will be in the provided language.\n            If an invalid language is specified, will assume \"en_us\".\n        \n            False. Defaults to \"en_us\"\nResponse Arguments\nName\nType\nDescription\n            content_url\n        \n            String\n        \n            URL suitable for embedding in an iFrame that links to new marketing material from SugarCRM.\n            Will always be provided, but may be an empty string if there is no suitable content available.\n        \nResponse\n{\n   \"content_url\": \"https://marketing.sugarcrm.com/exciting-new-content\"\n}\nChange Log\nVersion\nChange\n            v11_2\n        \n            Added /login/content GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/logincontent_GET/index.html"}
{"id": "ae66d51e1a8b-0", "text": "/KBContents/:record/link POST\nOverview\n    Creates relationships to a pre-existing record.\nRequest Arguments\nName\nType\nDescription\nRequired\n            <relationship link>\n        \n            <string>\n        \n            Link between targeted and related records.\n        \n            True\n        \n            <record ID>\n        \n            <string>\n        \n            The name value list of related records. Each item of the list may be either string equal to related item ID,\n            or map containing record ID (\"id\" key is required in this case)\n            and addition relationship properties.\n        \n            True\n        \nRequest\n{\n    link_name: \"accounts\"\n    ids: [\n        \"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n        {\n            \"id\": \"e689173e-c953-1e14-c215-512d0927e7a2\",\n            \"role\": \"owner\"\n        }\n    ]\n}\nResponse Arguments\nName\nType\nDescription\n            record\n        \n            Array\n        \n            The record linked to related records.\n        \n            related_records\n        \n            Array\n        \n            Records that were associated.\n        \nResponse\n    \"record\": {\n        \"id\": \"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n        \"name\": \"Slender Broadband Inc - 1000 units\",\n        \"date_entered\": \"2013-02-26T19:12:00+00:00\",\n        \"date_modified\": \"2013-02-26T19:12:00+00:00\",\n        \"modified_user_id\": \"1\",\n        \"modified_by_name\": \"Administrator\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html"}
{"id": "ae66d51e1a8b-1", "text": "\"modified_user_id\": \"1\",\n        \"modified_by_name\": \"Administrator\",\n        \"created_by\": \"1\",\n        \"created_by_name\": \"Administrator\",\n        \"description\": \"\",\n        \"img\": \"\",\n        \"last_activity_date\": \"2013-02-28T18:21:00+00:00\",\n        \"deleted\": false,\n        \"assigned_user_id\": \"seed_max_id\",\n        \"assigned_user_name\": \"Max Jensen\",\n        \"team_name\": [\n            {\n                \"id\": \"East\",\n                \"name\": \"East\",\n                \"name_2\": \"\",\n                \"primary\": false\n            },\n            {\n                \"id\": \"West\",\n                \"name\": \"West\",\n                \"name_2\": \"\",\n                \"primary\": true\n            }\n        ],\n        \"opportunity_type\": \"\",\n        \"account_name\": \"Slender Broadband Inc\",\n        \"account_id\": \"181461c6-dc81-1115-1fe0-512d092e8f15\",\n        \"campaign_id\": \"\",\n        \"campaign_name\": \"\",\n        \"lead_source\": \"Campaign\",\n        \"amount\": \"25000\",\n        \"base_rate\": \"1\",\n        \"amount_usdollar\": \"25000\",\n        \"currency_id\": \"-99\",\n        \"currency_name\": \"\",\n        \"currency_symbol\": \"\",\n        \"date_closed\": \"2013-02-27\",\n        \"date_closed_timestamp\": \"1361992480\",\n        \"next_step\": \"\",\n        \"sales_stage\": \"Needs Analysis\",\n        \"sales_status\": \"New\",\n        \"probability\": \"90\",\n        \"best_case\": \"25000\",\n        \"worst_case\": \"25000\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html"}
{"id": "ae66d51e1a8b-2", "text": "\"worst_case\": \"25000\",\n        \"commit_stage\": \"include\",\n        \"my_favorite\": false,\n        \"_acl\": {\n            \"fields\": {\n            }\n        }\n    },\n    \"related_records\": [\n        {\n            \"id\": \"e689173e-c953-1e14-c215-512d0927e7a2\",\n            \"name\": \"Gus Dales\",\n            \"date_entered\": \"2013-02-26T19:12:00+00:00\",\n            \"date_modified\": \"2013-02-26T19:12:00+00:00\",\n            \"modified_user_id\": \"1\",\n            \"modified_by_name\": \"Administrator\",\n            \"created_by\": \"1\",\n            \"created_by_name\": \"Administrator\",\n            \"description\": \"\",\n            \"img\": \"\",\n            \"deleted\": false,\n            \"assigned_user_id\": \"seed_sally_id\",\n            \"assigned_user_name\": \"Sally Bronsen\",\n            \"team_name\": [\n                {\n                    \"id\": \"West\",\n                    \"name\": \"West\",\n                    \"name_2\": \"\",\n                    \"primary\": true\n                }\n            ],\n            \"salutation\": \"\",\n            \"first_name\": \"Gus\",\n            \"last_name\": \"Dales\",\n            \"full_name\": \"Gus Dales\",\n            \"title\": \"Director Operations\",\n            \"linkedin\": \"\",\n            \"facebook\": \"\",\n            \"twitter\": \"\",\n            \"googleplus\": \"\",\n            \"department\": \"\",\n            \"do_not_call\": false,\n            \"phone_home\": \"(661) 120-2292\",\n            \"email\": [\n                {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html"}
{"id": "ae66d51e1a8b-3", "text": "\"email\": [\n                {\n                    \"email_address\": \"section.sugar.section@example.it\",\n                    \"opt_out\": \"1\",\n                    \"invalid_email\": \"0\",\n                    \"primary_address\": \"0\"\n                },\n                {\n                    \"email_address\": \"support.qa.kid@example.co.uk\",\n                    \"opt_out\": \"0\",\n                    \"invalid_email\": \"0\",\n                    \"primary_address\": \"1\"\n                }\n            ],\n            \"phone_mobile\": \"(294) 447-9707\",\n            \"phone_work\": \"(036) 840-3216\",\n            \"phone_other\": \"\",\n            \"phone_fax\": \"\",\n            \"email1\": \"support.qa.kid@example.co.uk\",\n            \"email2\": \"section.sugar.section@example.it\",\n            \"invalid_email\": false,\n            \"email_opt_out\": false,\n            \"primary_address_street\": \"48920 San Carlos Ave\",\n            \"primary_address_street_2\": \"\",\n            \"primary_address_street_3\": \"\",\n            \"primary_address_city\": \"Persistance\",\n            \"primary_address_state\": \"CA\",\n            \"primary_address_postalcode\": \"54556\",\n            \"primary_address_country\": \"USA\",\n            \"alt_address_street\": \"\",\n            \"alt_address_street_2\": \"\",\n            \"alt_address_street_3\": \"\",\n            \"alt_address_city\": \"\",\n            \"alt_address_state\": \"\",\n            \"alt_address_postalcode\": \"\",\n            \"alt_address_country\": \"\",\n            \"assistant\": \"\",\n            \"assistant_phone\": \"\",\n            \"picture\": \"\",\n            \"email_and_name1\": \"\",\n            \"lead_source\": \"Support Portal User Registration\",\n            \"account_name\": \"Arts & Crafts Inc\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html"}
{"id": "ae66d51e1a8b-4", "text": "\"account_name\": \"Arts & Crafts Inc\",\n            \"account_id\": \"d43243c6-9b8e-2973-aee2-512d09bc34b4\",\n            \"opportunity_role_fields\": \"\",\n            \"opportunity_role_id\": \"\",\n            \"opportunity_role\": \"Technical Advisor\",\n            \"reports_to_id\": \"\",\n            \"report_to_name\": \"\",\n            \"portal_name\": \"GusDales145\",\n            \"portal_active\": true,\n            \"portal_password\": \"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0\",\n            \"portal_password1\": \"\",\n            \"portal_app\": \"\",\n            \"preferred_language\": \"en_us\",\n            \"campaign_id\": \"\",\n            \"campaign_name\": \"\",\n            \"c_accept_status_fields\": \"\",\n            \"m_accept_status_fields\": \"\",\n            \"accept_status_id\": \"\",\n            \"accept_status_name\": \"\",\n            \"sync_contact\": \"\",\n            \"my_favorite\": false,\n            \"_acl\": {\n                \"fields\": {\n                }\n            }\n        },\n        {\n            \"id\": \"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n            \"name\": \"Slender Broadband Inc - 1000 units\",\n            \"date_entered\": \"2013-02-26T19:12:00+00:00\",\n            \"date_modified\": \"2013-02-26T19:12:00+00:00\",\n            \"modified_user_id\": \"1\",\n            \"modified_by_name\": \"Administrator\",\n            \"created_by\": \"1\",\n            \"created_by_name\": \"Administrator\",\n            \"description\": \"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html"}
{"id": "ae66d51e1a8b-5", "text": "\"created_by_name\": \"Administrator\",\n            \"description\": \"\",\n            \"img\": \"\",\n            \"last_activity_date\": \"2013-02-28T18:36:00+00:00\",\n            \"deleted\": false,\n            \"assigned_user_id\": \"seed_max_id\",\n            \"assigned_user_name\": \"Max Jensen\",\n            \"team_name\": [\n                {\n                    \"id\": \"East\",\n                    \"name\": \"East\",\n                    \"name_2\": \"\",\n                    \"primary\": false\n                },\n                {\n                    \"id\": \"West\",\n                    \"name\": \"West\",\n                    \"name_2\": \"\",\n                    \"primary\": true\n                }\n            ],\n            \"opportunity_type\": \"\",\n            \"account_name\": \"Slender Broadband Inc\",\n            \"account_id\": \"181461c6-dc81-1115-1fe0-512d092e8f15\",\n            \"campaign_id\": \"\",\n            \"campaign_name\": \"\",\n            \"lead_source\": \"Campaign\",\n            \"amount\": \"25000\",\n            \"base_rate\": \"1\",\n            \"amount_usdollar\": \"25000\",\n            \"currency_id\": \"-99\",\n            \"currency_name\": \"\",\n            \"currency_symbol\": \"\",\n            \"date_closed\": \"2013-02-27\",\n            \"date_closed_timestamp\": \"1361992480\",\n            \"next_step\": \"\",\n            \"sales_stage\": \"Needs Analysis\",\n            \"sales_status\": \"New\",\n            \"probability\": \"90\",\n            \"best_case\": \"25000\",\n            \"worst_case\": \"25000\",\n            \"commit_stage\": \"include\",\n            \"my_favorite\": false,\n            \"_acl\": {\n                \"fields\": {\n                }", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html"}
{"id": "ae66d51e1a8b-6", "text": "\"_acl\": {\n                \"fields\": {\n                }\n            }\n        }\n    ]\n}\nChange Log\nVersion\nChange\n            v10 (7.6.0)\n        \n            Added support for additional relationship values.\n        \n            v10 (7.1.5)\n        \n            Added /<module>/:record/link POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html"}
{"id": "dbdf986cff6a-0", "text": "/Leads POST\nCreate Lead with optional post-save actions\nSummary:\n    This endpoint is used to create a Lead with the optional post-save actions for Convert Target/Prospect and\n    Create Lead from Email operations.\nQuery Parameters:\nParam\nDescription\nOptional\nprospect_id\nPass a prospect id if Lead is being created as part of a Convert Target/Prospect process\nOptional\ninbound_email_id\nPass an inbound email id if Lead is being created from an Email\nOptional\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Leads_POST/index.html"}
{"id": "00f0b9e0a1b0-0", "text": "/ForecastWorksheets/:timeperiod_id/:user_id GET\nReturns a collection of ForecastWorksheet models\nSummary:\nThis end point is used to return the Worksheets for a user at a given timeperiod.  If no timeperiod is provide it\n    will use the default timeperiod, likewise if no user is provided, it will default to the logged in user.\nAlso this end points use the visibility requirements set forth by the application, that if the records being requested\n    belong to you, you will get the draft version,  If the worksheet is not yours, you will only see the committed version.\nUrl Parameters:\nParam\nDescription\nOptional\ntimeperiod_id\nShow for a specific time period, defaults to the current time period if one is not passed\nOptional\nuser_id\nShow for a specific user, defaults to current user if not defined\nOptional\nQuery Parameters:\nParam\nDescription\nOptional\ntype\nWhich type to return, currently the ones that are supported are, opportunity and product\nOptional\nPossible Errors\nError\nDescription\n412 - Invalid Parameter\nWhen the passed in timeperiod and/or user can not be found\n403 - Not Authorized\nIf you are not a manager, but you are tyring to view another sales rep forecast worksheet, you will receive a 403 Not Authorized Error\nUrl Example:\n        /rest/v10/ForecastWorksheets/:timeperiod_id/:user_id\n    \nOutput Example:\n        { \"next_offset\": -1,\n        \"records\": [\n            {\n                \"id\": \"ad3908c7-83a3-f360-c223-51117844c208\",\n                \"name\": \"Grow-Fast Inc - 1000 units\",\n                \"date_entered\": \"2013-02-05T21:22:00+00:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetstimeperiod_iduser_id_GET/index.html"}
{"id": "00f0b9e0a1b0-1", "text": "\"date_modified\": \"2013-02-05T21:22:00+00:00\",\n                \"modified_user_id\": \"1\",\n                \"modified_by_name\": \"Administrator\",\n                \"created_by\": \"1\",\n                \"created_by_name\": \"Administrator\",\n                \"description\": \"\",\n                \"img\": \"\",\n                \"deleted\": \"0\",\n                \"assigned_user_id\": \"seed_jim_id\",\n                \"assigned_user_name\": \"Jim Brennan\",\n                \"team_name\": [\n                    {\n                        \"id\": \"East\",\n                        \"name\": \"East\",\n                        \"name_2\": \"\",\n                        \"primary\": true\n                    }\n                ],\n                \"parent_id\": \"50b90565-e748-ed77-d9d7-511178f5acae\",\n                \"parent_type\": \"Opportunities\",\n                \"account_name\": \"\",\n                \"account_id\": \"\",\n                \"likely_case\": \"75000\",\n                \"best_case\": \"75000\",\n                \"worst_case\": \"75000\",\n                \"base_rate\": \"1\",\n                \"currency_id\": \"-99\",\n                \"currency_name\": \"\",\n                \"currency_symbol\": \"\",\n                \"date_closed\": \"2013-02-10\",\n                \"date_closed_timestamp\": \"1360531443\",\n                \"sales_stage\": \"Perception Analysis\",\n                \"probability\": \"70\",\n                \"commit_stage\": \"include\",\n                \"draft\": \"1\",\n                \"my_favorite\": false,\n                \"_acl\": {\n                    \"fields\": {}\n                }\n            }]\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetstimeperiod_iduser_id_GET/index.html"}
{"id": "287a31eb0d98-0", "text": "/<module>/:record/path GET\nOverview\n    Retrieves all parents of selected record.\nRequest Arguments\nName\nType\nDescription\nRequired\n                module\n            \n                String\n            \n                The name of sugar module that contains a nested set data and implements the NestedSetInterface.\n            \n                True\n            \n                :record\n            \n                String\n            \n                The ID of record\n            \n                True\n            \nResponse Arguments\n    This endpoint does not return any response arguments.\nResponse\n[{\n    \"id\": \"045c03b9-327b-11e4-818b-5404a67f3363\",\n    \"name\": \"Audit\",\n    \"date_entered\": null,\n    \"date_modified\": null,\n    \"modified_user_id\": null,\n    \"created_by\": null,\n    \"description\": null,\n    \"deleted\": \"0\",\n    \"source_id\": null,\n    \"source_type\": null,\n    \"source_meta\": null,\n    \"root\": \"935d3e07-327a-11e4-818b-5404a67f3363\",\n    \"lft\": \"10\",\n    \"rgt\": \"19\",\n    \"level\": \"1\"\n}, {\n    \"id\": \"045c1de6-327b-11e4-818b-5404a67f3363\",\n    \"name\": \"Financial\",\n    \"date_entered\": null,\n    \"date_modified\": null,\n    \"modified_user_id\": null,\n    \"created_by\": null,\n    \"description\": null,\n    \"deleted\": \"0\",\n    \"source_id\": null,\n    \"source_type\": null,\n    \"source_meta\": null,", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordpath_GET/index.html"}
{"id": "287a31eb0d98-1", "text": "\"source_type\": null,\n    \"source_meta\": null,\n    \"root\": \"935d3e07-327a-11e4-818b-5404a67f3363\",\n    \"lft\": \"11\",\n    \"rgt\": \"14\",\n    \"level\": \"2\"\n}]\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/path GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordpath_GET/index.html"}
{"id": "f0be1242f420-0", "text": "/<module>/:record/link/:link_name/add_record_list/:remote_id POST\nOverview\n    Creates relationships to pre-existing record from a record list.\nURL Arguments\nName\nType\nDescription\nRequired\n            <record ID>\n        \n            <string>\n        \n            Target record ID.\n        \n            True.\n        \n            <report ID>\n        \n            <string>\n        \n            Report ID for Saved Report.\n        \n            True.\n        \n            <relationship link>\n        \n            <string>\n        \n            Link between targeted and related records.\n        \n            True.\n        \nRequest\nResponse Arguments\nName\nType\nDescription\n            record\n        \n            Array\n        \n            The record linked to related records.\n        \n            related_records\n        \n            Array\n        \n            Record IDs that were associated.\n        \nResponse\n    \"record\": {\n        \"id\": \"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n        \"name\": \"Slender Broadband Inc - 1000 units\",\n        \"date_entered\": \"2013-02-26T19:12:00+00:00\",\n        \"date_modified\": \"2013-02-26T19:12:00+00:00\",\n        \"modified_user_id\": \"1\",\n        \"modified_by_name\": \"Administrator\",\n        \"created_by\": \"1\",\n        \"created_by_name\": \"Administrator\",\n        \"description\": \"\",\n        \"img\": \"\",\n        \"last_activity_date\": \"2013-02-28T18:21:00+00:00\",\n        \"deleted\": false,\n        \"assigned_user_id\": \"seed_max_id\",\n        \"assigned_user_name\": \"Max Jensen\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameadd_record_listremote_id_POST/index.html"}
{"id": "f0be1242f420-1", "text": "\"assigned_user_name\": \"Max Jensen\",\n        \"team_name\": [\n            {\n                \"id\": \"East\",\n                \"name\": \"East\",\n                \"name_2\": \"\",\n                \"primary\": false\n            },\n            {\n                \"id\": \"West\",\n                \"name\": \"West\",\n                \"name_2\": \"\",\n                \"primary\": true\n            }\n        ],\n        \"opportunity_type\": \"\",\n        \"account_name\": \"Slender Broadband Inc\",\n        \"account_id\": \"181461c6-dc81-1115-1fe0-512d092e8f15\",\n        \"campaign_id\": \"\",\n        \"campaign_name\": \"\",\n        \"lead_source\": \"Campaign\",\n        \"amount\": \"25000\",\n        \"base_rate\": \"1\",\n        \"amount_usdollar\": \"25000\",\n        \"currency_id\": \"-99\",\n        \"currency_name\": \"\",\n        \"currency_symbol\": \"\",\n        \"date_closed\": \"2013-02-27\",\n        \"date_closed_timestamp\": \"1361992480\",\n        \"next_step\": \"\",\n        \"sales_stage\": \"Needs Analysis\",\n        \"sales_status\": \"New\",\n        \"probability\": \"90\",\n        \"best_case\": \"25000\",\n        \"worst_case\": \"25000\",\n        \"commit_stage\": \"include\",\n        \"my_favorite\": false,\n        \"_acl\": {\n            \"fields\": {\n            }\n        }\n    },\n    \"related_records\": [\n        success: [\n            \"e689173e-c953-1e14-c215-512d0927e7a2\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameadd_record_listremote_id_POST/index.html"}
{"id": "f0be1242f420-2", "text": "\"da6a3741-2a81-ba7f-f249-512d0932e94e\",\n            \"181461c6-dc81-1115-1fe0-512d092e8f15\"\n        ],\n        error: []\n    ]\n}\nChange Log\nVersion\nChange\n            v10 (7.2.0)\n        \n            Added /<module>/:record/link/:link_name/add_record_list/:remote_id POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameadd_record_listremote_id_POST/index.html"}
{"id": "1f75a3762018-0", "text": "/metadata/<module>/:segment GET\nOverview\n[ADMIN] Gets the desired segment for a given module.\nSummary\nGets the desired segment for a given module. This is used only for modules that are not visible and thus not in metatdata for the given context. This endpoint is only available to administrators.\nRequest Arguments\nThis endpoint does not accept any request arguments.\nResponse\n{\n    \"fields\": {\n        Any fields associated with the module\n    }\n}\nChange Log\nVersion\nChange\nv11_11\nAdded /metadata/<module>/:segment\u00c2\u00a0GET endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/metadatamodulesegment_GET/index.html"}
{"id": "95e113bfad08-0", "text": "/ConsoleConfiguration/config POST\nOverview\nSaves configuration changes in the database.\nRequest Arguments\nThis endpoint does not accept any request arguments.\nURL Example\n/rest/v11_9/ConsoleConfiguration/config\nRequest Payload Example\n{\n   \"is_setup\":true,\n   \"enabled_modules\":{\n  \t\"c108bb4a-775a-11e9-b570-f218983a1c3e\":[\n     \t    \"Cases\"\n  \t],\n  \t\"da438c86-df5e-11e9-9801-3c15c2c53980\":[\n     \t    \"Accounts\",\n     \t    \"Opportunities\"\n  \t]\n   },\n   \"order_by_primary\":{\n  \t\"c108bb4a-775a-11e9-b570-f218983a1c3e\":{\n     \t    \"Cases\":\"follow_up_datetime:asc\"\n  \t},\n  \t\"da438c86-df5e-11e9-9801-3c15c2c53980\":{\n     \t    \"Accounts\":\"next_renewal_date:asc\",\n     \t    \"Opportunities\":\"date_closed:asc\"\n  \t}\n   },\n   \"order_by_secondary\":{\n  \t\"c108bb4a-775a-11e9-b570-f218983a1c3e\":{\n     \t    \"Cases\":\"\"\n  \t},\n  \t\"da438c86-df5e-11e9-9801-3c15c2c53980\":{\n     \t    \"Accounts\":\"\",\n     \t\"Opportunities\":\"\"\n  \t}\n   },\n   \"filter_def\":{\n  \t\"c108bb4a-775a-11e9-b570-f218983a1c3e\":{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html"}
{"id": "95e113bfad08-1", "text": "\"Cases\":[\n        \t        {\n           \t            \"status\":{\n              \t    \"$not_in\":[\n                 \t        \"Closed\",\n                 \t        \"Rejected\",\n                 \t        \"Duplicate\"\n              \t    ]\n           \t            }\n        \t        },\n        \t        {\n           \t\"$owner\":\"\"\n        \t        }\n     \t    ]\n  \t},\n  \t\"da438c86-df5e-11e9-9801-3c15c2c53980\":{\n     \"Accounts\":[\n        \t{\n           \t    \"$owner\":\"\"\n        \t}\n     ],\n     \"Opportunities\":[\n        \t{\n           \t    \"sales_status\":{\n              \t\"$not_in\":[\n                 \t    \"Closed Won\",\n                 \t    \"Closed Lost\"\n              \t]\n           \t    }\n        \t},\n        \t{\n           \t\"$owner\":\"\"\n        \t}\n     ]\n  \t}\n   },\n   \"defaults\":{\n  \t\"is_setup\":0,\n  \t\"enabled_modules\":{\n     \t\"c108bb4a-775a-11e9-b570-f218983a1c3e\":[\n        \t    \"Cases\"\n     \t\t],\n     \t\"da438c86-df5e-11e9-9801-3c15c2c53980\":[\n        \t    \"Accounts\",\n        \t    \"Opportunities\"\n     \t]\n  \t},\n  \t\"order_by_primary\":{\n     \t\"c108bb4a-775a-11e9-b570-f218983a1c3e\":{\n        \t    \"Cases\":\"follow_up_datetime:asc\"\n     \t},\n     \t\"da438c86-df5e-11e9-9801-3c15c2c53980\":{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html"}
{"id": "95e113bfad08-2", "text": "\"Accounts\":\"next_renewal_date:asc\",\n        \t    \"Opportunities\":\"date_closed:asc\"\n     \t}\n  \t},\n  \t\"order_by_secondary\":{\n     \t\"c108bb4a-775a-11e9-b570-f218983a1c3e\":{\n        \t    \"Cases\":\"\"\n     \t},\n     \t\"da438c86-df5e-11e9-9801-3c15c2c53980\":{\n        \t    \"Accounts\":\"\",\n        \t    \"Opportunities\":\"\"\n     \t}\n  \t},\n  \t\"filter_def\":{\n     \t    \"c108bb4a-775a-11e9-b570-f218983a1c3e\":{\n        \t\"Cases\":[\n           \t    {\n              \t\"status\":{\n                 \t    \"$not_in\":[\n                    \t        \"Closed\",\n                    \t        \"Rejected\",\n                    \t        \"Duplicate\"\n                 \t    ]\n              \t}\n           \t    },\n           \t    {\n              \t\"$owner\":\"\"\n           \t    }\n        \t]\n     \t    },\n     \t    \"da438c86-df5e-11e9-9801-3c15c2c53980\":{\n        \t        \"Accounts\":[\n           \t            {\n              \t    \"$owner\":\"\"\n           \t            }\n        \t        ],\n        \t        \"Opportunities\":[\n           \t            {\n              \t    \"sales_status\":{\n                 \t        \"$not_in\":[\n                    \t            \"Closed Won\",\n                    \t            \"Closed Lost\"\n                 \t        ]\n              \t    }\n           \t            },\n           \t            {\n              \t    \"$owner\":\"\"\n           \t            }\n        \t        ]\n     \t    }\n          }\n   },\n   \"labels\":{\n  \t\"Cases\":[\n     \t    {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html"}
{"id": "95e113bfad08-3", "text": "},\n   \"labels\":{\n  \t\"Cases\":[\n     \t    {\n        \t\"label\":\"LBL_LIST_PRIORITY/LBL_STATUS\",\n        \t\"labelValue\":\"Priority/Status\"\n     \t    },\n     \t    {\n        \t        \"label\":\"LBL_LIST_SUBJECT/LBL_SERVICE_LEVEL\",\n        \t        \"labelValue\":\"Subject/Service Level\"\n     \t    }\n  \t]\n   },\n   \"viewdefs\":{\n      \"Cases\":{\n     \t\"base\":{\n        \t    \"view\":{\n           \t        \"multi-line-list\":{\n              \t\"panels\":[\n                 \t    {\n                    \t        \"label\":\"LBL_LABEL_1\",\n                    \t        \"fields\":[\n                       \t            {\n                          \t    \"name\":\"case_number\",\n                          \t    \"label\":\"LBL_AGENT_WORKBENCH_NUMBER\",\n                          \t    \"subfields\":[\n                             \t        {\n                                \t            \"default\":true,\n                                \t            \"enabled\":true,\n                                      \t\"name\":\"case_number\",\n                                    \t\"label\":\"LBL_AGENT_WORKBENCH_NUMBER\"\n                             \t        }\n                          \t    ]\n                       \t            },\n                       \t            {\n                          \t    \"name\":\"Priority/Status\",\n                          \t    \"label\":\"LBL_LIST_PRIORITY/LBL_STATUS\",\n                          \t    \"subfields\":[\n                             \t        {\n                                \t            \"default\":true,\n                                \t            \"enabled\":true,\n                                \t            \"name\":\"priority\",\n                                \t            \"label\":\"LBL_LIST_PRIORITY\",\n                                \t            \"type\":\"enum\"\n                             \t        },\n                             \t        {\n                                \t            \"default\":true,\n                                \t            \"enabled\":true,\n                                \t            \"name\":\"status\",\n                                \t            \"label\":\"LBL_STATUS\",\n                                \t            \"type\":\"case-status\",\n                                \t            \"widget_name\":\"widget_status\"\n                             \t        }\n                          \t    ]\n                       \t            },\n                       \t            {", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html"}
{"id": "95e113bfad08-4", "text": "}\n                          \t    ]\n                       \t            },\n                       \t            {\n                          \t    \"name\":\"Subject/Service Level\",\n                          \t    \"label\":\"LBL_LIST_SUBJECT/LBL_SERVICE_LEVEL\",\n                          \t    \"subfields\":[\n                             \t        {\n                                \t            \"default\":true,\n                                \t            \"enabled\":true,\n                                \t            \"name\":\"name\",\n                                \t            \"label\":\"LBL_LIST_SUBJECT\",\n                                \t            \"link\":false\n                             \t        },\n                             \t        {\n                                \t            \"default\":true,\n                                \t            \"enabled\":true,\n                                \t            \"name\":\"service_level\",\n                                \t            \"label\":\"LBL_SERVICE_LEVEL\",\n                                \t            \"type\":\"enum\",\n                                \t            \"enum_module\":\"Accounts\",\n                                \t            \"link\":false\n                             \t        }\n                          \t    ]\n                       \t            }\n                    \t    ]\n                       }\n                    ],\n                    \"collectionOptions\":{\n                 \t\"limit\":100,\n                 \t\"params\":{\n                    \t    \"max_num\":100,\n                    \t    \"order_by\":\"follow_up_datetime\",\n                    \t    \"nulls_last\":true\n                 \t}\n                    },\n                    \"filterDef\":[\n                 \t{\n                    \t    \"status\":{\n                       \t        \"$not_in\":[\n                          \t\"Closed\",\n                          \t\"Rejected\",\n                          \t\"Duplicate\"\n                       \t        ]\n                    \t    },\n                    \t    \"$owner\":\"\"\n                 \t}\n                    ]\n           \t      }\n        \t   }\n     \t}\n      }\n   }\n}\nResponse Arguments\nResponse\n{\n   \"is_setup\":1,\n   \"enabled_modules\":{\n  \t\"c108bb4a-775a-11e9-b570-f218983a1c3e\":[\n     \t\"Cases\"\n  \t],", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html"}
{"id": "95e113bfad08-5", "text": "\"Cases\"\n  \t],\n  \t\"da438c86-df5e-11e9-9801-3c15c2c53980\":[\n     \t\"Accounts\",\n     \t\"Opportunities\"\n  \t]\n   },\n   \"order_by_primary\":{\n  \t\"c108bb4a-775a-11e9-b570-f218983a1c3e\":{\n     \t\"Cases\":\"follow_up_datetime:asc\"\n  \t},\n  \t\"da438c86-df5e-11e9-9801-3c15c2c53980\":{\n     \t\"Accounts\":\"next_renewal_date:asc\",\n     \t\"Opportunities\":\"date_closed:asc\"\n  \t}\n   },\n   \"order_by_secondary\":{\n  \t\"c108bb4a-775a-11e9-b570-f218983a1c3e\":{\n     \t\"Cases\":\"\"\n  \t},\n  \t\"da438c86-df5e-11e9-9801-3c15c2c53980\":{\n     \t\"Accounts\":\"\",\n     \t\"Opportunities\":\"\"\n  \t}\n   },\n   \"filter_def\":{\n  \t\"c108bb4a-775a-11e9-b570-f218983a1c3e\":{\n     \t\"Cases\":[\n        \t{\n           \t\"status\":{\n              \t\"$not_in\":[\n                 \t\"Closed\",\n                 \t\"Rejected\",\n                 \t\"Duplicate\"\n              \t]\n           \t}\n        \t},\n        \t{\n           \t\"$owner\":\"\"\n        \t}\n     \t]\n  \t},", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html"}
{"id": "95e113bfad08-6", "text": "\"$owner\":\"\"\n        \t}\n     \t]\n  \t},\n  \t\"da438c86-df5e-11e9-9801-3c15c2c53980\":{\n     \t\"Accounts\":[\n        \t{\n           \t\"$owner\":\"\"\n        \t}\n     \t],\n     \t\"Opportunities\":[\n        \t{\n           \t\"sales_status\":{\n              \t\"$not_in\":[\n                 \t\"Closed Won\",\n                 \t\"Closed Lost\"\n              \t]\n           \t}\n        \t},\n        \t{\n           \t\"$owner\":\"\"\n        \t}\n     \t]\n  \t}\n   },\n   \"defaults\":{\n  \t\"is_setup\":0,\n  \t\"enabled_modules\":{\n     \t\"c108bb4a-775a-11e9-b570-f218983a1c3e\":[\n        \t\"Cases\"\n     \t],\n     \t\"da438c86-df5e-11e9-9801-3c15c2c53980\":[\n        \t\"Accounts\",\n        \t\"Opportunities\"\n     \t]\n  \t},\n  \t\"order_by_primary\":{\n     \t\"c108bb4a-775a-11e9-b570-f218983a1c3e\":{\n        \t\"Cases\":\"follow_up_datetime:asc\"\n     \t},\n     \t\"da438c86-df5e-11e9-9801-3c15c2c53980\":{\n        \t\"Accounts\":\"next_renewal_date:asc\",\n        \t\"Opportunities\":\"date_closed:asc\"\n     \t}\n  \t},\n  \t\"order_by_secondary\":{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html"}
{"id": "95e113bfad08-7", "text": "}\n  \t},\n  \t\"order_by_secondary\":{\n     \t\"c108bb4a-775a-11e9-b570-f218983a1c3e\":{\n        \t\"Cases\":\"\"\n     \t},\n     \t\"da438c86-df5e-11e9-9801-3c15c2c53980\":{\n        \t\"Accounts\":\"\",\n        \t\"Opportunities\":\"\"\n     \t}\n  \t},\n  \t\"filter_def\":{\n     \t\"c108bb4a-775a-11e9-b570-f218983a1c3e\":{\n        \t\"Cases\":[\n           \t{\n              \t\"status\":{\n                 \t\"$not_in\":[\n                    \t\"Closed\",\n                    \t\"Rejected\",\n                    \t\"Duplicate\"\n                 \t]\n              \t}\n           \t},\n           \t{\n              \t\"$owner\":\"\"\n           \t}\n        \t]\n     \t},\n     \t\"da438c86-df5e-11e9-9801-3c15c2c53980\":{\n        \t\"Accounts\":[\n           \t{\n              \t\"$owner\":\"\"\n           \t}\n        \t],\n        \t\"Opportunities\":[\n           \t{\n              \t\"sales_status\":{\n                 \t\"$not_in\":[\n                    \t\"Closed Won\",\n                    \t\"Closed Lost\"\n                 \t]\n              \t}\n           \t},\n           \t{\n              \t\"$owner\":\"\"\n           \t}\n        \t]\n     \t}\n  \t}\n   }\n}\nResponse Codes and Error Messages\nThis API does not return new errors other than the ones that may be returned by its parent API - ConfigModule API. The following error responses are possible:", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html"}
{"id": "95e113bfad08-8", "text": "403 (SugarAPIExceptionNotAuthorized) : Sent if the user attempts to access a module that they are forbidden to access.\nChange Log\nVersion\nChange\nv11.9\nAdded /ConsoleConfiguration/config POST endpoint.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html"}
{"id": "c66f798a2c63-0", "text": "/<module>/:record/link/:link_name/leancount GET\nOverview\n    Lists related filtered records.\nSummary\n    This endpoint will return a set of related records filtered by an expression. The filter can be applied to multiple\n    fields and have multiple and/or conditions in it. Care will need to be taken to make sure this filter has\n    appropriate indexes on the server side otherwise the runtime of the endpoint will be very long. Related fields can\n    be searched by specifying the field name as: \"link_name.remote_field\", so if you wished to search the Accounts\n    module by a related member account you would use \"members.sic_code\".\nRequest Arguments\nName\nType\nDescription\nRequired\n            filter\n        \n            String\n        \n            The filter expression. Filter expressions are explained below.\n        \n            False\n        \n            max_num\n        \n            Integer\n        \n            A maximum number of records to return. Default is 20.\n        \n            False\n        \n            offset\n        \n            Integer\n        \n            The number of records to skip over before records are returned. Default is 0.\n        \n            False\n        \n            fields\n        \n            String\n        \n            Comma delimited list of fields to return. The field date_modified will always be returned. This argument\n            can be combined with the view argument.\n            \n            Example: name,account_type,description\n            False\n        \n            view\n        \n            String\n        \n            Instead of defining the fields argument, the view argument can be used instead. The field list is\n            constructed at the server side based on the view definition which is requested. This argument can be used\n            in combination with the fields argument. Common views are \"record\" and \"list\".\n            \n            Example: record\n            False\n        \n            order_by\n        \n            String", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html"}
{"id": "c66f798a2c63-1", "text": "False\n        \n            order_by\n        \n            String\n        \n            How to sort the returned records, in a comma delimited list with the direction appended to the column name\n            after a colon.\n            \n            Example: name:DESC,account_type:DESC,date_modified:ASC\n            False\n        \nFilter Expressions\nThere are four types of filters:\nBasic\n    This will filter the results by checking the field \"name\" for value \"Nelson Inc\". This will only find exact matches.\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":\"Nelson Inc\"\n      }\n   ]\n}\nFull\n    This expression allows you to specify what operation you want to use for filtering on the field. In the example you\n    would match any record where the field \"name\" starts with the value \"Nelson\".\n    Example\n{\n   \"filter\":[\n      {\n         \"name\":{\n            \"$starts\":\"Nelson\"\n         }\n      }\n   ]\n}\n        Below is a list of operation types:\n    \nOperation\nDescription\n                $equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Performs an exact match on that field.\n            \n                $not_equals\n            \n                Matches on non-matching values.\n            \n                $starts\n            \n                Matches on anything that starts with the value.\n            \n                $ends\n            \n                Matches anything that ends with the value.\n            \n                $contains\n            \n                Matches anything that contains the value\n            \n                $in\n            \n                Finds anything where field matches one of the values as specified as an array.\n            \n                $not_in\n            \n                Finds anything where field does not matches any of the values as specified as an array.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html"}
{"id": "c66f798a2c63-2", "text": "$is_null\n            \n                Checks if the field is null. This operation does not need a value specified.\n            \n                $not_null\n            \n                Checks if the field is not null. This operation does not need a value specified.\n            \n                $lt\n            \n                Matches when the field is less than the value.\n            \n                $lte\n            \n                Matches when the field is less than or equal to the value.\n            \n                $gt\n            \n                Matches when the field is greater than the value.\n            \n                $gte\n            \n                Matches when the field is greater than or equal to the value.\n            \nSub-expressions\n    This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.\n    The example expression would match if the field \"name\" was either \"Nelson Inc\" or \"Nelson LLC\". The only currently\n    accepted sub-expression types are \"$and\" and \"$or\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$or\":[\n            {\n               \"name\":\"Nelson Inc\"\n            },\n            {\n               \"name\":\"Nelson LLC\"\n            }\n         ]\n      }\n   ]\n}\nModules\n    There are two module expressions, they operate on modules instead of fields. The current module can be specified by\n    either using the module name \"_this\" or by leaving the module name as a blank string. The example expression would\n    filter the records in the current module to only your favorites. The only currently accepted module expressions are\n    \"$favorite\" and \"$owner\".\n    Example\n{\n   \"filter\":[\n      {\n         \"$favorite\":\"_this\"\n      }\n   ]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html"}
{"id": "c66f798a2c63-3", "text": "]\n}\nResponse Arguments\nName\nType\nDescription\n            next_offset\n        \n            Integer\n        \n            Displays the next offset for retrieval of additional results. -1 will be returned when there are no more\n            records.\n        \n            records\n        \n            Array\n        \n            An array of results containing matched records.\n        \nRepsonse\n{\n   \"next_offset\":-1,\n   \"records\":[\n      {\n         \"id\":\"fa300a0e-0ad1-b322-9601-512d0983c19a\",\n         \"name\":\"Dale Spivey\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-28T05:03:00+00:00\",\n         \"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html"}
{"id": "c66f798a2c63-4", "text": "\"first_name\":\"Dale\",\n         \"last_name\":\"Spivey\",\n         \"full_name\":\"Dale Spivey\",\n         \"title\":\"VP Operations\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(523) 825-4311\",\n         \"email\":[\n            {\n               \"email_address\":\"sugar.dev.sugar@example.co.jp\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            },\n            {\n               \"email_address\":\"the.support@example.biz\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            }\n         ],\n         \"phone_mobile\":\"(373) 861-0757\",\n         \"phone_work\":\"(212) 542-9596\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"sugar.dev.sugar@example.co.jp\",\n         \"email2\":\"the.support@example.biz\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"345 Sugar Blvd.\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"87261\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html"}
{"id": "c66f798a2c63-5", "text": "\"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Campaign\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"DaleSpivey97\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\\/\",\n         \"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      },\n      {\n         \"id\":\"95e17367-9b3d-0e26-22dc-512d0961fedf\",\n         \"name\":\"Florence Haddock\",\n         \"date_entered\":\"2013-02-26T19:12:00+00:00\",\n         \"date_modified\":\"2013-02-26T19:12:00+00:00\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html"}
{"id": "c66f798a2c63-6", "text": "\"modified_user_id\":\"1\",\n         \"modified_by_name\":\"Administrator\",\n         \"created_by\":\"1\",\n         \"created_by_name\":\"Administrator\",\n         \"description\":\"\",\n         \"img\":\"\",\n         \"deleted\":false,\n         \"assigned_user_id\":\"seed_sally_id\",\n         \"assigned_user_name\":\"Sally Bronsen\",\n         \"team_name\":[\n            {\n               \"id\":\"East\",\n               \"name\":\"East\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":1,\n               \"name\":\"Global\",\n               \"name_2\":\"\",\n               \"primary\":false\n            },\n            {\n               \"id\":\"West\",\n               \"name\":\"West\",\n               \"name_2\":\"\",\n               \"primary\":true\n            }\n         ],\n         \"salutation\":\"\",\n         \"first_name\":\"Florence\",\n         \"last_name\":\"Haddock\",\n         \"full_name\":\"Florence Haddock\",\n         \"title\":\"Director Sales\",\n         \"linkedin\":\"\",\n         \"facebook\":\"\",\n         \"twitter\":\"\",\n         \"googleplus\":\"\",\n         \"department\":\"\",\n         \"do_not_call\":false,\n         \"phone_home\":\"(729) 845-3137\",\n         \"email\":[\n            {\n               \"email_address\":\"dev.vegan@example.de\",\n               \"opt_out\":\"1\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"0\"\n            },\n            {\n               \"email_address\":\"section71@example.it\",\n               \"opt_out\":\"0\",\n               \"invalid_email\":\"0\",\n               \"primary_address\":\"1\"\n            }\n         ],\n         \"phone_mobile\":\"(246) 233-1382\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html"}
{"id": "c66f798a2c63-7", "text": "],\n         \"phone_mobile\":\"(246) 233-1382\",\n         \"phone_work\":\"(565) 696-6981\",\n         \"phone_other\":\"\",\n         \"phone_fax\":\"\",\n         \"email1\":\"section71@example.it\",\n         \"email2\":\"dev.vegan@example.de\",\n         \"invalid_email\":false,\n         \"email_opt_out\":false,\n         \"primary_address_street\":\"111 Silicon Valley Road\",\n         \"primary_address_street_2\":\"\",\n         \"primary_address_street_3\":\"\",\n         \"primary_address_city\":\"Denver\",\n         \"primary_address_state\":\"CA\",\n         \"primary_address_postalcode\":\"79900\",\n         \"primary_address_country\":\"USA\",\n         \"alt_address_street\":\"\",\n         \"alt_address_street_2\":\"\",\n         \"alt_address_street_3\":\"\",\n         \"alt_address_city\":\"\",\n         \"alt_address_state\":\"\",\n         \"alt_address_postalcode\":\"\",\n         \"alt_address_country\":\"\",\n         \"assistant\":\"\",\n         \"assistant_phone\":\"\",\n         \"picture\":\"\",\n         \"email_and_name1\":\"\",\n         \"lead_source\":\"Support Portal User Registration\",\n         \"account_name\":\"Smallville Resources Inc\",\n         \"account_id\":\"d5db6292-5c24-eb61-e202-512d09f0134e\",\n         \"opportunity_role_fields\":\"\",\n         \"opportunity_role_id\":\"\",\n         \"opportunity_role\":\"\",\n         \"reports_to_id\":\"\",\n         \"report_to_name\":\"\",\n         \"portal_name\":\"FlorenceHaddock169\",\n         \"portal_active\":true,\n         \"portal_password\":\"$1$nWFhTbK6$JF9BCGSqL\\/NCrbhueX5ia0\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html"}
{"id": "c66f798a2c63-8", "text": "\"portal_password1\":\"\",\n         \"portal_app\":\"\",\n         \"preferred_language\":\"en_us\",\n         \"campaign_id\":\"\",\n         \"campaign_name\":\"\",\n         \"c_accept_status_fields\":\"\",\n         \"m_accept_status_fields\":\"\",\n         \"accept_status_id\":\"\",\n         \"accept_status_name\":\"\",\n         \"sync_contact\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/:record/link/:link_name/filter GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html"}
{"id": "f42b6fedbb40-0", "text": "/search GET\nOverview\n    List records in a module. Searching, filtering and ordering can be applied to only fetch the records you are interested in. Additionally the set of returned fields can be restricted to speed up processing and reduce download times.\nRequest Arguments\nName\nType\nDescription\nRequired\n                q\n            \n                String\n            \n                The search text to match records on. This will search through any fields on the module that has unified_search set to true.\n            \n                False\n            \n                max_num\n            \n                Integer\n            \n                A maximum number of records to return.\n            \n                False\n            \n                offset\n            \n                Integer\n            \n                The number of records to skip over before records are returned.\n            \n                False\n            \n                fields\n            \n                String\n            \n                Comma delimited list of fields to return. The field date_modified will always be returned.\n                \n                Example: name,account_type,description\n                False\n            \n                order_by\n            \n                String\n            \n                How to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon.\n                \n                Example: name:DESC,account_type:DESC,date_modified:ASC\n                False\n            \n                favorites\n            \n                Boolean\n            \n                Only fetch the current users favorited records.\n            \n                False\n            \n                my_items\n            \n                Boolean\n            \n                Only fetch items assigned to the current user.\n            \n                False\n            \nResponse Arguments\nName\nType\nDescription\n                next_offset\n            \n                Integer\n            \n                Displays the next offset for retrieval of additional results. -1 will be returned when there are no more records.\n            \n                records\n            \n                Array\n            \n                An array of results containing matched records.\n            \nResponse\n{", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/search_GET/index.html"}
{"id": "f42b6fedbb40-1", "text": "An array of results containing matched records.\n            \nResponse\n{\n   \"next_offset\":2,\n   \"records\":[\n      {\n         \"id\":\"ecbf2a6c-261e-5fca-fbb6-512d093554b8\",\n         \"name\":\"Avery Software Co\",\n         \"date_modified\":\"2013-02-26T19:12:56+00:00\",\n         \"description\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Accounts\",\n         \"_search\":{\n            \"score\":1\n         }\n      },\n      {\n         \"id\":\"af5f8dae-7169-b497-1d77-512d0937ed81\",\n         \"name\":\"Avery Software Co\",\n         \"date_modified\":\"2013-02-26T19:12:56+00:00\",\n         \"description\":\"\",\n         \"my_favorite\":false,\n         \"_acl\":{\n            \"fields\":{\n            }\n         },\n         \"_module\":\"Accounts\",\n         \"_search\":{\n            \"score\":1\n         }\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module> GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/search_GET/index.html"}
{"id": "0bf918834711-0", "text": "/Forecasts/user/:user_id GET\nForecastsApi - user\nSummary:\n    This endpoint is used to return a user's id, user_name, full_name, first_name, last_name, and is_manager param given a user's id.\nQuery Parameters:\nParam\nDescription\nOptional\nuser_id\nReturns user data for this specific user id\n\u00c2\u00a0\nInput Example:\n        {\n        user_id:seed_sally_id\n        }\n    \nOutput Example:\n        {\n            first_name: \"Sally\"\n            full_name: \"Sally Bronsen\"\n            id: \"seed_sally_id\"\n            is_manager: false\n            last_name: \"Bronsen\"\n            user_name: \"sally\"\n        }\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsuseruser_id_GET/index.html"}
{"id": "9f4ed768865f-0", "text": "/<module>/append/:target POST\nOverview\n    Append new node to target node as last child.\nRequest Arguments\nName\nType\nDescription\nRequired\n                module\n            \n                String\n            \n                The name of sugar module that contains a nested set data and implements the NestedSetInterface.\n            \n                True\n            \n                target\n            \n                String\n            \n                The ID of record that will be used as target to append new node\n            \n                True\n            \nRequest\n{\n    \"name\" : \"Children Node 1\"\n}\nResponse Arguments\n    This endpoint does not return any response arguments.\nResponse\nThis endpoint returns a newly created bean\n    {\n        \"my_favorite\":false,\n        \"following\":\"\",\n        \"id\":\"59fa8dd7-0f2c-4bfd-364f-54495f77fa3f\",\n        \"name\":\"Default title\",\n        \"date_entered\":\"2014-10-23T23:03:22+03:00\",\n        \"date_modified\":\"2014-10-23T23:03:22+03:00\",\n        \"modified_user_id\":\"1\",\n        \"modified_by_name\":\"Administrator\",\n        \"created_by\":\"1\",\n        \"created_by_name\":\"Administrator\",\n        \"doc_owner\":\"\",\n        \"description\":\"\",\n        \"deleted\":false,\n        \"source_id\":\"\",\n        \"source_type\":\"\",\n        \"source_meta\":\"\",\n        \"root\":\"be9b0c4a-8b78-1ffa-4f14-54481c2f6269\",\n        \"lft\":118,\n        \"rgt\":119,\n        \"level\":1,\n        \"_acl\":{\"fields\":{}},\n        \"_module\":\"Categories\"\n    }\nChange Log", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleappendtarget_POST/index.html"}
{"id": "9f4ed768865f-1", "text": "\"_module\":\"Categories\"\n    }\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<module>/append/:target POST endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleappendtarget_POST/index.html"}
{"id": "d9aa0c9907e6-0", "text": "/theme GET\nOverview\n    Fetches the customizable variables of a theme.\nRequest Arguments\nName\nType\nDescription\nRequired\nplatform\nString\nThe theme platform - /themes/clients/***PLATFORM***/themeName/. Accepted values are 'base' and 'portal'.\nFalse\nthemeName\nString\nThe theme name - /themes/clients/platform/***THEME NAME***/.\nFalse\nRequest\nhttp://{site_url}/rest/v10/theme?platform=base&themeName=default\nNote: GET endpoint parameters are passed in the form of a query string.\nResponse Arguments\nName\nType\nDescription\nmixins\nArray\nAn array of name value pairs detailing mixin colors\nhex\nArray\nA array of name value pairs detailing css colors\nrgba\nArray\nAn array of name value pairs detailing colors\nrel\nArray\nAn array of name value pairs detailing relationships\nbg\nArray\nAn array of name value pairs detailing backgroup colors\nResponse\n{\n   \"colors\":[\n      {\n         \"name\":\"BorderColor\",\n         \"value\":\"#E61718\"\n      },\n      {\n         \"name\":\"NavigationBar\",\n         \"value\":\"#000000\"\n      },\n      {\n         \"name\":\"PrimaryButton\",\n         \"value\":\"#177EE5\"\n      }\n   ]\n}\nChange Log\nVersion\nChange\n            v10\n        \n            Added /<theme> GET endpoint.\n        \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/theme_GET/index.html"}
{"id": "4db84998c376-0", "text": "/Forecasts/:timeperiod_id/progressRep/:user_id GET\nProjected Rep Data\nSummary:\n    This endpoint is used to return the json Data not already in client view for the Forecasts rep projected panel.\nQuery Parameters:\nParam\nDescription\nOptional\nuser_id\nShow for a specific user, defaults to current user if not defined\nOptional\ntimeperiod_id\nShow for a specific time period, defaults to the current time period if one is not passed\nOptional\nInput Example:\n{\n    user_id:seed_sally_id\n    timeperiod_id:36f7085a-5889-ea75-84c8-50f42bd1a5ba\n}\n    \nOutput Example:\n{\n       quota_amount: \"80000.000000\"\n}\n    \n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_idprogressRepuser_id_GET/index.html"}
{"id": "c9230651fe2c-0", "text": "/pmse_Inbox/unattendedCases GET\nOverview\n    Retrieves the processes to show on Unattended Process view \nSummary\n    This endpoint gets the list of unattended processes \nRequest Arguments\nName\nType\nDescription\nRequired\nmodule_list\nstring\nIdentifier used to determine which field to filter against\ntrue\nq\nstring\nFilter applied to a field to determine which processes to return\nfalse\norder_by\nstring\nSort definition to apply to the result\nfalse\nResponse Arguments\nName\nType\nDescription\nnext_offset\ninteger\nNext offset for more results\nrecords\n<field>:<value>\nList of unattended process attributes\nResponse\n{\n    \"next_offset\":\"-1\",\n    \"records\":\n    [\n        {\n            \"id\":\"3922976c-284f-11e6-9f40-6c4008960436\",\n            \"assigned_user_id\":\"1\",\n            \"date_modified\":\"2016-06-01 23:18:59\",\n            \"date_entered\":\"2016-06-01T16:18:59-07:00\",\n            \"name\":\"ABC2\",\n            \"cas_id\":\"2\",\n            \"cas_title\":\"ABC2\",\n            \"cas_status\":\"IN PROGRESS\",\n            \"pro_title\":\"PD1\",\n            \"pro_id\":\"6e172e2c-2842-11e6-a4bb-6c4008960436\",\n            \"cas_init_user\":\"1\",\n            \"cas_user_full_name\":\"Sarah Smith\",\n            \"prj_id\":\"6e025038-2842-11e6-b4f7-6c4008960436\",\n            \"prj_user_id_full_name\":\"Administrator\",", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxunattendedCases_GET/index.html"}
{"id": "c9230651fe2c-1", "text": "\"prj_user_id_full_name\":\"Administrator\",\n            \"cas_sugar_object_id\":\"38beb03a-284f-11e6-b059-6c4008960436\",\n            \"cas_sugar_module\":\"Accounts\",\n            \"assigned_user_name\":\"Administrator\"\n        }\n    ]\n}\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxunattendedCases_GET/index.html"}
{"id": "d06e66b12697-0", "text": "Security\nSecurity documents for securing Sugars\u00c2\u00a0infastructure.\nTopicsEndpoints and Entry PointsThis document describes how to disable out of the box REST API endpoints and legacy MVC entry points.Web Server ConfigurationThis document serves as a guideline to harden the web server configuration with regard to running SugarCRM. Note that this is a guideline and certain settings will depend on your specific environment and setup. This guideline focuses on Apache web server as this is SugarCRM's primary supported web server. However, the recommendations in this document apply to all web servers in general.XSS PreventionThis document describes how to prevent cross-site scripting (XSS) attacks in Sugar customizations. XSS attacks occur when malicious entities are able to inject client-side scripts into web pages.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/index.html"}
{"id": "abad7bffe7ab-0", "text": "Endpoints and Entry Points\nOverview\nThis document describes how to disable out of the box REST API endpoints and legacy MVC entry points.\nAdvisory ID: sugarcrm-sr-2015-001Revision: 1.1Last updated: 2015-10-01\nDescription\nSugarCRM has both legacy entry points and REST API endpoints which are shipped out of the box. Not every customer uses all capabilities of the SugarCRM product. To harden the configuration both entry points can be disabled based on the customer's requirements.\nLegacy Entry Points\nAll stock entry points are defined in include/MVC/Controller/entry_point_registry.php. Using the SugarCRM Extension framework the configuration directives can be overridden in an upgrade safe manner. As an example consider the entrypoint \"removeme\". To disable this entrypoint use the following procedure.\nCreate a new php file ./custom/Extension/application/Ext/EntryPointRegistry/disable_removeme.php and add the following content:\n<?php\nif (isset($entry_point_registry['removeme'])) {\n    unset($entry_point_registry['removeme']);\n}\nExecute a quick repair and rebuild as SugarCRM administrator. The entry point is now fully disabled and no longer accessible to respond to any calls. Note that when trying to hit an non-existing (or disabled) entry point, the application will redirect you to the homepage (or login screen if the user has no session).\nREST API Endpoints\nTo disable the HelpAPI which is located at clients/base/api/HelpApi.php use the following procedure.\nCreate a new php file custom/clients/base/api/CustomHelpApi.php and add the following content:\n<?php\nrequire_once 'clients/base/api/HelpApi.php';\nclass CustomHelpApi extends HelpApi\n{\n    public function getHelp($api, $args)\n    {\n        throw new SugarApiExceptionNotFound();\n    }\n}", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Endpoints_and_Entry_Points/index.html"}
{"id": "abad7bffe7ab-1", "text": "{\n        throw new SugarApiExceptionNotFound();\n    }\n}\nExecute a quick repair and rebuild as SugarCRM administrator. The entry point is now fully disabled. When making a REST API call to /rest/v10/help the followingHTTP 404 Not Found\u00c2\u00a0error will be returned:\n{\n    \"error\": \"not_found\",\n    \"error_message\": \"Your requested resource was not found.\"\n}\nPublication History\n2015-10-01\nAdding REST API endpoint example\n2015-06-16\nInitial publication\nA stand-alone copy of this document that omits the distribution URL is an uncontrolled copy, and may lack important information or contain factual errors. SugarCRM reserves the right to change or update this document at any time.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Endpoints_and_Entry_Points/index.html"}
{"id": "a1af84a30fab-0", "text": "XSS Prevention\nOverview\nThis document describes how to prevent cross-site scripting (XSS) attacks in Sugar customizations. XSS attacks occur when malicious entities are able to\u00c2\u00a0inject client-side scripts into web pages.\nBest Practices\nWhen creating custom code for Sugar, be sure to respect the following\u00c2\u00a0best practices. These rules serve to protect the elements of your customizations that are most susceptible to XSS vulnerabilities:\nCreate safe variables when injecting HTML via Handlebars templates or JavaScript methods such as: $(selector).html(variable), $(selector).before(variable), or $(selector).after(variable).\nAvoid using triple-bracket (e.g.\u00c2\u00a0{{{variable}}}) syntax to allow unescaped HTML content in Handlebars templates.\nNever use input from an unknown source as it may contain unsafe data.\nProtect dynamic content, which may also contain unsafe data.\nPlease refer to the following sections for more information and examples that demonstrate these best practices.\nCreating Safe Variables\nYou must always encode a variable before you inject or display it on a webpage. The piece that is not encoded should be isolated and marked as a safe string very carefully. The the following sections outline protecting\u00c2\u00a0your system when using JavaScript\u00c2\u00a0and Handlebars templates.\nJavaScript\nTo ensure displayed\u00c2\u00a0JavaScript variables are safe, respect these two rules:\nIf you are displaying plain\u00c2\u00a0text without any HTML, use .text() instead of .html()\u00c2\u00a0with your selectors.\nIf your text contains HTML formatting, you can use .html()\u00c2\u00a0as long as it does not contain any dynamic data coming from a variable.\nVulnerable Setup\nThis is an example of bad code because it utilizes the\u00c2\u00a0.html()\u00c2\u00a0method to display a dynamic-value variable, leaving the JavaScript vulnerable to injection:\nvar inputData = $('#myInput').val(); // \"<script>alert(0)</script>\"", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/XSS_Prevention/index.html"}
{"id": "a1af84a30fab-1", "text": "var inputData = $('#myInput').val(); // \"<script>alert(0)</script>\"\n$(selector).html('This is the value: ' + inputData); // \"This is the value: <script>alert(0)</script>\"\nProtected Setup\nThis is\u00c2\u00a0an example of good code, which uses the safe .text() method to protect the JavaScript from potential injection:\nvar status = 'safe';\n$(selector).text('This is very ' + status); // \"This is very safe\"\nThis is also an acceptable approach, which uses the\u00c2\u00a0Handlebars.Utils.escapeExpression to safely escape the content:\nvar inputData = $('#myinput').val(); // \"<script>alert(0)</script>\"\nvar safeData = Handlebars.Utils.escapeExpression(inputData); // \"&lt;script&gt;alert(0)&lt;/script&gt;\"\n$(selector).html('This is the value: ' + safeData); // \"This is the value: &lt;script&gt;alert(0)&lt;/script&gt;\"\nHandlebars Templates\nHandlebars, by default, handles the encoding of data passed to the template in double brackets (e.g. {{variable}}), however, it also allows you to bypass this encoding by using triple brackets (e.g. {{{variable}}}). Text passed via triple brackets will not be encoded. As a rule, do not use triple brackets. If you don't want Handlebars to encode a piece of a string, use double brackets\u00c2\u00a0and execute Handlebars.SafeString() in your JavaScript controller.\u00c2\u00a0\nAs an\u00c2\u00a0example, we will apply best practices to a complex use case with dynamic\u00c2\u00a0values that\u00c2\u00a0need to be encoded. For this example, we\u00c2\u00a0want to display\u00c2\u00a0a message similar to:\nCongrats! You just created the record <a href=\"/#Accounts/abcd\">ABCD</a>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/XSS_Prevention/index.html"}
{"id": "a1af84a30fab-2", "text": "The values ABCD and /#Accounts/abcd are dynamic values and, therefore, must be encoded. But the message must also be displayed as HTML, so the overall element cannot be entirely encoded. To address this use case, we must properly script the JavaScript controller and the Handlebars template.\nThe following JavaScript encodes the message's dynamic values, marks the displayed hyperlink as a safe string, and then outputs the safe message:\nvar record = {\n    id: 'abcd',\n    name: 'ABCD'\n};\n// escape `ABCD`\nvar safeName = Handlebars.Utils.escapeExpression(record.name);\n// escape `abcd`\nvar safeId = Handlebars.Utils.escapeExpression(record.id);\n// Mark the link as a SafeString now that the unsafe pieces are encoded and the content has safe HTML.\nvar link = new Handlebars.SafeString('<a href=\"/#Accounts/' + safeId + '\">' + safeName . '</a>');\n// This can be displayed with double brackets in the template because html parts will not be encoded.\nthis.safeMessage = new Handlebars.SafeString('Congrats! You just created the record ' + link + '.');\nTo display the safe message in the application, use the following syntax in your Handlebars template:\n<div class=\"success\">{{safeMessage}}</div>\nPlease refer to the HTML Escaping documentation on the Handlebars website for more information.\u00c2\u00a0\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/XSS_Prevention/index.html"}
{"id": "588235c25b15-0", "text": "Web Server Configuration\nOverview\nThis document serves as a guideline to harden the web server configuration with regard to running SugarCRM. Note that this is a guideline and certain settings will depend on your specific environment and setup. This guideline focuses on Apache web server as this is SugarCRM's primary supported web server. However, the recommendations in this document apply to all web servers in general.\nAdvisory ID: sugarcrm-sr-2015-003Revision: 1.1Last updated: 2015-10-01\u00c2\u00a0\nSugarCRM .htaccess file\nDuring installation, SugarCRM deploys an .htaccess file in SugarCRM's root folder. The content of this file may change during upgrades as well. The primary configuration directives managed by SugarCRM are focused around disabling direct access to certain directories and files. Secondly, the configuration contains specific URL rewrite rules which are required for SugarCRM.\nAlthough this file can be used to ship most of the settings which are explained in this document to harden the web server, SugarCRM has chosen not to do so as most of them depend on the customer's setup which cannot be fully controlled by the SugarCRM application itself.\nAll directives which are managed by SugarCRM are placed between the following markers inside the .htaccess file:\n# BEGIN SUGARCRM RESTRICTIONS\nRedirectMatch 403 .*\\.log$\n...\n# END SUGARCRM RESTRICTIONS\nCustomers can add additional directives if need. Make sure to put those directives outside of the above-mentioned markers. SugarCRM can rebuild during upgrades all directives enclosed in the above markers.\nSecuring .htaccess\nApache allows admins to drop in .htaccess files in any given directory. When a request comes in, Apache will scan the directory recursively for any .htaccess file and apply its configuration directives. This ability is orchestrated by the AllowOverride directive which is enabled by default on most Apache configurations.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html"}
{"id": "588235c25b15-1", "text": "To disable this dynamic Apache configuration behavior, disable AllowOverride and make sure to copy paste the .htaccess file content as well.\n<Directory \"/var/www/html\">\n    AllowOverride None\n    # BEGIN SUGARCRM RESTRICTIONS\n    RedirectMatch 403 .*\\.log$\n    ...\n    # END SUGARCRM RESTRICTIONS\n</Directory>\nWhen choosing for this security measure, make sure to verify if any changes have happened in the .htaccess after an upgrade. Those changes need to be applied manually back in the Apache configuration to ensure SugarCRM functions properly. Disabling the .htaccess file support also has a positive impact on the performance as Apache will no longer need to scan for the presence of .htaccess files.\nAlthough Apache does not allow to download .htaccess files, to tighten the security around .htaccess, even more, the following directives can be added:\n<Files \".ht*\">\n    Order deny,allow\n    Deny from all\n</Files>\nPrevent version exposure\nBy default Apache web server exposes its version and OS details in most *nix distributions in both the HTTP response headers as well as on the default error pages. To prevent this behavior use the following configuration directives:\nServerSignature Off\nServerTokens Prod\n\u00c2\u00a0The exposure of the PHP version can be disabled in your php.ini file. When exposed an X-Powered-By response header will be added containing the PHP version information.\nexpose_php = Off\nAnother option\u00c2\u00a0is to unset the header explicitly in the Apache configuration:\n<IfModule mod_headers.c>\n    Header unset X-Powered-By \n</IfModule>", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html"}
{"id": "588235c25b15-2", "text": "Header unset X-Powered-By \n</IfModule>\nNote that unsetting the Server header is not possible using this way. The web server will always respond with a Server header containing the string \"Apache\". If it is desired to remove this header as well, additional modules need to be used for this (i.e. mod_security can do this).\nDirectory listing and index page\nMake sure to configure a default index page which should only be index.php for SugarCRM. This is mostly configured but worth checking. Additional SugarCRM does not require the directory browsing support and this is recommended to be disabled. This can be accomplished by removing Options Indexes and/or completely disable the mod_autoindex module.\nOptionally additional Allow/Deny directives can be used to apply access lists to certain directories. It is not recommended to add additional authentication through Apache as SugarCRM already fully manages user authentication. The Allow/Deny directives can still be used to apply any IP access list if required by the customer.\nThe following example secures the root directory (default configuration), disable directory browsing and an additional IP access list is applied.\nDocumentRoot \"/var/www/html\"\n<Directory />\n    AllowOverride none\n    Order allow,deny\n    Deny from all\n</Directory>\n<Directory \"/var/www/html\">\n    DirectoryIndex index.php\n    Options -Indexes\n    Order deny,allow\n    Allow from 10.0.0.0/8\n    Deny from all\n</Directory>\nAdditional Options directives\nSugarCRM does not rely on both CGI and SSI and it is recommended to disable this functionality explicitly. Optionally the FollowSymLinks options can also be disabled depending on your directory setup.\n<Directory \"/var/www/html\">\n    Options -ExecCGI -Includes -FollowSymLinks\n</Directory>\nWeb server permissions", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html"}
{"id": "588235c25b15-3", "text": "</Directory>\nWeb server permissions\nEnsure your web server is configured to run as a dedicated non-privileged user. Certain *nix distributions use out of the box the user/group nobody. It is recommended to use a dedicated user/group instead.\nUser wwwrun\nGroup www\nEnsure the configured user/group have the proper file and directory permissions for SugarCRM. See the installation/upgrade guide for more detailed instructions regarding the required permissions.\nDisable unnecessary loadable modules\nApache is pluggable by means of loadable modules. To minimize the chances of becoming a victim of an attack it is recommended to disable all loadable modules which are not needed. SugarCRM recommends the following base Apache modules:\nmod_authz_host\nmod_dir\nmod_expires\nmod_rewrite\nmod_headers\nmod_mime\nmod_alias\nFrom an Apache perspective to disable a loadable module, it is sufficient to comment out the LoadModule directives. However certain *nix distribution has additional configuration scripts to manage the loaded Apache modules. Please refer to your *nix distribution for this.\nBased on your setup additional Apache modules can be used. When using MPM prefork you will also need mod_php5 and when terminating secure HTTP connection on the web server directly also mod_ssl (see below).\nHTTP methods\nHTTP uses different methods (verbs) in requests. As per RFC-7231 for HTTP/1.1 different request methods are defined which serve the primary source of the request semantics. The following methods are used by SugarCRM:\nFor new REST API:\nGET\nPOST\nPUT\nDELETE\nHEAD (*)\nOPTIONS (*)\nBootstrap, BWC access, old SOAP/REST API:\nGET\nPOST\n(*) Currently not in use, but may be implemented in the future.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html"}
{"id": "588235c25b15-4", "text": "GET\nPOST\n(*) Currently not in use, but may be implemented in the future.\nThe new REST API is accessed using the URL \"/rest/vxx/\u00e2\u0080\u00a6\" where xxx represents the API version number. To harden the usage of the additional HTTP methods the following directives can be used for the new REST API endpoint while only allowing GET and POST on the legacy access.\n<Directory \"/var/www/html\">\n    <LimitExcept GET POST>\n        Order deny,allow\n        Deny from all\n    </LimitExcept>\n</Directory>\n<Location \"/rest\">\n    <LimitExcept GET POST PUT DELETE>\n        Order deny,allow\n        Deny from all\n    </LimitExcept>\n</Location>\n<Location \"/api/rest.php\">\n    <LimitExcept GET POST PUT DELETE>\n        Order deny,allow\n        Deny from all\n    </LimitExcept>\n</Location>\nInstead of using the Limit directive, an alternative is using mod_allowmethods which is available since Apache 2.4. However this module is flagged as experimental.\nSecure HTTP traffic\nSugarCRM requires the usage of HTTPS transport without any exception. Depending on your setup you can terminate the secure connection on a separate endpoint (load balancer, dedicated HTTPS termination point) or directly on the web server(s). You will also need a valid private key and X.509 certificate. In most cases, the customer needs to acquire an X.509 certificate through a public certification authority of their choice. For internal deployments, this may not be necessary when a local PKI environment is available.\nWhen terminating the secure connection directly on the Apache web server, mod_ssl is required. A dedicated VirtualHost needs to be configured on port 443 (standard HTTPS port). The following is a basic SSL/TLS configuration as a reference. More details are covered in the next paragraphs.", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html"}
{"id": "588235c25b15-5", "text": "<VirtualHost 1.2.3.4:443>\n    SSLEngine on\n    SSLCertificateFile /etc/pki/tls/certs/example.com.crt\n    SSLCertificateKeyFile /etc/pki/tls/certs/example.com.key\n    SSLCertificateChainFile /etc/pki/tls/certs/example_bundle.crt\n    ServerName crm.example.com\n</VirtualHost>\nMake sure to have your server name properly configured as it should match the X.509 certificate's CommonName (or one of the SNA's, subject alternative names). More information regarding the certificate requests including the certificate chain can be obtained from your certification authority.\nEnsure to redirect all non-secure HTTP (port 80) traffic to the secure virtual host.\n<VirtualHost *:80>\n    Redirect \"/\" \"https://crm.example.com/\"\n</VirtualHost >\nCipher suite hardening\nOne of the crucial points of HTTPS is to force only secure cryptographic algorithms. Based on new future weaknesses which may be discovered in the future the recommended cipher suite settings can change. As per publish date of this document the usage of SSLv2 and SSLv3 is recommended to be disabled. The current safe secure transport protocols are TLSv1.0, TLSv1.1, and TLSv1.2 with properly configured cipher suites.\nFor proper deployment of Diffie-Hellman (DH) key exchange algorithms the following guidelines apply:\nNo longer use out-dated export cipher suites\nEnsure the usage of Elliptic Curve Diffie-Hellman (ECDHE) based algorithms\nUse of non-common Diffie-Hellman groups\u00c2", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html"}
{"id": "588235c25b15-6", "text": "Use of non-common Diffie-Hellman groups\u00c2\u00a0\nMore detail around the DH configuration and a detailed list of recommended cipher suites including web server configuration examples can be found at https://weakdh.org/sysadmin.html. Additionally, an online SSL/TLS checker can be used to generate a full report of your current configuration in case your web server is publically reachable. A recommended tool is https://www.ssllabs.com/ssltest/analyze.html. The output of this SSL/TLS test suite will guide you into further (optional) details which can be tweaked regarding your configuration (i.e. OCSP stapling, certificate pinning, \u00e2\u0080\u00a6).\nPlease note that using the above instruction \"perfect forward secrecy\" will be enabled. This basically means that captured TLS traffic can only be decoded using the session key between a specific client and server. Nonperfect forwarding secrecy connections can always be decrypted by having access to only the server's private key. If the customer's setup has intermediate IDS/WAF systems to inspect traffic looking inside the secure traffic, having perfect forwarding secrecy configured may not be desirable.\nPublic trusted root CA's\nIt is recommended that the *nix system where Apache is running always has the latest public root CA (certification authority) files available to authenticate server certificates during the SSL/TLS handshake. Most *nix distributions take care of this through their online update process. If this is not the case, the system administrator is responsible to ensure the latest trusted root CA's are up-to-date. Out of the box, the SugarCRM application contacts the SugarCRM heartbeat and licensing server using a secure connection.\nHSTS header", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html"}
{"id": "588235c25b15-7", "text": "HSTS header\nAs all traffic requires HTTPS for SugarCRM, it is recommended to configure a global HSTS (HTTP Strict Transport Security) header. This is an additional opt-in security enhancement supported by most modern browsers. The HSTS will instruct the browser to always use HTTPS in the future for the given FQDN. More details regarding HSTS can be found here: https://www.owasp.org/index.php/HTTP_Strict_Transport_Security.\nBefore enabling the HSTS header, ensure that no other non-HTTPS website is running for the given FQDN and any subdomains.\nHeader always set Strict-Transport-Security \\\n\"max-age=10886400; includeSubdomains; preload\"\nOptionally when your SugarCRM application is publically reachable, you can submit your FQDN on the preload which is maintained by Chrome and included by Firefox, Safari, Internet Explorer 11 and Edge browser. Understand the consequences and requirements to end up on the preload list. Once registered, this cannot be undone easily. Submissions for the HSTS preload list can be found at https://hstspreload.appspot.com.\nCSP header\nA Content Security Policy header can be added to offer additional protection against XSS (cross-site scripting). Most modern browsers support CSP and will apply the limitation as directed by the CSP header. The CSP header defines the allowed sources through different directives which are allowed regarding JScript, CSS, images, fonts, form actions, plugins, \u00e2\u0080\u00a6 More information can be found at https://www.owasp.org/index.php/Content_Security_Policy.\nThe management of CSP headers can become complex and may depend on different types of customizations which can be deployed on the SugarCRM platform.\u00c2\u00a0\nFor now, CSP headers can be configured directly on the web server. A basic configuration looks like this:\u00c2\u00a0\nHeader always set Content-Security-Policy \\", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html"}
{"id": "588235c25b15-8", "text": "Header always set Content-Security-Policy \\\n\"default-src 'self'; script-src 'self'\"\nNote:\u00c2\u00a0This is a syntax example of a CSP header and not a recommended value.\nOlder browsers use the header X-Content-Security-Policy or X-WebKit-CSP instead of the standardized one. The CSP header can also safely be added first in \"report only\" mode before deploying it in production using Content-Security-Policy-Report-Only.\nAdditional security headers\nTo prevent clickjacking an X-Frame-Options header can be added. This header can also be used to iframe the SugarCRM application inside another web site if required. This can be better controlled with the above mentioned CSP header. Both can coexist together but it is encouraged to used the CSP approach.\nHeader always set X-Frame-Options \"SAMEORIGIN\"\nHeader always set X-Frame-Options \"ALLOW-FROM https://someothersite.com\"\nTo protect against \"drive-by download\" attacks, it is encouraged to disable Content-Type sniffing. This is particularly targeted at Chrome and IE.\nHeader always set X-Content-Type-Options \"nosniff\"\nEnsure XSS browser protection is enabled by adding the following header. By default, this feature should be enabled in every browser. In case it has been disabled, sending this header will re-enable it.\nHeader always set X-XSS-Protection \"1; mode=block\"\nSecure cookie settings\nEnsure the following settings are applied in php.ini to ensure legacy cookies are properly protected against XSS attacks and are only transmitted over a secure HTTPS connection.\nsession.cookie_httponly = 1\nsession.cookie_secure = 1\nAdditionally, the session.cookie_path can be tweaked if other applications are running on the same web server.\nSecurity modules", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html"}
{"id": "588235c25b15-9", "text": "Security modules\nAdditional Apache loadable security modules exist which can optionally be installed to better protect your system from malicious requests and/or DDOS attacks. The following modules are available for Apache 2.4:\nmod_security - This module adds WAF (web application firewall) capabilities to your Apache setup. In combination with the OWASP CRS (core rule set) gives you a solid starting point for a WAF implementation.\nmod_evasive - This module helps to prevent (D)DOS attacks\nCovering both modules in details is out of the scope of this Security Response. Refer to the module documentation for additional details. In the future, SugarCRM may publish specific settings and fine-tuning for both modules.\u00c2\u00a0\nAdditional resources\nGeneric Apache security tipshttp://httpd.apache.org/docs/2.4/misc/security_tips.html\nOnline SSL/TLS testerhttps://www.ssllabs.com/ssltest/analyze.html\nUseful HTTP headershttps://www.owasp.org/index.php/List_of_useful_HTTP_headers\nPublication History\n2015-10-01\nAdding HTTP method restrictions\n2015-09-08\nInitial publication\nA stand-alone copy of this document that omits the distribution URL is an uncontrolled copy and may lack important information or contain factual errors. SugarCRM reserves the right to change or update this document at any time.\n  \tLast modified: 2023-02-03 21:04:03", "source": "https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Security/Web_Server_Configuration/index.html"}