id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
5d01164baed3-3
|
"date_closed":"2013-02-27",
"date_closed_timestamp":"1361992480",
"next_step":"",
"sales_stage":"Needs Analysis",
"sales_status":"New",
"probability":"90",
"best_case":"25000",
"worst_case":"25000",
"commit_stage":"include",
"my_favorite":false,
"_acl":{
"fields":{
}
}
},
"related_record":{
"id":"e689173e-c953-1e14-c215-512d0927e7a2",
"name":"Gus Dales",
"date_entered":"2013-02-26T19:12:00+00:00",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_POST/index.html
|
5d01164baed3-4
|
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Gus",
"last_name":"Dales",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_POST/index.html
|
5d01164baed3-5
|
"first_name":"Gus",
"last_name":"Dales",
"full_name":"Gus Dales",
"title":"Director Operations",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(661) 120-2292",
"email":[
{
"email_address":"[email protected]",
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_POST/index.html
|
5d01164baed3-6
|
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(294) 447-9707",
"phone_work":"(036) 840-3216",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"48920 San Carlos Ave",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Persistance",
"primary_address_state":"CA",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_POST/index.html
|
5d01164baed3-7
|
"primary_address_state":"CA",
"primary_address_postalcode":"54556",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Support Portal User Registration",
"account_name":"Arts & Crafts Inc",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_POST/index.html
|
5d01164baed3-8
|
"account_name":"Arts & Crafts Inc",
"account_id":"d43243c6-9b8e-2973-aee2-512d09bc34b4",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"Technical Advisor",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"GusDales145",
"portal_active":true,
"portal_password":"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_POST/index.html
|
5d01164baed3-9
|
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record/link/:link_name/:remote_id POST endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_POST/index.html
|
f894d5e06847-0
|
/<module>/:record/link/:link_name/count GET
Overview
Lists related filtered records.
Summary
This endpoint will return a set of related records filtered by an expression. The filter can be applied to multiple
fields and have multiple and/or conditions in it. Care will need to be taken to make sure this filter has
appropriate indexes on the server side otherwise the runtime of the endpoint will be very long. Related fields can
be searched by specifying the field name as: "link_name.remote_field", so if you wished to search the Accounts
module by a related member account you would use "members.sic_code".
Request Arguments
Name
Type
Description
Required
filter
String
The filter expression. Filter expressions are explained below.
False
max_num
Integer
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
f894d5e06847-1
|
False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
fields
String
Comma delimited list of fields to return. The field date_modified will always be returned. This argument
can be combined with the view argument.
Example: name,account_type,description
False
view
String
Instead of defining the fields argument, the view argument can be used instead. The field list is
constructed at the server side based on the view definition which is requested. This argument can be used
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
f894d5e06847-2
|
in combination with the fields argument. Common views are "record" and "list".
Example: record
False
order_by
String
How to sort the returned records, in a comma delimited list with the direction appended to the column name
after a colon.
Example: name:DESC,account_type:DESC,date_modified:ASC
False
Filter Expressions
There are four types of filters:
Basic
This will filter the results by checking the field "name" for value "Nelson Inc". This will only find exact matches.
Example
{
"filter":[
{
"name":"Nelson Inc"
}
]
}
Full
This expression allows you to specify what operation you want to use for filtering on the field. In the example you
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
f894d5e06847-3
|
would match any record where the field "name" starts with the value "Nelson".
Example
{
"filter":[
{
"name":{
"$starts":"Nelson"
}
}
]
}
Below is a list of operation types:
Operation
Description
$equals
Performs an exact match on that field.
$not_equals
Performs an exact match on that field.
$not_equals
Matches on non-matching values.
$starts
Matches on anything that starts with the value.
$ends
Matches anything that ends with the value.
$contains
Matches anything that contains the value
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
f894d5e06847-4
|
$contains
Matches anything that contains the value
$in
Finds anything where field matches one of the values as specified as an array.
$not_in
Finds anything where field does not matches any of the values as specified as an array.
$is_null
Checks if the field is null. This operation does not need a value specified.
$not_null
Checks if the field is not null. This operation does not need a value specified.
$lt
Matches when the field is less than the value.
$lte
Matches when the field is less than or equal to the value.
$gt
Matches when the field is greater than the value.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
f894d5e06847-5
|
Matches when the field is greater than the value.
$gte
Matches when the field is greater than or equal to the value.
Sub-expressions
This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
accepted sub-expression types are "$and" and "$or".
Example
{
"filter":[
{
"$or":[
{
"name":"Nelson Inc"
},
{
"name":"Nelson LLC"
}
]
}
]
}
Modules
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
f894d5e06847-6
|
}
]
}
]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would
filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
"filter":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
f894d5e06847-7
|
Array
An array of results containing matched records.
Repsonse
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-28T05:03:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
f894d5e06847-8
|
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Dale",
"last_name":"Spivey",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
f894d5e06847-9
|
"last_name":"Spivey",
"full_name":"Dale Spivey",
"title":"VP Operations",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(523) 825-4311",
"email":[
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
f894d5e06847-10
|
"invalid_email":"0",
"primary_address":"0"
}
],
"phone_mobile":"(373) 861-0757",
"phone_work":"(212) 542-9596",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"345 Sugar Blvd.",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
f894d5e06847-11
|
"primary_address_state":"CA",
"primary_address_postalcode":"87261",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Campaign",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
f894d5e06847-12
|
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"DaleSpivey97",
"portal_active":true,
"portal_password":"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\/",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
f894d5e06847-13
|
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
f894d5e06847-14
|
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Florence",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
f894d5e06847-15
|
"salutation":"",
"first_name":"Florence",
"last_name":"Haddock",
"full_name":"Florence Haddock",
"title":"Director Sales",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(729) 845-3137",
"email":[
{
"email_address":"[email protected]",
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
f894d5e06847-16
|
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(246) 233-1382",
"phone_work":"(565) 696-6981",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"111 Silicon Valley Road",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
f894d5e06847-17
|
"primary_address_state":"CA",
"primary_address_postalcode":"79900",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Support Portal User Registration",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
f894d5e06847-18
|
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"FlorenceHaddock169",
"portal_active":true,
"portal_password":"$1$nWFhTbK6$JF9BCGSqL\/NCrbhueX5ia0",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
f894d5e06847-19
|
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/:record/link/:link_name/filter GET endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namecount_GET/index.html
|
9535bcad345e-0
|
/pmse_Inbox/changeCaseUser/:cas_id GET
Overview
Deprecated endpoint.
Summary
This endpoint is deprecated and will be removed in a future release.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxchangeCaseUsercas_id_GET/index.html
|
e7ee454e9c94-0
|
/pmse_Inbox/case/:id/:idflow GET
Overview
Retrieve information of the process record
Summary
This endpoint gets information for a process record
Request Arguments
Name
Type
Description
Required
id
string
The id of the process requiring action
true
idflow
string
The id of the process trigger sequence
true
Response Arguments
Name
Type
Description
case
object
Process record
Response
{
"case":
{
"flow":
{
"id":"b2d418ba-28ef-11e6-8ae6-6c4008960436",
"name":"",
"date_entered":"2016-06-02 18:27:42",
"date_modified":"2016-06-02 18:27:42",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxcaseididflow_GET/index.html
|
e7ee454e9c94-1
|
"date_modified":"2016-06-02 18:27:42",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":"0",
"cas_id":"3",
"cas_index":"3",
"pro_id":"6e172e2c-2842-11e6-a4bb-6c4008960436",
"cas_previous":"2",
"cas_reassign_level":"0",
"bpmn_id":"7c62acc2-2842-11e6-9b9c-6c4008960436",
"bpmn_type":"bpmnActivity",
"cas_assignment_method":"static",
"cas_user_id":"1",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxcaseididflow_GET/index.html
|
e7ee454e9c94-2
|
"cas_user_id":"1",
"cas_thread":"1",
"cas_flow_status":"FORM",
"cas_sugar_module":"Accounts",
"cas_sugar_object_id":"b2103fd0-28ef-11e6-8916-6c4008960436",
"cas_sugar_action":"None",
"cas_adhoc_type":"",
"cas_adhoc_parent_id":"",
"cas_adhoc_actions":"[\u0022link_cancel\u0022,\u0022approve\u0022,\u0022reject\u0022,\u0022edit\u0022]",
"cas_task_start_date":null,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxcaseididflow_GET/index.html
|
e7ee454e9c94-3
|
"cas_task_start_date":null,
"cas_delegate_date":"2016-06-02 18:27:42",
"cas_start_date":null,
"cas_finish_date":null,
"cas_due_date":null,
"cas_queue_duration":"0",
"cas_duration":"0",
"cas_delay_duration":"0",
"cas_started":"0",
"cas_finished":"0",
"cas_delayed":"0",
"assigned_user_id":"1",
"au_first_name":null,
"au_last_name":"Administrator",
"cbu_first_name":null,
"cbu_last_name":"Administrator",
"mbu_first_name":null,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxcaseididflow_GET/index.html
|
e7ee454e9c94-4
|
"mbu_first_name":null,
"mbu_last_name":"Administrator",
"my_favorite":null
},
"reclaim":false,
"buttons":
[
{
"type":"button",
"name":"cancel_button",
"label":"Cancel",
"css_class":"btn-invisible btn-link",
"showOn":"edit",
"events":
{
"click":"button:cancel_button:click"
}
},
{
"type":"rowaction",
"event":"case:approve",
"name":"approve_button",
"label":"Approve",
"css_class":"btn btn-success"
},
{
"type":"rowaction",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxcaseididflow_GET/index.html
|
e7ee454e9c94-5
|
},
{
"type":"rowaction",
"event":"case:reject",
"name":"reject_button",
"label":"Reject",
"css_class":"btn btn-danger"
},
{
"type":"actiondropdown",
"name":"main_dropdown",
"primary":true,
"showOn":"view",
"buttons":
[
{
"type":"rowaction",
"event":"button:edit_button:click",
"name":"edit_button",
"label":"Edit",
"acl_action":"edit"
},
{
"type":"rowaction",
"name":"history",
"label":"History",
"event":"case:history"
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxcaseididflow_GET/index.html
|
e7ee454e9c94-6
|
"event":"case:history"
},
{
"type":"rowaction",
"name":"status",
"label":"Status",
"event":"case:status"
},
{
"type":"rowaction",
"name":"add-notes",
"label":"Show Notes",
"event":"case:add:notes"
}
]
}
],
"readonly":[],
"required":[],
"title":
{
"time":
{
"expected_time_warning":false,
"expected_time_message":false,
"expected_time_view":false,
"expected_time":""
},
"process":"PD1",
"rec_name":"ABC3",
"activity":"Activity # 1"
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxcaseididflow_GET/index.html
|
e7ee454e9c94-7
|
"rec_name":"ABC3",
"activity":"Activity # 1"
},
"inboxId":"b2b6e20e-28ef-11e6-bba8-6c4008960436",
"flowId":"b2d418ba-28ef-11e6-8ae6-6c4008960436"
}
}
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxcaseididflow_GET/index.html
|
01c07b553b8b-0
|
/Administration/config/:category GET
Overview
[ADMIN] Get Configuration Settings for a Category.
Summary
This endpoint gets configuration values for a given category. This endpoint is only available to administrators.
Request
GET /Administration/config/:category
Â
Response Example
{
"a_config": "good"
}
Change Log
Version
Change
v11.13
Added Administration/config/:category GET endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationconfigcategory_GET/index.html
|
8d981a4368b6-0
|
/integrate/<module>/:sync_key_field_name/:sync_key_field_value PUT
Overview
Upserts 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.
Note:Â This 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.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
sync_key_field_name
String
|
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
|
8d981a4368b6-1
|
The module the record belongs to
True
sync_key_field_name
String
The name of the field that contains sync_key_field_value (the default field is named sync_key but can be renamed via code customization)
True
sync_key_field_value
String
A unique ID for the record identifying it in an external system
True
Request
/integrate/<module>/:sync_key_field_name/:sync_key_field_value
Response Arguments
Name
Type
Description
record
String
The ID of the record that was upserted.
Response
Status 201: For a created record
Status 200: For an updated record
{ record: "a0328573-a252-a27c-3530-4e4297d4c9e1"}
Change Log
Version
Change
v11_10
|
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
|
8d981a4368b6-2
|
Change Log
Version
Change
v11_10
Added /integrate/<module>/:sync_key_field_name/:sync_key_field_value PUT endpoint.
Last modified: 2023-02-03 21:04:03
|
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
|
d22b95024802-0
|
/Mail/attachment POST
Overview
Upload an email attachment
Query String Parameters
This endpoint does not accept any query string parameters.
Input Parameters
Name
Type
Description
Required
email_attachment
String
The file to upload.
True
Input Example
{"email_attachment":"@\/path\/to\/ExampleDocument.txt"}
Result
Name
Type
Description
<email record field>
<email record field type>
Returns the fields for the newly created email record.
Output Example
{
"guid": "61b19f41-0ac9-0f2f-d9c5-51eecaf89396",
"name": "ExampleDocument.txt",
"nameForDisplay": "ExampleDocument.txt"
}
Change Log
Version
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailattachment_POST/index.html
|
d22b95024802-1
|
"nameForDisplay": "ExampleDocument.txt"
}
Change Log
Version
Change
v11
Last version in which /Mail/attachment POST is available. Use
/Notes/temp/file/filename POST in conjunction with
/Emails/:record/link/attachments POST instead.
v10
Added /Mail/attachment POST endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailattachment_POST/index.html
|
2e9eeb9ba419-0
|
/pmse_Inbox/reassignFlows/:record GET
Overview
Retrieve information to reassign processes
Summary
This endpoint gets information necessary to reassign a process
Request Arguments
Name
Type
Description
Required
record
string
The id of the process trigger sequence
true
Response Arguments
Name
Type
Description
success
boolean
Result of the routing operation
next_offset
integer
Next offset for more results
records
<field>:<value>
List of process attributes
Response
{
"success":true,
"next_offset":-1,
"records":
[
{
"cas_id":"2",
"cas_index":"3",
"cas_task_start_date":null,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxreassignFlowsrecord_GET/index.html
|
2e9eeb9ba419-1
|
"cas_task_start_date":null,
"cas_delegate_date":"2016-06-01T16:18:59-07:00",
"cas_flow_status":"FORM",
"cas_user_id":"seed_sarah_id",
"cas_due_date":"",
"cas_sugar_module":"Accounts",
"bpmn_id":"7c62acc2-2842-11e6-9b9c-6c4008960436",
"act_name":"Activity # 1",
"act_assignment_method":"static",
"act_expected_time":"eyJ0aW1lIjpudWxsLCJ1bml0IjoiaG91ciJ9",
"cas_expected_time":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxreassignFlowsrecord_GET/index.html
|
2e9eeb9ba419-2
|
"cas_expected_time":"",
"assigned_user":"Sarah Smith"
}
]
}
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxreassignFlowsrecord_GET/index.html
|
f06ae2b741ec-0
|
/pmse_Business_Rules/file/businessrules_import POST
Overview
Imports a Process Business Rules definition from a .pbr file
Summary
This endpoint will import a Process Business Rules definition from the
uploaded .pbr file containing JSON encoded data.
Request Arguments
Name
Type
Description
Required
N/A
Request
Note: A JSON encoded .pbr file attachment should be included with
the request as part of the form-data.
Response Arguments
Name
Type
Description
businessrules_import
Object
Result of the import operation
Response
{
"businessrules_import":
{
"success":true,
"id":"e4396c91-81cd-c097-8149-5733bab68316"
}
}
Last modified: 2023-02-03 21:04:03
|
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
|
6be80e65864d-0
|
/pmse_Inbox/reassignFlows PUT
Overview
Call methods to reassign processes
Summary
This endpoint reassigns a collection of processes
Request Arguments
Name
Type
Description
Required
flow_data
array
Collection of flow data arrays, each containing a user_id property
true
Response Arguments
Name
Type
Description
success
boolean
Result of the reassign operation
Response
{
"success":true,
}
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxreassignFlows_PUT/index.html
|
e810bb607e8f-0
|
/<module>/:record/file/:field POST
Overview
Attaches a file to a field on a record.
Request Arguments
Name
Type
Description
Required
format
String
The data format. Currently accepts 'sugar-html-json'.
True
delete_if_fails
Boolean
Indicates whether the API is to mark related record deleted if the file upload fails.
False
oauth_token
String
The oauth_token value.
False - Required if only if delete_if_fails is true.
<attachment field>
String
The field and file to populate.
Example: {"":"@\/path\/to\/ExampleDocument.txt"}
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfilefield_POST/index.html
|
e810bb607e8f-1
|
Example: {"":"@\/path\/to\/ExampleDocument.txt"}
True
Request
{
"format":"sugar-html-json",
"delete_if_fails":true,
"oauth_token":"43b6b327-cc70-c301-3299-512ffb99ad97",
"<attachment field>":"@\/path\/to\/ExampleDocument.txt"
}
Response Arguments
Name
Type
Description
content-type
String
The files content type.
content-length
Integer
The files content length.
name
String
The files name.
uri
String
The URI of the file.
Response
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfilefield_POST/index.html
|
e810bb607e8f-2
|
String
The URI of the file.
Response
{
"content-type":"text\/plain",
"content-length":16,
"name":"ExampleDocument.txt",
"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"
}
Change Log
Version
Change
v10
Added /<module>/:record/file/:field POST endpoint.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfilefield_POST/index.html
|
e810bb607e8f-3
|
Added /<module>/:record/file/:field POST endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfilefield_POST/index.html
|
3dc3dfe7a634-0
|
/pmse_Project/:record/verify GET
Overview
Verifies whether the Process Definition has any pending processes
Summary
This endpoint will verify whether the Process Definition identified by the
record input parameter has any currently pending processes
based on it.
Request Arguments
Name
Type
Description
Required
record
String
The Process Definition record ID
True
Response Arguments
Name
Type
Description
N/A
Response
Note: The response is a string of either "true" or "false"
indicating whether any pending processes exist.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectrecordverify_GET/index.html
|
085e0172cf49-0
|
/<module>/:record/subscribe POST
Summary:
This 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".
Query Parameters:
This endpoint does not accept any parameters.
Input Example:
This endpoint does not accept any input.
Output Example:
If successful, the endpoint responds with the GUID of the subscription record.
"96ad733c-df51-dd9d-1888-514112ef0595"
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordsubscribe_POST/index.html
|
dcc9fbc55320-0
|
/Reports/:record/records GET
Overview
An API to deliver filtered records from a saved report.
Summary
This endpoint will return a list of records from a saved report filtered by an expression.
Request Arguments
Name
Type
Description
Required
group_filters
String
The group filter expression. Filter expressions are explained below.
Note that JSON-encoded filters can be specified as query parameters
in one of two ways for GET requests:
By specifying individual filter arguments as distinct parameters.
Example: group_filters[0][name]=value.
By specifying the whole filter as a single JSON-encoded string.
Example: group_filters=[{"name":"value"}].
Example: group_filters[0][industry]=Engineering.
False
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Reportsrecordrecords_GET/index.html
|
dcc9fbc55320-1
|
False
use_saved_filters
Boolean
Flag to indicate whether or not to apply saved runtime filters if exists. The default value is false.
Example: use_saved_filters=true.
False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
Request Example
GET /rest/v10/Reports/:id/records?group_filters[0][industry]=Engineering&use_saved_filters=true&offset=0&max_num=20
Response Arguments
Name
Type
Description
records
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Reportsrecordrecords_GET/index.html
|
dcc9fbc55320-2
|
Response Arguments
Name
Type
Description
records
Array
An array of results containing matched records.
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
Response
{
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_modified":"2013-02-28T05:03:00+00:00",
"description":"",
"_acl": {
"fields": {
}
}
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Reportsrecordrecords_GET/index.html
|
dcc9fbc55320-3
|
"fields": {
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock",
"date_modified":"2013-02-26T19:12:00+00:00",
"description":"",
"_acl": {
"fields": {
}
}
}
],
"next_offset": -1
}
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Reportsrecordrecords_GET/index.html
|
a41f3a658d35-0
|
/pmse_Inbox/:record/file/:field GET
Overview
Returns the process status image file
Summary
This endpoint returns the process status image file.
Request Arguments
Name
Type
Description
Required
record
string
The id of the record or image to get
true
field
string
The image type field to get the image from
true
_project
string
If set, will get an image for a project instead of a process
false
Response
There is no Response to this endpoint
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxrecordfilefield_GET/index.html
|
277cb05038ef-0
|
/<module>/:record PUT
Overview
Update a record of the specified type.
Request Arguments
Name
Type
Description
Required
<record field>
<record field type>
The name value list of fields to populate.
True
Request
{
"name":"New Account Name",
"phone_office":"(555) 888-5555",
"website":"www.newsite.com",
"meetings": {
{
"add": ["21e3385e-404f-b470-407e-54044e3d8024"],
"delete": ["21e3385e-404f-b470-407e-54044e3d8023"],
"create": [
{
"name": "Test Meeting"
}
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_PUT/index.html
|
277cb05038ef-1
|
{
"name": "Test Meeting"
}
]
}
}
Link fields
It is possible to add or delete record relations to other records and create new related records.
Action
Type
Description
add
List
List of related records ID. See RelateRecordApi
for details.
delete
List
List of related records ID.
create
List
List of name to value arrays of related records.
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the updated record.
Response
{
"id":"f222265a-b755-da89-0bc7-512d09b800b6",
"name":"New Account Name",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_PUT/index.html
|
277cb05038ef-2
|
"name":"New Account Name",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-27T22:49:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"last_activity_date":"2013-02-26T19:12:00+00:00",
"deleted":false,
"assigned_user_id":"seed_sarah_id",
"assigned_user_name":"Sarah Smith",
"team_name":[
{
"id":1,
"name":"Global",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_PUT/index.html
|
277cb05038ef-3
|
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"account_type":"Customer",
"industry":"Hospitality",
"annual_revenue":"",
"phone_fax":"",
"billing_address_street":"9 IBM Path",
"billing_address_street_2":"",
"billing_address_street_3":"",
"billing_address_street_4":"",
"billing_address_city":"San Francisco",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_PUT/index.html
|
277cb05038ef-4
|
"billing_address_city":"San Francisco",
"billing_address_state":"CA",
"billing_address_postalcode":"43635",
"billing_address_country":"USA",
"rating":"",
"phone_office":"(555) 888-5555",
"phone_alternate":"",
"website":"www.newsite.com",
"ownership":"",
"employees":"",
"ticker_symbol":"",
"shipping_address_street":"9 IBM Path",
"shipping_address_street_2":"",
"shipping_address_street_3":"",
"shipping_address_street_4":"",
"shipping_address_city":"San Francisco",
"shipping_address_state":"CA",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_PUT/index.html
|
277cb05038ef-5
|
"shipping_address_state":"CA",
"shipping_address_postalcode":"43635",
"shipping_address_country":"USA",
"email1":"[email protected]",
"parent_id":"",
"sic_code":"",
"parent_name":"",
"email_opt_out":false,
"invalid_email":false,
"email":[
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
}
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_PUT/index.html
|
277cb05038ef-6
|
"primary_address":"0"
}
],
"campaign_id":"",
"campaign_name":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record PUT endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_PUT/index.html
|
3f998151f7b9-0
|
/<module>/record_list/:record_list_id DELETE
Overview
An API to delete lists of records
Summary
Delete record list. Only DELETE request allowed.
Request Arguments
Name
Type
Description
Required
module
string
Module name
True
record_list_id
guid
record list id
True
Request Example
DELETE /rest/v10/:module/record_list/:id
Response Arguments
Return boolean true.
Last modified: 2023-02-03 21:04:03
|
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
|
185d15c180bb-0
|
/Calls/:record PUT
Overview
Update a calendar event record of the specified type.
Request Arguments
Name
Type
Description
Required
all_recurrences
Boolean
Flag to update all events in a series.
False
Request
http://{site_url}/rest/v10/Meetings/2c9e5c09-6824-0d14-f5cb-5130321ac3cf?all_recurrences=true
{
"name":"Department Meeting",
"description":"Weekly Department Meeting",
"date_start":"yyyy-mm-ddThh:mm:ss-00:00",
"date_end":"yyyy-mm-ddThh:mm:ss-00:00",
"repeat_type":"Weekly",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Callsrecord_PUT/index.html
|
185d15c180bb-1
|
"repeat_type":"Weekly",
"repeat_interval":"1", /* Every Week */
"repeat_dow":"25", /* Tue and Fri */
"repeat_count":"4", /* 4 Recurrences */
"repeat_until":"",
}
Response Arguments
Name
Description
Start Date
End Date
<record field>
Returns the fields for the updated record.
Response
{
}
Change Log
Version
Change
v10
Added /<module>/:record PUT endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Callsrecord_PUT/index.html
|
dcf71b9243f7-0
|
/connectors GET
Overview
Gets general info about connectors.
Request Arguments
This endpoint does not accept any request arguments.
Result Arguments
Response
{
"connectors": {
"ext_rest_twitter": {
"testing_enabled": true,
"test_passed": false,
"eapm_bean": false,
"field_mapping": {
"beans": {
"Accounts": {
"name": "name",
"id": "id"
},
"Contacts": {
"name": "full_name",
"id": "id"
},
"Leads": {
"name": "account_name",
"id": "id"
},
"Prospects": {
"name": "account_name",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectors_GET/index.html
|
dcf71b9243f7-1
|
"Prospects": {
"name": "account_name",
"id": "id"
}
}
},
"id": "ext_rest_twitter",
"name": "Twitter"
},
"ext_eapm_google": {
"testing_enabled": false,
"test_passed": false,
"eapm_bean": false,
"field_mapping": [],
"id": "ext_eapm_google",
"name": "Google"
},
"ext_eapm_gotomeeting": {
"testing_enabled": false,
"test_passed": false,
"eapm_bean": false,
"field_mapping": [],
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectors_GET/index.html
|
dcf71b9243f7-2
|
"field_mapping": [],
"id": "ext_eapm_gotomeeting",
"name": "GoToMeeting"
},
"ext_eapm_ibmsmartcloud": {
"testing_enabled": false,
"test_passed": false,
"eapm_bean": false,
"field_mapping": [],
"id": "ext_eapm_ibmsmartcloud",
"name": "IBM SmartCloud"
},
"ext_eapm_webex": {
"testing_enabled": false,
"test_passed": false,
"eapm_bean": false,
"field_mapping": [],
"id": "ext_eapm_webex",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectors_GET/index.html
|
dcf71b9243f7-3
|
"id": "ext_eapm_webex",
"name": "WebEx"
},
"ext_eapm_lotuslive": {
"testing_enabled": false,
"test_passed": false,
"eapm_bean": false,
"field_mapping": [],
"id": "ext_eapm_lotuslive",
"name": "LotusLive"
},
"ext_rest_dnb": {
"testing_enabled": false,
"test_passed": false,
"eapm_bean": false,
"field_mapping": {
"beans": {
"Accounts": {
"name": "name",
"id": "id"
}
}
},
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectors_GET/index.html
|
dcf71b9243f7-4
|
"id": "id"
}
}
},
"id": "ext_rest_dnb",
"name": "DNB"
},
"_hash": "\u0000d4751e1632fd5d1d2c9069a1f176e6f"
},
"_hash": "2cd9132603ead4f79715c69ee98e64f1"
}
Change Log
Version
Change
v10
Added /<connectors> GET endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectors_GET/index.html
|
1c0ebce0fb2a-0
|
/<module>/recent-product POST
Overview
Opportunity Recent Product Help
Summary
This endpoint retrieves top 10 recently used Quoted/Revenue Line Items based on the module to display them in the
"Product Catalog Quick Picks" dashlet in the reverse chronological order.
Request Arguments
None
Response Arguments
NONE
Response
{
"next_offset":-1,
"records":[
{
"id":"c1b4680e-c7f2-11e8-9380-7831c1c14620",
"name":"Brain Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html
|
1c0ebce0fb2a-1
|
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
"mft_part_num":"Smallville Resources Inc 362299XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"370.000000",
"discount_price":"854.370000",
"list_price":"863.000000",
"cost_usdollar":"370.000000",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html
|
1c0ebce0fb2a-2
|
"cost_usdollar":"370.000000",
"discount_usdollar":"854.370000",
"list_usdollar":"863.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"10.00",
"qty_in_stock":106,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"PercentageDiscount",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"Base_rate":"1.000000"
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html
|
1c0ebce0fb2a-3
|
"Base_rate":"1.000000"
},
{
"id":"c186a612-c7f2-11e8-9fee-7831c1c14620",
"name":"Bradford Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html
|
1c0ebce0fb2a-4
|
"category_id":"c185dbb0-c7f2-11e8-a6b7-7831c1c14620",
"mft_part_num":"Mississippi Bank Group 133834XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"528.000000",
"discount_price":"533.333333",
"list_price":"745.000000",
"cost_usdollar":"528.000000",
"discount_usdollar":"533.333333",
"list_usdollar":"745.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"33.00",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html
|
1c0ebce0fb2a-5
|
"website":null,
"weight":"33.00",
"qty_in_stock":70,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"ProfitMargin",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"Base_rate":"1.000000"
},
{
"id":"c1b60434-c7f2-11e8-8964-7831c1c14620",
"name":"Billie Gadget",
"date_entered":"2018-10-04 16:28:37",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html
|
1c0ebce0fb2a-6
|
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
"mft_part_num":"Kringle Bell IncK.A. Tower \u0026 Co 694143XYZ987",
"vendor_part_num":null,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html
|
1c0ebce0fb2a-7
|
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"403.000000",
"discount_price":"927.000000",
"list_price":"927.000000",
"cost_usdollar":"403.000000",
"discount_usdollar":"927.000000",
"list_usdollar":"927.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"16.00",
"qty_in_stock":148,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html
|
1c0ebce0fb2a-8
|
"support_contact":null,
"support_term":null,
"pricing_formula":"IsList",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"Base_rate":"1.000000"
},
{
"id":"c18e0448-c7f2-11e8-86b0-7831c1c14620",
"name":"Arla Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html
|
1c0ebce0fb2a-9
|
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c18b8b64-c7f2-11e8-8c1a-7831c1c14620",
"mft_part_num":"24\/7 Couriers 795391XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"398.000000",
"discount_price":"402.020202",
"list_price":"941.000000",
"cost_usdollar":"398.000000",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html
|
1c0ebce0fb2a-10
|
"cost_usdollar":"398.000000",
"discount_usdollar":"402.020202",
"list_usdollar":"941.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"22.00",
"qty_in_stock":145,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"ProfitMargin",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"Base_rate":"1.000000"
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html
|
1c0ebce0fb2a-11
|
"Base_rate":"1.000000"
},
{
"id":"c181bd32-c7f2-11e8-b4eb-7831c1c14620",
"name":"Allyson Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html
|
1c0ebce0fb2a-12
|
"category_id":"c18112d8-c7f2-11e8-b753-7831c1c14620",
"mft_part_num":"Ink Conglomerate Inc 921535XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"534.000000",
"discount_price":"842.000000",
"list_price":"905.000000",
"cost_usdollar":"534.000000",
"discount_usdollar":"842.000000",
"list_usdollar":"905.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html
|
1c0ebce0fb2a-13
|
"website":null,
"weight":"20.00",
"qty_in_stock":26,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"Fixed",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
}
]
}
Change Log
Version
Change
v10
Added /Opportunities/recent_product POST endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_POST/index.html
|
b122dd529708-0
|
/pmse_Inbox/delete_notes/:id DELETE
Overview
Deletes a process note
Summary
TBD
Request Arguments
Name
Type
Description
Required
id
string
The note id to delete
true
Response Arguments
Name
Type
Description
id
string
Id of the deleted note
Response
{
"id":"da13553a-298a-11e6-b125-6c4008960436"
}
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxdelete_notesid_DELETE/index.html
|
e8dc0fa6b6e0-0
|
/<module> GET
Overview
Lists filtered records.
Summary
This endpoint will return a set of records filtered by an expression. 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 an AND.
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. Related fields can be searched by specifying the field name as:
"link_name.remote_field", so if you wished to search the Accounts module by a related member account you would
use "members.sic_code".
Request Arguments
Name
Type
Description
Required
filter
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html
|
e8dc0fa6b6e0-1
|
Name
Type
Description
Required
filter
String
The filter expression. Filter expressions are explained below.
Note that JSON-encoded filters can be specified as query parameters
in one of two ways for GET requests:
By specifying individual filter arguments as distinct parameters.
Example: filter[0][id]=1.
By specifying the whole filter as a single JSON-encoded string.
Note that this syntax is currently not supported on certain modules.
Example: filter=[{"id":"1"}].
False
filter_id
String
Identifier for a preexisting filter. If filter is also set, the two
filters are joined with an AND.
False
max_num
Integer
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html
|
e8dc0fa6b6e0-2
|
False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
fields
String
Comma 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 fields id and date_modified will always be returned.
Example: name,account_type,description,{"name":"opportunities","fields":["id","name","sales_status"],"order_by":"date_closed:desc"}
For more details on additional field parameters, see
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html
|
e8dc0fa6b6e0-3
|
For more details on additional field parameters, see
Relate API and
Collection API.
False
view
String
Instead of defining the fields argument, the view argument can be used instead. The field list is
constructed at the server side based on the view definition which is requested. This argument can be used
in combination with the fields argument. Common views are "record" and "list".
Example: record
False
order_by
String
How to sort the returned records, in a comma delimited list with the direction appended to the column name
after a colon.
Example: name:DESC,account_type:DESC,date_modified:ASC
False
q
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html
|
e8dc0fa6b6e0-4
|
False
q
String
A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.
False
deleted
Boolean
Boolean to show deleted records in the result set.
False
nulls_last
Boolean
Boolean to return records with null values in order_by fields last in the result set.
False
Filter Expressions
There are four types of filters:
Basic
This will filter the results by checking the field "name" for value "Nelson Inc". This will only find exact matches.
Example
{
"filter":[
{
"name":"Nelson Inc"
}
]
}
Full
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html
|
e8dc0fa6b6e0-5
|
"name":"Nelson Inc"
}
]
}
Full
This expression allows you to specify what operation you want to use for filtering on the field. In the example you
would match any record where the field "name" starts with the value "Nelson".
Example
{
"filter":[
{
"name":{
"$starts":"Nelson"
}
}
]
}
Below is a list of operation types:
Operation
Description
$equals
Performs an exact match on that field.
$not_equals
Performs an exact match on that field.
$not_equals
Matches on non-matching values.
$starts
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html
|
e8dc0fa6b6e0-6
|
Matches on non-matching values.
$starts
Matches on anything that starts with the value.
$ends
Matches anything that ends with the value.
$contains
Matches anything that contains the value
$in
Finds anything where field matches one of the values as specified as an array.
$not_in
Finds anything where field does not matches any of the values as specified as an array.
$is_null
Checks if the field is null. This operation does not need a value specified.
$not_null
Checks if the field is not null. This operation does not need a value specified.
$lt
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html
|
e8dc0fa6b6e0-7
|
$lt
Matches when the field is less than the value.
$lte
Matches when the field is less than or equal to the value.
$gt
Matches when the field is greater than the value.
$gte
Matches when the field is greater than or equal to the value.
Sub-expressions
This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
accepted sub-expression types are "$and" and "$or".
Example
{
"filter":[
{
"$or":[
{
"name":"Nelson Inc"
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html
|
e8dc0fa6b6e0-8
|
{
"$or":[
{
"name":"Nelson Inc"
},
{
"name":"Nelson LLC"
}
]
}
]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would
filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
"filter":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset
Integer
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html
|
e8dc0fa6b6e0-9
|
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
Response
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_modified":"2013-02-28T05:03:00+00:00",
"description":"",
"opportunities": [
{
_module: "Opportunities",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html
|
e8dc0fa6b6e0-10
|
{
_module: "Opportunities",
"id": "b0701501-1fab-8ae7-3942-540da93f5017",
"name": "360 Vacations - 228 Units",
"date_modified": "2014-09-08T16:05:00+03:00",
"sales_status": "New"
},
],
"_acl": {
"fields": {
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock",
"date_modified":"2013-02-26T19:12:00+00:00",
"description":"",
"opportunities": [
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html
|
e8dc0fa6b6e0-11
|
"description":"",
"opportunities": [
{
_module: "Opportunities"
date_modified: "2014-09-08T16:05:00+03:00"
id: "9ce7c088-8ee4-7cd3-18f1-540da944d4c0"
name: "360 Vacations - 312 Units"
sales_status: "New"
},
],
"_acl": {
"fields": {
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/filter GET endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/module_GET/index.html
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.