id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
7537e8f659ec-15 | "total_attachments": 1,
"parent_name": "Jack Horner",
"parent_type": "Contacts",
"parent_id": "79b9c194-7d79-11e7-8fc5-3c15c2d582c6"
"team_count": "",
"team_name": [{
"id": 1,
"name": "Global",
"name_2": "",
"primary": true,
"selected": false
}],
"my_favorite": false,
"_acl": {
"fields": {}
},
"_module": "Emails"
}
Sending an Email
Request Arguments
Name
Type
Description
Required
state
String | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-16 | Name
Type
Description
Required
state
String
Use "Ready" to send an email.
True
outbound_email_id
String
The ID of the chosen SMTP configuration for sending an email. Only use this field when saving a draft
or sending an email. The user's default SMTP configuration is used if one hasn't been chosen prior to
sending.
False
name
String
The email's subject.
False
description_html
String
The email's HTML body.
False
description
String
The email's plain text body. This field is not necessary unless the text body is different from the HTML
body. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-17 | body.
False
reply_to_id
String
Only use this field when saving a draft or sending an email that is a reply to another email. This is
the ID of that other email.
False
parent_type
String
The parent record's module.
False
parent_id
String
The parent record's ID.
False
to
Object
The email's recipients found in the TO field. Existing EmailParticipants records cannot be used; only
the create and delete actions are supported. Metadata about each recipient is required to
link the records. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-18 | link the records.
parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
or Users, out out of the box. These fields are not necessary if only an email address is known
for the recipient.
email_address_id is the ID of the email address the recipient used in the email. To get
the ID of the email address, first make a request to /EmailAddresses POST. If this
argument is not provided, then the primary email address of the parent record is used.
False
cc
Object
The email's recipients found in the CC field. Existing EmailParticipants records cannot be used; only
the create and delete actions are supported. Metadata about each recipient is required to
link the records. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-19 | link the records.
parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
or Users, out out of the box. These fields are not necessary if only an email address is known
for the recipient.
email_address_id is the ID of the email address the recipient used in the email. To get
the ID of the email address, first make a request to /EmailAddresses POST. If this
argument is not provided, then the primary email address of the parent record is used.
False
bcc
Object
The email's recipients found in the BCC field. Existing EmailParticipants records cannot be used; only
the create and delete actions are supported. Metadata about each recipient is required to
link the records. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-20 | link the records.
parent_type and parent_id can be Accounts, Contacts, Employees, Leads, Prospects,
or Users, out out of the box. These fields are not necessary if only an email address is known
for the recipient.
email_address_id is the ID of the email address the recipient used in the email. To get
the ID of the email address, first make a request to /EmailAddresses POST. If this
argument is not provided, then the primary email address of the parent record is used.
False
attachments
Object
The email's attachments. Existing Notes records cannot be used as email attachments; only the
create and delete actions are supported. Metadata about each attachment is required to
link the records. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-21 | link the records.
filename_guid is the temporary file ID for an uploaded file to attach as a Notes record.
upload_id is the ID of an existing file that the Notes record should reference as the
attachment. This allows files to be shared by multiple Notes records, to preserve space.
When using upload_id, file_source should be provided to indicate from where the
file originated. The value should be the module of the record that shares its ID with the file.
So when an attachment comes from an email template, file_source should be
EmailTemplates. And when an attachment comes from a document, file_source should
be DocumentRevisions.
False
Request
{
"state": "Ready"
}
Response
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-22 | Request
{
"state": "Ready"
}
Response
{
"id": "a7795664-7def-11e7-8add-3c15c2d582c6",
"date_entered": "2016-02-25T08:53:07-08:00",
"created_by": "9c61c46a-a7c5-df71-481c-51d48232f820",
"created_by_name": "Sarah Smith",
"date_modified": "2016-02-25T08:53:07-08:00",
"modified_by_name": "Sarah Smith",
"modified_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-23 | "deleted": false,
"assigned_user_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"assigned_user_name": "Sarah Smith",
"state": "Archived",
"outbound_email_id": "b80adf1a-7d78-11e7-855a-3c15c2d582c6",
"name": "Discuss Proposal",
"description": "When is a good time for us to chat?",
"description_html": "<p>When is a good time for us to chat?</p>",
"date_sent": "2012-02-17T08:53:07-08:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-24 | "message_id": "<[email protected]>",
"message_uid": "",
"reply_to_id": "",
"reply_to_status": false,
"total_attachments": 2,
"parent_name": "Tom Davis",
"parent_type": "Leads",
"parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6"
"team_count": "",
"team_name": [{
"id": 1,
"name": "Global",
"name_2": "",
"primary": true,
"selected": false
}], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_PUT/index.html |
7537e8f659ec-25 | "primary": true,
"selected": false
}],
"my_favorite": false,
"_acl": {
"fields": {}
},
"_module": "Emails"
}
Change Log
Version
Change
v10
Added /Emails/: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/Emailsrecord_PUT/index.html |
c78375a4aa21-0 | /Administration/search/reindex POST
Overview
[ADMIN] Search schedule reindex
Summary
This endpoint schedules a reindex. This endpoint is only available to administrators.
Request Arguments
Name
Type
Description
Required
module_list
String
Comma delimited list of modules to be reindexed. If omitted, all search enabled modules will be reindexed.
Example: Accounts,Contacts
False
clear_data
Boolean
If set the records of the selected modules will be removed from the search backend and the schema will be
recreated. All records from given modules will be queued to be reindexed which is orchestrated by the job
queue.
If not set, nothing is dropped from the search backend and all records of the selected modules are queued | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationsearchreindex_POST/index.html |
c78375a4aa21-1 | for reindexing. This is the default behavior.
Example: Accounts,Contacts
False
Response
{
"success": true
}
Change Log
Version
Change
v10
Added /Administration/search/reindex 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/Administrationsearchreindex_POST/index.html |
f0e7b6d6e750-0 | /<module>/:record/file GET
Overview
Lists all populated fields of type "file" or of type "image" for a record.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
field
Array
The fields containing file properties.
field.content-type
String
The files content type.
field.content-length
Integer
The files content length.
field.name
String
The files ID.
field.width
Integer
The width of the image.
field.height
Integer
The height of the image.
field.uri
String | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfile_GET/index.html |
f0e7b6d6e750-1 | field.uri
String
The URI of the file.
Response
{
"picture":{
"content-type":"image\/png",
"content-length":72512,
"name":"1a7b8f5c-b11c-0094-c8d8-512e9daaa983",
"width":933,
"height":519,
"uri":"http:\/\/sugarcrm\/rest\/v10\/Contacts\/fa300a0e-0ad1-b322-9601-512d0983c19a\/file\/picture"
},
"record": {
"my_favorite": false,
"following": true, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfile_GET/index.html |
f0e7b6d6e750-2 | "my_favorite": false,
"following": true,
"id": "fa300a0e-0ad1-b322-9601-512d0983c19a",
"name": "Test",
"date_modified": "2014-05-16T03:49:12+02:00",
"modified_user_id": "1",
"modified_by_name": "admin",
"created_by": "1",
"created_by_name": "Administrator",
"doc_owner": "1",
"description": "",
"deleted": false,
"assigned_user_id": "1",
"assigned_user_name": "Administrator",
"team_count": "",
"team_name": [
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfile_GET/index.html |
f0e7b6d6e750-3 | "team_count": "",
"team_name": [
{
"id": 1,
"name": "Global",
"name_2": "",
"primary": true
}
],
"email": [],
"email1": "",
"email2": "",
"invalid_email": "",
"email_opt_out": "",
"email_addresses_non_primary": "",
"salutation": "",
"first_name": "",
"last_name": "Test",
"full_name": "Test",
"title": "",
"facebook": "",
"twitter": "",
"googleplus": "",
"department": "",
"do_not_call": false, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfile_GET/index.html |
f0e7b6d6e750-4 | "department": "",
"do_not_call": false,
"phone_home": "",
"phone_mobile": "",
"phone_work": "",
"phone_other": "",
"phone_fax": "",
"primary_address_street": "",
"primary_address_city": "",
"primary_address_state": "",
"primary_address_postalcode": "",
"primary_address_country": "",
"alt_address_street": "",
"alt_address_city": "",
"alt_address_state": "",
"alt_address_postalcode": "",
"alt_address_country": "",
"assistant": "",
"assistant_phone": "", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfile_GET/index.html |
f0e7b6d6e750-5 | "assistant": "",
"assistant_phone": "",
"picture": "",
"email_and_name1": "",
"lead_source": "",
"account_name": "",
"account_id": "",
"dnb_principal_id": "",
"opportunity_role_fields": "",
"opportunity_role_id": "",
"opportunity_role": "",
"reports_to_id": "",
"report_to_name": "",
"birthdate": "",
"portal_name": "",
"portal_active": false,
"portal_password": null,
"portal_password1": null,
"portal_app": "", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfile_GET/index.html |
f0e7b6d6e750-6 | "portal_app": "",
"preferred_language": "en_us",
"campaign_id": "",
"campaign_name": "",
"c_accept_status_fields": "",
"m_accept_status_fields": "",
"accept_status_id": "",
"accept_status_name": "",
"accept_status_calls": "",
"accept_status_meetings": "",
"sync_contact": false,
"mkto_sync": false,
"mkto_id": null,
"mkto_lead_score": null,
"_acl": {
"fields": {}
},
"_module": "Contacts"
}
}
Change Log
Version
Change
v10 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfile_GET/index.html |
f0e7b6d6e750-7 | }
}
Change Log
Version
Change
v10
Added /<module>/:record/file 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/modulerecordfile_GET/index.html |
c22044b729a8-0 | /Meetings POST
Overview
Create a single event or a series of event records.
Request Arguments
Name
Type
Description
Required
<record field>
<record field type>
The name value list of fields to populate.
True
Request
{
"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",
"repeat_interval":"1", /* Every Week */
"repeat_dow":"25", /* Tue and Fri */
"repeat_count":"4", /* 4 Recurrences */ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Meetings_POST/index.html |
c22044b729a8-1 | "repeat_count":"4", /* 4 Recurrences */
"repeat_until":"",
}
Response Arguments
Name
Description
Start Date
End Date
<record field>
Returns the fields for the newly created record.
Response
{
}
Change Log
Version
Change
v10
Added /<module> 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/Meetings_POST/index.html |
d6fab7032863-0 | /pmse_Project/project/:record GET
Overview
Retrieves the schema data to be used by the Process Definition designer
Summary
This endpoint will retrieve the JSON encoded schema data for the Process
Definition identified by the record input parameter.
Request Arguments
Name
Type
Description
Required
record
String
The Process Definition record ID
True
Response Arguments
Name
Type
Description
success
Boolean
The status of the response
project
Object
The schema data for the Process Definition
Response
{
"success":true,
"project":
{
"id":"2119da13-f748-4741-3858-573caddda034",
"name":"PD_AC",
"date_entered":"2016-05-18 17:58:07", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-1 | "date_entered":"2016-05-18 17:58:07",
"date_modified":"2016-05-18 18:41:45",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":"0",
"prj_uid":"2119da13-f748-4741-3858-573caddda034",
"prj_target_namespace":null,
"prj_expression_language":null,
"prj_type_language":null,
"prj_exporter":null,
"prj_exporter_version":null,
"prj_author":null,
"prj_author_version":null,
"prj_original_source":null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-2 | "prj_original_source":null,
"prj_status":"INACTIVE",
"prj_module":"Accounts",
"team_id":"1",
"team_set_id":"1",
"team_set_selected_id":"",
"assigned_user_id":"1",
"au_first_name":null,
"au_last_name":"Administrator",
"cbu_first_name":null,
"cbu_last_name":"Administrator",
"mbu_first_name":null,
"mbu_last_name":"Administrator",
"tn_name":"Global",
"tn_name_2":"",
"my_favorite":null,
"following":"0", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-3 | "my_favorite":null,
"following":"0",
"pro_id":"9f8c4fcd-8d4c-949d-50b8-573caddf8c0c",
"diagram":
[
{
"id":"9ce21d87-f81a-5be2-86e8-573cad955d06",
"name":"PD_AC",
"date_entered":"2016-05-18 17:58:07",
"date_modified":"2016-05-18 17:58:07",
"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/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-4 | "description":null,
"deleted":"0",
"dia_uid":"343198086573cad309cc1d6078585899",
"prj_id":"2119da13-f748-4741-3858-573caddda034",
"dia_is_closable":"0",
"assigned_user_id":"1",
"activities":
[
{
"id":"9ce21d87-f81a-5be2-86e8-573cad955d06",
"name":"PD_AC",
"date_entered":"2016-05-18 17:58:07",
"date_modified":"2016-05-18 17:58:07",
"modified_user_id":"1", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-5 | "modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":"0",
"dia_uid":"343198086573cad309cc1d6078585899",
"prj_id":"2119da13-f748-4741-3858-573caddda034",
"dia_is_closable":"0",
"assigned_user_id":"1",
"activities":
[
{
"id":"566f0156-0ce3-75b4-da56-573cb73984aa",
"name":"Action # 1",
"date_entered":"2016-05-18 18:41:29", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-6 | "date_entered":"2016-05-18 18:41:29",
"date_modified":"2016-05-18 18:41:45",
"created_by":"1",
"description":"",
"deleted":"0",
"act_uid":"552527013573cb7565825f2050463919",
"act_type":"TASK",
"act_is_for_compensation":"0",
"act_start_quantity":"1",
"act_completion_quantity":"0",
"act_task_type":"SCRIPTTASK",
"act_implementation":"",
"act_instantiate":"0",
"act_script_type":"CHANGE_FIELD", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-7 | "act_script_type":"CHANGE_FIELD",
"act_script":"",
"act_loop_type":"NONE",
"act_test_before":"0",
"act_loop_maximum":"0",
"act_loop_condition":"",
"act_loop_cardinality":"0",
"act_loop_behavior":"",
"act_is_adhoc":"0",
"act_is_collapsed":"0",
"act_completion_condition":"",
"act_ordering":"PARALLEL",
"act_cancel_remaining_instances":"1",
"act_protocol":"",
"act_method":"",
"act_is_global":"0", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-8 | "act_is_global":"0",
"act_referer":"",
"act_default_flow":"0",
"act_master_diagram":"",
"bou_x":"245",
"bou_y":"106",
"bou_width":"35",
"bou_height":"35",
"bou_container":"bpmnDiagram",
"act_name":"Action # 1"
}
],
"id":"566f0156-0ce3-75b4-da56-573cb73984aa",
"name":"Action # 1",
"date_entered":"2016-05-18 18:41:29",
"date_modified":"2016-05-18 18:41:45", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-9 | "date_modified":"2016-05-18 18:41:45",
"created_by":"1",
"description":"",
"deleted":"0",
"act_uid":"552527013573cb7565825f2050463919",
"act_type":"TASK",
"act_is_for_compensation":"0",
"act_start_quantity":"1",
"act_completion_quantity":"0",
"act_task_type":"SCRIPTTASK",
"act_implementation":"",
"act_instantiate":"0",
"act_script_type":"CHANGE_FIELD",
"act_script":"",
"act_loop_type":"NONE",
"act_test_before":"0", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-10 | "act_test_before":"0",
"act_loop_maximum":"0",
"act_loop_condition":"",
"act_loop_cardinality":"0",
"act_loop_behavior":"",
"act_is_adhoc":"0",
"act_is_collapsed":"0",
"act_completion_condition":"",
"act_ordering":"PARALLEL",
"act_cancel_remaining_instances":"1",
"act_protocol":"",
"act_method":"",
"act_is_global":"0",
"act_referer":"",
"act_default_flow":"0",
"act_master_diagram":"",
"bou_x":"245",
"bou_y":"106", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-11 | "bou_x":"245",
"bou_y":"106",
"bou_width":"35",
"bou_height":"35",
"bou_container":"bpmnDiagram",
"act_name":"Action # 1"
}
],
"events":
[
{
"id":"80a37c82-8be8-c668-a547-573cb791b905",
"name":"Start Event # 1",
"date_entered":"2016-05-18 18:41:29",
"date_modified":"2016-05-18 18:41:29",
"created_by":"1",
"description":"",
"deleted":"0", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-12 | "description":"",
"deleted":"0",
"evn_uid":"632263607573cb74a582507093735454",
"evn_type":"START",
"evn_marker":"MESSAGE",
"evn_is_interrupting":"1",
"evn_attached_to":"",
"evn_cancel_activity":"0",
"evn_activity_ref":"",
"evn_wait_for_completion":"1",
"evn_error_name":"",
"evn_error_code":"",
"evn_escalation_name":"",
"evn_escalation_code":"",
"evn_condition":"",
"evn_message":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-13 | "evn_condition":"",
"evn_message":"",
"evn_operation_name":"",
"evn_operation_implementation":"",
"evn_time_date":"",
"evn_time_cycle":"",
"evn_time_duration":"",
"evn_behavior":"CATCH",
"bou_x":"132",
"bou_y":"108",
"bou_width":"33",
"bou_height":"33",
"bou_container":"bpmnDiagram",
"evn_name":"Start Event # 1"
},
{
"id":"82894d13-1af8-f039-2cd3-573cb755559e",
"name":"End Event # 1", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-14 | "name":"End Event # 1",
"date_entered":"2016-05-18 18:41:29",
"date_modified":"2016-05-18 18:41:29",
"created_by":"1",
"description":"",
"deleted":"0",
"evn_uid":"282428179573cb7585826d6045140545",
"evn_type":"END",
"evn_marker":"EMPTY",
"evn_is_interrupting":"1",
"evn_attached_to":"",
"evn_cancel_activity":"0",
"evn_activity_ref":"",
"evn_wait_for_completion":"1",
"evn_error_name":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-15 | "evn_error_name":"",
"evn_error_code":"",
"evn_escalation_name":"",
"evn_escalation_code":"",
"evn_condition":"",
"evn_message":"",
"evn_operation_name":"",
"evn_operation_implementation":"",
"evn_time_date":"",
"evn_time_cycle":"",
"evn_time_duration":"",
"evn_behavior":"THROW",
"bou_x":"349",
"bou_y":"107",
"bou_width":"33",
"bou_height":"33",
"bou_container":"bpmnDiagram",
"evn_name":"End Event # 1" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-16 | "evn_name":"End Event # 1"
}
],
"gateways":[],
"artifacts":[],
"flows":
[
{
"id":"974e5216-9d76-5e30-7241-573cb73b7761",
"name":"",
"date_entered":"2016-05-18 18:41:36",
"date_modified":"2016-05-18 18:41:36",
"created_by":"1",
"description":"",
"deleted":"0",
"flo_uid":"287649205573cb75b582a78086279138",
"flo_type":"SEQUENCE",
"flo_element_origin":"632263607573cb74a582507093735454", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-17 | "flo_element_origin_type":"bpmnEvent",
"flo_element_origin_port":"0",
"flo_element_dest":"552527013573cb7565825f2050463919",
"flo_element_dest_type":"bpmnActivity",
"flo_element_dest_port":"0",
"flo_is_inmediate":"",
"flo_condition":"",
"flo_eval_priority":"0",
"flo_x1":"165",
"flo_y1":"125",
"flo_x2":"243",
"flo_y2":"122",
"flo_state":
[
{
"x":165,
"y":125
},
{
"x":204, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-18 | },
{
"x":204,
"y":125
},
{
"x":204,
"y":122
},
{
"x":243,
"y":122
}
],
"prj_id":"2119da13-f748-4741-3858-573caddda034"
},
{
"id":"9fc25911-3e2d-89f1-8d37-573cb73639bd",
"name":"",
"date_entered":"2016-05-18 18:41:36",
"date_modified":"2016-05-18 18:41:36",
"created_by":"1",
"description":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-19 | "created_by":"1",
"description":"",
"deleted":"0",
"flo_uid":"121706749573cb75d582c86016080199",
"flo_type":"SEQUENCE",
"flo_element_origin":"552527013573cb7565825f2050463919",
"flo_element_origin_type":"bpmnActivity",
"flo_element_origin_port":"0",
"flo_element_dest":"282428179573cb7585826d6045140545",
"flo_element_dest_type":"bpmnEvent",
"flo_element_dest_port":"0",
"flo_is_inmediate":"",
"flo_condition":"",
"flo_eval_priority":"0", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-20 | "flo_condition":"",
"flo_eval_priority":"0",
"flo_x1":"282",
"flo_y1":"122",
"flo_x2":"349",
"flo_y2":"124",
"flo_state":
[
{
"x":282,
"y":122
},
{
"x":315,
"y":122
},
{
"x":315,
"y":124
},
{
"x":349,
"y":124
}
],
"prj_id":"2119da13-f748-4741-3858-573caddda034"
}
] | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-21 | }
]
}
],
"process_definition":
{
"id":"9f8c4fcd-8d4c-949d-50b8-573caddf8c0c",
"name":"",
"date_entered":"2016-05-18 17:58:07",
"date_modified":"2016-05-18 17:58:07",
"created_by":"1",
"description":null,
"deleted":"0",
"pro_module":"Accounts",
"pro_status":"INACTIVE",
"pro_locked_variables":[],
"pro_terminate_variables":"",
"execution_mode":"SYNC"
},
"prj_name":"PD_AC", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-22 | },
"prj_name":"PD_AC",
"prj_description":null,
"script_tasks":
{
"add_related_record":
{
"1":
{
"value":"members",
"text":"Accounts (Members: members)",
"module":"Accounts",
"module_label":"Accounts",
"module_name":"Accounts",
"relationship":"member_accounts"
},
"2":
{
"value":"bugs",
"text":"Bugs (Bugs: bugs)",
"module":"Bugs",
"module_label":"Bugs",
"module_name":"Bugs",
"relationship":"accounts_bugs"
},
"3":
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-23 | },
"3":
{
"value":"calls",
"text":"Calls (Calls: calls)",
"module":"Calls",
"module_label":"Calls",
"module_name":"Calls",
"relationship":"account_calls"
},
"4":
{
"value":"cases",
"text":"Cases (Cases: cases)",
"module":"Cases",
"module_label":"Cases",
"module_name":"Cases",
"relationship":"account_cases"
},
"5":
{
"value":"contacts",
"text":"Contacts (Contacts: contacts)",
"module":"Contacts",
"module_label":"Contacts",
"module_name":"Contacts", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-24 | "module_label":"Contacts",
"module_name":"Contacts",
"relationship":"accounts_contacts"
},
"6":
{
"value":"contracts",
"text":"Contracts (Contracts: contracts)",
"module":"Contracts",
"module_label":"Contracts",
"module_name":"Contracts",
"relationship":"account_contracts"
},
"7":
{
"value":"documents",
"text":"Documents (Documents: documents)",
"module":"Documents",
"module_label":"Documents",
"module_name":"Documents",
"relationship":"documents_accounts"
},
"8":
{
"value":"leads", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-25 | },
"8":
{
"value":"leads",
"text":"Leads (Leads: leads)",
"module":"Leads",
"module_label":"Leads",
"module_name":"Leads",
"relationship":"account_leads"
},
"9":
{
"value":"meetings",
"text":"Meetings (Meetings: meetings)",
"module":"Meetings",
"module_label":"Meetings",
"module_name":"Meetings",
"relationship":"account_meetings"
},
"10":
{
"value":"notes",
"text":"Notes (Notes: notes)",
"module":"Notes",
"module_label":"Notes",
"module_name":"Notes", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-26 | "module_label":"Notes",
"module_name":"Notes",
"relationship":"account_notes"
},
"11":
{
"value":"opportunities",
"text":"Opportunities (Opportunity: opportunities)",
"module":"Opportunities",
"module_label":"Opportunities",
"module_name":"Opportunities",
"relationship":"accounts_opportunities"
},
"12":
{
"value":"project",
"text":"Projects (Projects: project)",
"module":"Projects",
"module_label":"Projects",
"module_name":"Project",
"relationship":"projects_accounts"
},
"13":
{
"value":"products", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-27 | },
"13":
{
"value":"products",
"text":"Quoted Line Items (Products: products)",
"module":"Quoted Line Items",
"module_label":"Quoted Line Items",
"module_name":"Products",
"relationship":"products_accounts"
},
"14":
{
"value":"quotes_shipto",
"text":"Quotes (Quotes Ship to: quotes_shipto)",
"module":"Quotes",
"module_label":"Quotes",
"module_name":"Quotes",
"relationship":"quotes_shipto_accounts"
},
"15":
{
"value":"quotes",
"text":"Quotes (Quotes: quotes)",
"module":"Quotes", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
d6fab7032863-28 | "text":"Quotes (Quotes: quotes)",
"module":"Quotes",
"module_label":"Quotes",
"module_name":"Quotes",
"relationship":"quotes_billto_accounts"
},
"16":
{
"value":"tasks",
"text":"Tasks (Tasks: tasks)",
"module":"Tasks",
"module_label":"Tasks",
"module_name":"Tasks",
"relationship":"account_tasks"
}
}
}
}
}
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_Projectprojectrecord_GET/index.html |
db1cb988dbc3-0 | /Mail POST
Overview
Create an email and send or save as draft.
Query String Parameters
This endpoint does not accept any query string parameters.
Input Parameters
Name
Type
Description
Required
email_config
String
ID of the outbound email configuration to use when sending this email
True
to_addresses
Array
Array of name/email address pairs for the TO field, when present, only email subfield is required (not name).
True
cc_addresses
Array
Array of name/email address pairs for the CC field, when present, email subfield is required.
False
bcc_addresses
Array | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mail_POST/index.html |
db1cb988dbc3-1 | False
bcc_addresses
Array
Array of name/email address pairs for the BCC field, when present, email subfield is required.
False
subject
String
Subject of the email
False
html_body
String
HTML body of the email
False
text_body
String
Text body of the email
False
status
String
Indicates the status of the email - 'draft' or 'ready' (ready to be sent)
True
related
Object | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mail_POST/index.html |
db1cb988dbc3-2 | True
related
Object
Contains 'parent_type' and 'parent_id' to relate this email to (for example 'Contact' and a contact's id)
False
teams
Object
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
True
attachments
Array
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)
False
Input Example
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mail_POST/index.html |
db1cb988dbc3-3 | False
Input Example
{
"email_config":"abc181a2-5c05-b879-8e68-502279a8c401",
"to_addresses":[
{
"name":"John Doe",
"email":"[email protected]"
},
{
"name":"David Madison",
"email":"[email protected]"
}
],
"cc_addresses":[
{
"name":"Tom Swift",
"email":"[email protected]"
}
],
"bcc_addresses":null,
"subject":"Minneapolis Convention",
"html_body":"<html><body>Hello World<\/body><\/html>", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mail_POST/index.html |
db1cb988dbc3-4 | "text_body":"Hello World"
"status":"ready",
"related": {
"type":"Contacts",
"id":"61cf0f8d-938c-c9b2-53ad-51ed7bbcf83b"
},
"teams": {
"primary": "dabec868-696c-f458-e204-50227995ab50",
"others": [
"c3094c88-c95f-2e17-4553-50227996ad20",
"abcde868-696c-f458-e704-58369095ab62"
]
},
"attachments": [
{
"type": "upload", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mail_POST/index.html |
db1cb988dbc3-5 | "attachments": [
{
"type": "upload",
"id": "cfbe4551-548d-f602-b228-45387645fc12",
"name": "company_logo.jpg"
},
{
"type": "document",
"id": "876112a4-89c1-4ba7-a05a-7729a7a76818"
},
{
"type": "template",
"id": "002cfe6c-98e9-4342-bdb1-1660d0788872"
}
],
}
Result
Name
Type
Description
<email record field>
<email record field type>
Returns the fields for the newly created email record.
Output Example | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mail_POST/index.html |
db1cb988dbc3-6 | Returns the fields for the newly created email record.
Output Example
{
"team_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"team_set_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"id": "d9c165d0-8863-ba61-dc85-51ed8016c476",
"date_entered": "2013-07-22 18:57:57",
"date_modified": "2013-07-22 18:57:57",
"assigned_user_id": "1",
"assigned_user_name": "",
"modified_user_id": "1", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mail_POST/index.html |
db1cb988dbc3-7 | "modified_user_id": "1",
"modified_by_name": "admin",
"created_by": "1",
"created_by_name": "",
"deleted": 0,
"from_addr_name": "SugarCRM",
"reply_to_addr": "",
"to_addrs_names": "[email protected], [email protected]",
"cc_addrs_names": "[email protected]",
"description_html": "<html><body>Hello World<\/body><\/html>",
"description": "Hello World",
"date_sent": "2013-07-22 18:57:00",
"name": "Minneapolis Convention",
"type": "out", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mail_POST/index.html |
db1cb988dbc3-8 | "name": "Minneapolis Convention",
"type": "out",
"status": "sent",
"parent_type": "Contacts",
"parent_id": "61cf0f8d-938c-c9b2-53ad-51ed7bbcf83b",
}
Change Log
Version
Change
v11
Last version in which /Mail POST is available. Use /Emails POST instead.
v10
Added /Mail 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/Mail_POST/index.html |
d58c97ea7d58-0 | /OutboundEmail/:record PUT
Overview
Update an OutboundEmail configuration.
Summary
Each configuration that is saved is validated first by attempting to connect to the server.
Request Arguments
Name
Type
Description
Required
name
String
The display name of the configuration.
False
mail_sendtype
String
Only SMTP is supported. It is recommended that you do not change this from smtp.
False
mail_smtptype
String
The email provider through which emails are sent. This is merely a convenience which allows for
prepopulating data in the UI. Possible values are: google, exchange, outlook, other.
False
mail_smtpserver
String | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmailrecord_PUT/index.html |
d58c97ea7d58-1 | False
mail_smtpserver
String
The address of the SMTP server.
False
mail_smtpport
Integer
The port on which to connect to the SMTP server.
False
mail_smtpuser
String
The username for authenticating with the SMTP server. It is only required if mail_smtpauth_req is
true.
False
mail_smtppass
String
The password for authenticating with the SMTP server. It is only required if
mail_smtpauth_req is true.
False
mail_smtpauth_req
Boolean | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmailrecord_PUT/index.html |
d58c97ea7d58-2 | mail_smtpauth_req
Boolean
Indicates whether or not the SMTP server requires authentication.
False
mail_smtpssl
String
The encryption protocol used for connecting to the SMTP server. "0" represents no encryption.
"1" represents SSL. "2" represents TLS.
False
Request
{
"mail_smtpport": 587,
"mail_smtpssl": "2"
}
Response Arguments
Name
Type
Description
name
String
The display name of the configuration.
type
String
Possible values are: user, system, system-override. Only the administrator may update the system
configuration. This field may never change. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmailrecord_PUT/index.html |
d58c97ea7d58-3 | configuration. This field may never change.
user_id
String
The current user's ID. The current user may only update configurations that he or she owns.
mail_sendtype
String
Only SMTP is supported, smtp will always be returned.
mail_smtptype
String
The email provider through which emails are sent. Possible values are: google, exchange, outlook, other.
mail_smtpserver
String
The address of the SMTP server.
mail_smtpport
Integer
The port on which to connect to the SMTP server.
mail_smtpuser
String | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmailrecord_PUT/index.html |
d58c97ea7d58-4 | mail_smtpuser
String
The username for authenticating with the SMTP server.
mail_smtppass
Boolean
Indicates whether or not a password exists. true is returned for this field when a password does
exist. This field is not included in the response when a password does not exist.
mail_smtpauth_req
Boolean
Indicates whether or not the SMTP server requires authentication.
mail_smtpssl
String
The encryption protocol used for connecting to the SMTP server.
Response
{
"id": "e04ce998-960e-11e6-8628-3c15c2d582c6",
"name": "My Exchange Account", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmailrecord_PUT/index.html |
d58c97ea7d58-5 | "name": "My Exchange Account",
"type": "user",
"user_id": "e91b1fa7-1bd8-3c71-be96-512e643f9ca4",
"mail_sendtype": "smtp",
"mail_smtptype": "exchange",
"mail_smtpserver": "smtp.example.com",
"mail_smtpport": 587,
"mail_smtpuser": "[email protected]",
"mail_smtppass": true,
"mail_smtpauth_req": true,
"mail_smtpssl": "2",
"deleted": false,
"my_favorite": false,
"_acl": {
"fields": {}
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmailrecord_PUT/index.html |
d58c97ea7d58-6 | "_acl": {
"fields": {}
},
"_module": "OutboundEmail"
}
Change Log
Version
Change
v10
Added /OutboundEmail/: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/OutboundEmailrecord_PUT/index.html |
79a7589cad66-0 | /Meetings/: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/Meetingsrecord_PUT/index.html |
79a7589cad66-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/Meetingsrecord_PUT/index.html |
fff7dd890665-0 | /pmse_Inbox/historyLog/:filter GET
Overview
Gets the history log for a process
Summary
This endpoint gets the history log for a process
Request Arguments
Name
Type
Description
Required
filter
string
The id of the process trigger sequence (cas_id)
true
Response Arguments
Name
Type
Description
success
boolean
Result of the operation
result
<field>:<value>
History records
Response
{
"success":true,
"result":
[
{
"image":"index.php?entryPoint=download\u0026id=0b2dc2f0-2377-11e6-9d2a-6c4008960436\u0026type=SugarFieldImage\u0026isTempFile=1",
"user":"Administrator", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxhistoryLogfilter_GET/index.html |
fff7dd890665-1 | "user":"Administrator",
"current_user":"Administrator",
"due_date":"2016-06-03T16:18:59-07:00",
"end_date":"2016-06-01T16:18:59-07:00",
"current_date":"2016-06-02T10:53:14-07:00",
"delegate_date":"2016-06-01T16:18:59-07:00",
"start_date":"2016-06-01T16:18:59-07:00",
"completed":true,
"cas_user_id":"1",
"data_info":"has created Process #2 on the Account record with the event \u0027Start Event # 1\u0027."
},
]
} | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxhistoryLogfilter_GET/index.html |
fff7dd890665-2 | },
]
}
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_InboxhistoryLogfilter_GET/index.html |
b51e7ba8c874-0 | /pmse_Business_Rules 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/pmse_Business_Rules_GET/index.html |
b51e7ba8c874-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/pmse_Business_Rules_GET/index.html |
b51e7ba8c874-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/pmse_Business_Rules_GET/index.html |
b51e7ba8c874-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/pmse_Business_Rules_GET/index.html |
b51e7ba8c874-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/pmse_Business_Rules_GET/index.html |
b51e7ba8c874-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/pmse_Business_Rules_GET/index.html |
b51e7ba8c874-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/pmse_Business_Rules_GET/index.html |
b51e7ba8c874-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/pmse_Business_Rules_GET/index.html |
b51e7ba8c874-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/pmse_Business_Rules_GET/index.html |
b51e7ba8c874-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/pmse_Business_Rules_GET/index.html |
b51e7ba8c874-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/pmse_Business_Rules_GET/index.html |
b51e7ba8c874-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/pmse_Business_Rules_GET/index.html |
330c3a39828d-0 | /ping/whattimeisit GET
Overview
Responds with the current time in server format.
Request Arguments
This endpoint does not accept any arguments.
Response Arguments
Name
Type
Description
<server time>
String
Returns the servers time.
Response
<time>
Change Log
Version
Change
v10
Added /ping/whattimeisit 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/pingwhattimeisit_GET/index.html |
f5edfecb26e7-0 | /Genericsearch GET
Overview
Generic search.
Summary
This 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".
Request Arguments
Name
Type
Description
Required
q
String
The search expression.
True
module_list
String
Comma-delimited list of modules to search. If omitted, all search enabled modules will be queried. Example: KBDocuments,Bugs
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
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.
total | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Genericsearch_GET/index.html |
f5edfecb26e7-1 | total
Integer
The number of records found.
records
Array
An array of results containing matched records.
Response
{
"next_offset": -1,
"total": 1,
"records": [
{
"name": "Connecting to the Internet",
"description": "To connect your device to the Internet, use any application that accesses the Internet. You can connect using either Wi-Fi or Bluetooth.",
"url": "portal/index.html#KBContents/60142236-bad3-11e9-9d32-3c15c2d57622" (for portal)
"url": "#KBContents/60142236-bad3-11e9-9d32-3c15c2d57622" (for base)
}
]
}
Change Log | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Genericsearch_GET/index.html |
f5edfecb26e7-2 | }
]
}
Change Log
Version
Change
v11_9
Added /Genericsearch 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/Genericsearch_GET/index.html |
d083660e9dd0-0 | /KBContents/:record/link POST
Overview
Creates relationships to a pre-existing record.
Request Arguments
Name
Type
Description
Required
<relationship link>
<string>
Link between targeted and related records.
True
<record ID>
<string>
The name value list of related records. Each item of the list may be either string equal to related item ID,
or map containing record ID ("id" key is required in this case)
and addition relationship properties.
True
Request
{
link_name: "accounts"
ids: [
"da6a3741-2a81-ba7f-f249-512d0932e94e",
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html |
d083660e9dd0-1 | {
"id": "e689173e-c953-1e14-c215-512d0927e7a2",
"role": "owner"
}
]
}
Response Arguments
Name
Type
Description
record
Array
The record linked to related records.
related_records
Array
Records that were associated.
Response
"record": {
"id": "da6a3741-2a81-ba7f-f249-512d0932e94e",
"name": "Slender Broadband Inc - 1000 units",
"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/KBContentsrecordlink_POST/index.html |
d083660e9dd0-2 | "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": "",
"last_activity_date": "2013-02-28T18:21:00+00:00",
"deleted": false,
"assigned_user_id": "seed_max_id",
"assigned_user_name": "Max Jensen",
"team_name": [
{
"id": "East",
"name": "East",
"name_2": "",
"primary": false
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html |
d083660e9dd0-3 | "primary": false
},
{
"id": "West",
"name": "West",
"name_2": "",
"primary": true
}
],
"opportunity_type": "",
"account_name": "Slender Broadband Inc",
"account_id": "181461c6-dc81-1115-1fe0-512d092e8f15",
"campaign_id": "",
"campaign_name": "",
"lead_source": "Campaign",
"amount": "25000",
"base_rate": "1",
"amount_usdollar": "25000",
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html |
d083660e9dd0-4 | "currency_name": "",
"currency_symbol": "",
"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_records": [
{
"id": "e689173e-c953-1e14-c215-512d0927e7a2", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html |
d083660e9dd0-5 | "name": "Gus Dales",
"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": "",
"img": "",
"deleted": false,
"assigned_user_id": "seed_sally_id",
"assigned_user_name": "Sally Bronsen",
"team_name": [
{
"id": "West",
"name": "West", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html |
d083660e9dd0-6 | {
"id": "West",
"name": "West",
"name_2": "",
"primary": true
}
],
"salutation": "",
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html |
d083660e9dd0-7 | "opt_out": "1",
"invalid_email": "0",
"primary_address": "0"
},
{
"email_address": "[email protected]",
"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, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html |
d083660e9dd0-8 | "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",
"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": "", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html |
d083660e9dd0-9 | "alt_address_country": "",
"assistant": "",
"assistant_phone": "",
"picture": "",
"email_and_name1": "",
"lead_source": "Support Portal User Registration",
"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, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html |
d083660e9dd0-10 | "portal_active": true,
"portal_password": "$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0",
"portal_password1": "",
"portal_app": "",
"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": {
}
}
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordlink_POST/index.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.