id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
20ed14a57f35-0
|
/pmse_Project/ActivityDefinition/:record PUT
Overview
Updates the definition data for an activity
Summary
This endpoint will update the Process Definition activity identified by the
record input parameter with the data provided in the request
payload.
Request Arguments
Name
Type
Description
Required
record
String
The value for the act_uid field in the pmse_bpmn_activity record
True
Request Payload
{
"data":
{
"act_field_module":"Accounts",
"act_fields":"[{\"name\":\"Assigned to\",\"field\":\"assigned_user_id\",\"value\":\"owner\",\"type\":\"user\",\"label\":\"Record owner\"}]"
}
}
Response Arguments
Name
Type
Description
success
Boolean
The status of the update operation
Response
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_PUT/index.html
|
20ed14a57f35-1
|
Type
Description
success
Boolean
The status of the update 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_ProjectActivityDefinitionrecord_PUT/index.html
|
c4398b8e4b62-0
|
/Quotes/config POST
Overview
Quote Config POST Help
Summary
This endpoint allows customizations to be made to the Quoted Line Items section of the Quote record.
Request Arguments
Name
Type
Description
Required
worksheet_columns
array
A viewdef "fields"-style definition of the columns you want to display in the QLI section. These get
written out to the custom/Products/clients/base/views/quote-data-group-list/quote-data-group-list.php file.
True
worksheet_column_related_fields
array
Array of the related field names needed for data to be returned for use by the quote-data-group-list
True
summary_columns
array
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-1
|
True
summary_columns
array
A viewdef "fields"-style definition of the columns you want to display in the Quote Summary header section.
These get written out to the
custom/Quotes/clients/base/views/quote-data-grand-totals-header/quote-data-grand-totals-header.php file.
True
summary_columns_related_fields
array
Array of the related field names needed for data to be
returned for use by the quote-data-grand-totals-header
True
footer_rows
array
A viewdef "fields"-style definition of the columns you want to display in the Quote Grand Totals
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-2
|
Footer section. These get written out to the
custom/Quotes/clients/base/views/quote-data-grand-totals-footer/quote-data-grand-totals-footer.php file.
True
footer_rows_related_fields
array
Array of the related field names needed for data to be
returned for use by the quote-data-grand-totals-footer
True
Sample Request
{
"summary_columns": [
{
"name": "deal_tot",
"label": "LBL_LIST_DEAL_TOT",
"css_class": "quote-totals-row-item",
"related_fields": [
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-3
|
"related_fields": [
"deal_tot_discount_percentage"
],
"type": "currency",
"labelModule": "Quotes"
},
{
"name": "new_sub",
"css_class": "quote-totals-row-item",
"type": "currency",
"label": "LBL_NEW_SUB",
"labelModule": "Quotes"
},
{
"name": "tax",
"label": "LBL_TAX_TOTAL",
"css_class": "quote-totals-row-item",
"type": "currency",
"labelModule": "Quotes"
},
{
"name": "shipping",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-4
|
},
{
"name": "shipping",
"css_class": "quote-totals-row-item",
"type": "currency",
"label": "LBL_SHIPPING",
"labelModule": "Quotes"
},
{
"name": "total",
"label": "LBL_LIST_GRAND_TOTAL",
"css_class": "quote-totals-row-item",
"type": "currency",
"labelModule": "Quotes"
}
],
"summary_columns_related_fields": [
"base_rate",
"deal_tot",
"deal_tot_usdollar",
"shipping",
"subtotal",
"subtotal_usdollar",
"tax",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-5
|
"subtotal",
"subtotal_usdollar",
"tax",
"taxable_subtotal"
],
"worksheet_columns": [
{
"name": "line_num",
"label": null,
"widthClass": "cell-xsmall",
"css_class": "line_num tcenter",
"type": "line-num",
"readonly": true
},
{
"name": "quantity",
"label": "LBL_QUANTITY",
"widthClass": "cell-small",
"css_class": "quantity",
"type": "float",
"labelModule": "Products"
},
{
"name": "product_template_name",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-6
|
},
{
"name": "product_template_name",
"label": "LBL_ITEM_NAME",
"widthClass": "cell-large",
"type": "quote-data-relate",
"required": true,
"labelModule": "Quotes"
},
{
"name": "mft_part_num",
"label": "LBL_MFT_PART_NUM",
"type": "base",
"labelModule": "Products"
},
{
"name": "discount_price",
"label": "LBL_DISCOUNT_PRICE",
"type": "currency",
"convertToBase": true,
"showTransactionalAmount": true,
"related_fields": [
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-7
|
"showTransactionalAmount": true,
"related_fields": [
"discount_price",
"currency_id",
"base_rate"
],
"labelModule": "Products"
},
{
"name": "discount",
"type": "fieldset",
"css_class": "quote-discount-percent",
"label": "LBL_DISCOUNT_AMOUNT",
"fields": [
{
"name": "discount_amount",
"label": "LBL_DISCOUNT_AMOUNT",
"type": "discount",
"convertToBase": true,
"showTransactionalAmount": true
},
{
"type": "discount-select",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-8
|
},
{
"type": "discount-select",
"name": "discount_select",
"no_default_action": true,
"buttons": [
{
"type": "rowaction",
"name": "select_discount_amount_button",
"label": "LBL_DISCOUNT_AMOUNT",
"event": "button:discount_select_change:click"
},
{
"type": "rowaction",
"name": "select_discount_percent_button",
"label": "LBL_DISCOUNT_PERCENT",
"event": "button:discount_select_change:click"
}
],
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-9
|
}
],
"label": "LBL_DISCOUNT_AS_PERCENT"
}
],
"labelModule": "Products"
},
{
"name": "total_amount",
"label": "LBL_LINE_ITEM_TOTAL",
"type": "currency",
"widthClass": "cell-medium",
"showTransactionalAmount": true,
"related_fields": [
"total_amount",
"currency_id",
"base_rate"
],
"labelModule": "Quotes"
}
],
"worksheet_columns_related_fields": [
"base_rate",
"deal_calc",
"discount_amount",
"discount_price",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-10
|
"discount_amount",
"discount_price",
"discount_select",
"quantity",
"subtotal",
"tax_class",
"total_amount",
"description",
"quote_id",
"name",
"product_template_id",
"product_template_name"
],
"footer_rows": [
{
"name": "new_sub",
"type": "currency"
},
{
"name": "tax",
"type": "currency"
},
{
"name": "shipping",
"type": "quote-footer-currency",
"css_class": "quote-footer-currency",
"default": "0.00"
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-11
|
"default": "0.00"
},
{
"name": "total",
"type": "currency",
"css_class": "grand-total"
}
],
"footer_rows_related_fields": [
"deal_tot",
"deal_tot_usdollar",
"shipping",
"subtotal",
"subtotal_usdollar",
"tax",
"taxable_subtotal"
]
}
Response Arguments
NONE
Response
Saved Config or SugarApiExceptionInvalidParameter
{
"summary_columns": [
{
"name": "deal_tot",
"label": "LBL_LIST_DEAL_TOT",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-12
|
"label": "LBL_LIST_DEAL_TOT",
"css_class": "quote-totals-row-item",
"related_fields": [
"deal_tot_discount_percentage"
],
"type": "currency",
"labelModule": "Quotes"
},
{
"name": "new_sub",
"css_class": "quote-totals-row-item",
"type": "currency",
"label": "LBL_NEW_SUB",
"labelModule": "Quotes"
},
{
"name": "tax",
"label": "LBL_TAX_TOTAL",
"css_class": "quote-totals-row-item",
"type": "currency",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-13
|
"type": "currency",
"labelModule": "Quotes"
},
{
"name": "shipping",
"css_class": "quote-totals-row-item",
"type": "currency",
"label": "LBL_SHIPPING",
"labelModule": "Quotes"
},
{
"name": "total",
"label": "LBL_LIST_GRAND_TOTAL",
"css_class": "quote-totals-row-item",
"type": "currency",
"labelModule": "Quotes"
}
],
"worksheet_columns": [
{
"name": "line_num",
"label": null,
"widthClass": "cell-xsmall",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-14
|
"label": null,
"widthClass": "cell-xsmall",
"css_class": "line_num tcenter",
"type": "line-num",
"readonly": true
},
{
"name": "quantity",
"label": "LBL_QUANTITY",
"widthClass": "cell-small",
"css_class": "quantity",
"type": "float",
"labelModule": "Products"
},
{
"name": "product_template_name",
"label": "LBL_ITEM_NAME",
"widthClass": "cell-large",
"type": "quote-data-relate",
"required": true,
"labelModule": "Quotes"
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-15
|
"labelModule": "Quotes"
},
{
"name": "mft_part_num",
"label": "LBL_MFT_PART_NUM",
"type": "base",
"labelModule": "Products"
},
{
"name": "discount_price",
"label": "LBL_DISCOUNT_PRICE",
"type": "currency",
"convertToBase": true,
"showTransactionalAmount": true,
"related_fields": [
"discount_price",
"currency_id",
"base_rate"
],
"labelModule": "Products"
},
{
"name": "discount",
"type": "fieldset",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-16
|
"name": "discount",
"type": "fieldset",
"css_class": "quote-discount-percent",
"label": "LBL_DISCOUNT_AMOUNT",
"fields": [
{
"name": "discount_amount",
"label": "LBL_DISCOUNT_AMOUNT",
"type": "discount",
"convertToBase": true,
"showTransactionalAmount": true
},
{
"type": "discount-select",
"name": "discount_select",
"no_default_action": true,
"buttons": [
{
"type": "rowaction",
"name": "select_discount_amount_button",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-17
|
"name": "select_discount_amount_button",
"label": "LBL_DISCOUNT_AMOUNT",
"event": "button:discount_select_change:click"
},
{
"type": "rowaction",
"name": "select_discount_percent_button",
"label": "LBL_DISCOUNT_PERCENT",
"event": "button:discount_select_change:click"
}
],
"label": "LBL_DISCOUNT_AS_PERCENT"
}
],
"labelModule": "Products"
},
{
"name": "total_amount",
"label": "LBL_LINE_ITEM_TOTAL",
"type": "currency",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-18
|
"type": "currency",
"widthClass": "cell-medium",
"showTransactionalAmount": true,
"related_fields": [
"total_amount",
"currency_id",
"base_rate"
],
"labelModule": "Quotes"
}
],
"footer_rows": [
{
"name": "new_sub",
"type": "currency"
},
{
"name": "tax",
"type": "currency"
},
{
"name": "shipping",
"type": "quote-footer-currency",
"css_class": "quote-footer-currency",
"default": "0.00"
},
{
"name": "total",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-19
|
},
{
"name": "total",
"type": "currency",
"css_class": "grand-total"
}
],
"summary_columns_related_fields": [
"base_rate",
"deal_tot",
"deal_tot_usdollar",
"shipping",
"subtotal",
"subtotal_usdollar",
"tax",
"taxable_subtotal"
],
"worksheet_columns_related_fields": [
"base_rate",
"deal_calc",
"discount_amount",
"discount_price",
"discount_select",
"quantity",
"subtotal",
"tax_class",
"total_amount",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesconfig_POST/index.html
|
c4398b8e4b62-20
|
"subtotal",
"tax_class",
"total_amount",
"description",
"quote_id",
"name",
"product_template_id",
"product_template_name"
],
"footer_rows_related_fields": [
"deal_tot",
"deal_tot_usdollar",
"shipping",
"subtotal",
"subtotal_usdollar",
"tax",
"taxable_subtotal"
]
}
Change Log
Version
Change
v11.3
Added /Quotes/config 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/Quotesconfig_POST/index.html
|
d630fbce0df5-0
|
/Emails/:record/link/:link_name/:remote_id DELETE
Overview
Deletes an existing relationship between an email and another record.
Summary
The sender (link: from) cannot be removed. Replace the sender with a different sender instead. All other
operations described in Relate Record API are
supported.
Change Log
Version
Change
v10
Added /Emails/:record/link/:link_name/:remote_id DELETE 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/Emailsrecordlinklink_nameremote_id_DELETE/index.html
|
9a4e8d310be9-0
|
/bulk POST
Overview
Run API calls in bulk.
Summary
This request will run a sequence of API requests within one query. The requests are executed sequentially and their results
are returned as one response. Some requests may return failure code, that does not interrupt the execution of the batch,
and the overall request will still be considered successful.
Request Arguments
Name
Type
Description
Required
requests
Array
The list of requests
True
Each of the requests can have the following fields:
Name
Type
Description
Required
url
String
The request URL, starting with version.
True
data
JSON String
The data for the POST/PUT body. Must be a JSON-encoded string.
False
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/bulk_POST/index.html
|
9a4e8d310be9-1
|
False
headers
Array
The request headers
False
method
String
The HTTP method (default is GET)
False
Request Example
{"requests":
[
{
"url": "/v10/Accounts", "method": "POST", "data": "{\"name\": \"test123\"}"
},
{
"url": "/v10/Accounts", "method": "GET"
}
]
}
Response
The response will contain an array of response objects, each of them will correspond to the individual request. The following fields are in the response objects:
Name
Type
Description
contents
Array or String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/bulk_POST/index.html
|
9a4e8d310be9-2
|
Name
Type
Description
contents
Array or String
The response contents, can be JSON object or string depending on what the individual request is supposed to return.
headers
Array
The response headers
status
Integer
HTTP status code of the response. Will be 2XX for successful requests and 4XX or 5XX for errors.
Response Example
[
{
"contents": {
"my_favorite": false,
"following": true,
"id": "7d2e21a6-8a76-a74f-bb53-535620211304",
"name": "test123",
"date_entered": "2014-04-22T03:56:24-04:00",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/bulk_POST/index.html
|
9a4e8d310be9-3
|
"_module": "Accounts"
},
"headers": [],
"status": 200
},
{
"contents": {
"next_offset": -1,
"records": [
{
"my_favorite": false,
"following": true,
"id": "7d2e21a6-8a76-a74f-bb53-535620211304",
"name": "test123",
"date_entered": "2014-04-22T03:56:24-04:00",
"date_modified": "2014-04-22T03:56:24-04:00",
}
]
},
"headers": [],
"status": null
}
]
Change Log
Version
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/bulk_POST/index.html
|
9a4e8d310be9-4
|
"status": null
}
]
Change Log
Version
Change
v10
Added /bulk 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/bulk_POST/index.html
|
9e029a20cacb-0
|
/ConsoleConfiguration/config POST
Overview
Saves configuration changes in the database.
Request Arguments
This endpoint does not accept any request arguments.
URL Example
/rest/v11_9/ConsoleConfiguration/config
Request Payload Example
{
"is_setup":true,
"enabled_modules":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":[
"Cases"
],
"da438c86-df5e-11e9-9801-3c15c2c53980":[
"Accounts",
"Opportunities"
]
},
"order_by_primary":{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-1
|
]
},
"order_by_primary":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":"follow_up_datetime:asc"
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":"next_renewal_date:asc",
"Opportunities":"date_closed:asc"
}
},
"order_by_secondary":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":""
},
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-2
|
"Cases":""
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":"",
"Opportunities":""
}
},
"filter_def":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":[
{
"status":{
"$not_in":[
"Closed",
"Rejected",
"Duplicate"
]
}
},
{
"$owner":""
}
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-3
|
{
"$owner":""
}
]
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":[
{
"$owner":""
}
],
"Opportunities":[
{
"sales_status":{
"$not_in":[
"Closed Won",
"Closed Lost"
]
}
},
{
"$owner":""
}
]
}
},
"defaults":{
"is_setup":0,
"enabled_modules":{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-4
|
"is_setup":0,
"enabled_modules":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":[
"Cases"
],
"da438c86-df5e-11e9-9801-3c15c2c53980":[
"Accounts",
"Opportunities"
]
},
"order_by_primary":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":"follow_up_datetime:asc"
},
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-5
|
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":"next_renewal_date:asc",
"Opportunities":"date_closed:asc"
}
},
"order_by_secondary":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":""
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":"",
"Opportunities":""
}
},
"filter_def":{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-6
|
}
},
"filter_def":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":[
{
"status":{
"$not_in":[
"Closed",
"Rejected",
"Duplicate"
]
}
},
{
"$owner":""
}
]
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":[
{
"$owner":""
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-7
|
{
"$owner":""
}
],
"Opportunities":[
{
"sales_status":{
"$not_in":[
"Closed Won",
"Closed Lost"
]
}
},
{
"$owner":""
}
]
}
}
},
"labels":{
"Cases":[
{
"label":"LBL_LIST_PRIORITY/LBL_STATUS",
"labelValue":"Priority/Status"
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-8
|
},
{
"label":"LBL_LIST_SUBJECT/LBL_SERVICE_LEVEL",
"labelValue":"Subject/Service Level"
}
]
},
"viewdefs":{
"Cases":{
"base":{
"view":{
"multi-line-list":{
"panels":[
{
"label":"LBL_LABEL_1",
"fields":[
{
"name":"case_number",
"label":"LBL_AGENT_WORKBENCH_NUMBER",
"subfields":[
{
"default":true,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-9
|
{
"default":true,
"enabled":true,
"name":"case_number",
"label":"LBL_AGENT_WORKBENCH_NUMBER"
}
]
},
{
"name":"Priority/Status",
"label":"LBL_LIST_PRIORITY/LBL_STATUS",
"subfields":[
{
"default":true,
"enabled":true,
"name":"priority",
"label":"LBL_LIST_PRIORITY",
"type":"enum"
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-10
|
},
{
"default":true,
"enabled":true,
"name":"status",
"label":"LBL_STATUS",
"type":"case-status",
"widget_name":"widget_status"
}
]
},
{
"name":"Subject/Service Level",
"label":"LBL_LIST_SUBJECT/LBL_SERVICE_LEVEL",
"subfields":[
{
"default":true,
"enabled":true,
"name":"name",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-11
|
"enabled":true,
"name":"name",
"label":"LBL_LIST_SUBJECT",
"link":false
},
{
"default":true,
"enabled":true,
"name":"service_level",
"label":"LBL_SERVICE_LEVEL",
"type":"enum",
"enum_module":"Accounts",
"link":false
}
]
}
]
}
],
"collectionOptions":{
"limit":100,
"params":{
"max_num":100,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-12
|
"params":{
"max_num":100,
"order_by":"follow_up_datetime",
"nulls_last":true
}
},
"filterDef":[
{
"status":{
"$not_in":[
"Closed",
"Rejected",
"Duplicate"
]
},
"$owner":""
}
]
}
}
}
}
}
}
Response Arguments
Response
{
"is_setup":1,
"enabled_modules":{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-13
|
{
"is_setup":1,
"enabled_modules":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":[
"Cases"
],
"da438c86-df5e-11e9-9801-3c15c2c53980":[
"Accounts",
"Opportunities"
]
},
"order_by_primary":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":"follow_up_datetime:asc"
},
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-14
|
"Cases":"follow_up_datetime:asc"
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":"next_renewal_date:asc",
"Opportunities":"date_closed:asc"
}
},
"order_by_secondary":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":""
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":"",
"Opportunities":""
}
},
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-15
|
"Opportunities":""
}
},
"filter_def":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":[
{
"status":{
"$not_in":[
"Closed",
"Rejected",
"Duplicate"
]
}
},
{
"$owner":""
}
]
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":[
{
"$owner":""
}
],
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-16
|
{
"$owner":""
}
],
"Opportunities":[
{
"sales_status":{
"$not_in":[
"Closed Won",
"Closed Lost"
]
}
},
{
"$owner":""
}
]
}
},
"defaults":{
"is_setup":0,
"enabled_modules":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":[
"Cases"
],
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-17
|
"Cases"
],
"da438c86-df5e-11e9-9801-3c15c2c53980":[
"Accounts",
"Opportunities"
]
},
"order_by_primary":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":"follow_up_datetime:asc"
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":"next_renewal_date:asc",
"Opportunities":"date_closed:asc"
}
},
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-18
|
}
},
"order_by_secondary":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":""
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":"",
"Opportunities":""
}
},
"filter_def":{
"c108bb4a-775a-11e9-b570-f218983a1c3e":{
"Cases":[
{
"status":{
"$not_in":[
"Closed",
"Rejected",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-19
|
"Closed",
"Rejected",
"Duplicate"
]
}
},
{
"$owner":""
}
]
},
"da438c86-df5e-11e9-9801-3c15c2c53980":{
"Accounts":[
{
"$owner":""
}
],
"Opportunities":[
{
"sales_status":{
"$not_in":[
"Closed Won",
"Closed Lost"
]
}
},
{
"$owner":""
}
]
}
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationconfig_POST/index.html
|
9e029a20cacb-20
|
"$owner":""
}
]
}
}
}
}
Response Codes and Error Messages
This API does not return new errors other than the ones that may be returned by its parent API - ConfigModule API. The following error responses are possible:
403 (SugarAPIExceptionNotAuthorized) : Sent if the user attempts to access a module that they are forbidden to access.
Change Log
Version
Change
v11.9
Added /ConsoleConfiguration/config 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/ConsoleConfigurationconfig_POST/index.html
|
f8d15829356c-0
|
/rssfeed GET
Overview
Consumes an RSS feed as a proxy and returns the feed up to a certain number of entries.
Request Arguments
Name
Type
Description
Required
feed_url
String
A fully qualified URL to an RSS feed.
True
limit
Integer
Maximum number of entries to fetch. If not provided, the API will return up to $sugar_config['rss_feed_max_entries'] or 20 if no config option is set.
False
Request
http://{site_url}/rest/v10/rssfeed?feed_url=http%3A%2F%2Ffqd.rssfeed.url%2F&limit=10
Note: GET endpoint parameters are passed in the form of a query string.
Response Arguments
Name
Type
Description
title
String
The title of the RSS Feed. This can be blank.
link
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/rssfeed_GET/index.html
|
f8d15829356c-1
|
title
String
The title of the RSS Feed. This can be blank.
link
String
The URL to the source of the RSS Feed. This can be blank.
description
String
A description of the feed. This can be blank.
publication_date
Timestamp
A timestamp of when the feed was published.
entries
Array
An array of entries, each of which will contain the following values:
title
description
link
publication_date
source
author
Response
{
"feed":{
"title":"Sample Feed Title",
"link":"http:\/\/www.samplefeed.com\/feed-link-url.htm",
"description":"A sample of a feed description",
"publication_date":"Tue, 10 Aug 2014 13:38:55 -0800",
"entries":[
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/rssfeed_GET/index.html
|
f8d15829356c-2
|
"entries":[
{
"title":"First entry title",
"description":"A blurb about the first entry. This will be HTML encoded on return.",
"link":"http:\/\/www.samplefeed.com\/feed-entry-1.htm",
"publication_date":"Tue, 10 Aug 2014 13:38:55 -0800",
"source":"Reuters",
"author":"John Doe"
},
{
"title":"Second entry title",
"description":"A blurb about the Second entry. This will be HTML encoded on return.",
"link":"http:\/\/www.samplefeed.com\/feed-entry-2.htm",
"publication_date":"Tue, 10 Aug 2014 13:38:55 -0800",
"source":"BBC",
"author":""
}
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/rssfeed_GET/index.html
|
f8d15829356c-3
|
"source":"BBC",
"author":""
}
]
}
}
Change Log
Version
Change
v10
Added /<rssfeed> 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/rssfeed_GET/index.html
|
8881afe72224-0
|
/ExpressionEngine/:record/related GET
Retrieve a Forecasting Information In SugarChart Format
Summary:
This endpoint is used to return the json Data for SugarCharts to use to display the needed chart.
Query Parameters:
Param
Description
Optional
timeperiod_id
Show for a specific time period
Â
user_id
Show for a specific user
Â
display_manager
Pipeline or Committed are valid values.
Â
dataset
Which Forecast dataset to show, valid values are likely, best, worst. Defaults to likely if one is not specified
Optional
group_by
Show Which fields the y-axis shows on the chart. Can be any field in the opportunity module, defaults to Sales Stage
Optional
ranges
Pipeline or Committed are valid values.
Optional
Input Example:
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_GET/index.html
|
8881afe72224-1
|
Pipeline or Committed are valid values.
Optional
Input Example:
{
'user_id':'seed_max_id,
'timeperiod_id':'36f7085a-5889-ea75-84c8-50f42bd1a5ba',
'display_manager':'false',
'group_by': 'forecast',
'dataset': 'likely',
'ranges': 'include',
}
Output Example:
{ "color" : [ "#8c2b2b",
"#468c2b",
"#2b5d8c",
"#cd5200",
"#e6bf00",
"#7f3acd",
"#00a9b8",
"#572323",
"#004d00",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_GET/index.html
|
8881afe72224-2
|
"#572323",
"#004d00",
"#000087",
"#e48d30",
"#9fba09",
"#560066",
"#009f92",
"#b36262",
"#38795c",
"#3D3D99",
"#99623d",
"#998a3d",
"#994e78",
"#3d6899",
"#CC0000",
"#00CC00",
"#0000CC",
"#cc5200",
"#ccaa00",
"#6600cc",
"#005fcc"
],
"label" : [ "Include" ],
"properties" : [ { "gauge_target_list" : "Array",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_GET/index.html
|
8881afe72224-3
|
"goal_marker_color" : [ "#000000",
"#7D12B2"
],
"goal_marker_label" : [ "Quota",
"Likely Case"
],
"goal_marker_type" : [ "group",
"pareto"
],
"label_name" : "Include in Forecast",
"labels" : "value",
"legend" : "on",
"print" : "on",
"subtitle" : "",
"thousands" : "",
"title" : null,
"type" : "bar chart",
"value_name" : "Likely Case"
} ],
"values" : [ { "goalmarkervalue" : [ "111000.00",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_GET/index.html
|
8881afe72224-4
|
"36000.00"
],
"goalmarkervaluelabel" : [ "$111,000.00",
"$36,000.00"
],
"gvalue" : 36000,
"gvaluelabel" : "$36,000.00",
"label" : "January 2013",
"links" : [ "" ],
"valuelabels" : [ "$36,000.00" ],
"values" : [ 36000 ]
},
{ "goalmarkervalue" : [ "111000.00",
"61500.00"
],
"goalmarkervaluelabel" : [ "$111,000.00",
"$61,500.00"
],
"gvalue" : 25500,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_GET/index.html
|
8881afe72224-5
|
],
"gvalue" : 25500,
"gvaluelabel" : "$25,500.00",
"label" : "February 2013",
"links" : [ "" ],
"valuelabels" : [ "$25,500.00" ],
"values" : [ 25500 ]
},
{ "goalmarkervalue" : [ "111000.00",
"61500.00"
],
"goalmarkervaluelabel" : [ "$111,000.00",
"$61,500.00"
],
"gvalue" : 0,
"gvaluelabel" : "$0.00",
"label" : "March 2013",
"links" : [ "" ],
"valuelabels" : [ "$0.00" ],
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_GET/index.html
|
8881afe72224-6
|
"valuelabels" : [ "$0.00" ],
"values" : [ 0 ]
}
]
}
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/ExpressionEnginerecordrelated_GET/index.html
|
7b7b52a20b20-0
|
/me/preference/:preference_name DELETE
Overview
Deletes a specific preference for the current user.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
Â
Â
Â
Response
{
}
Change Log
Version
Change
v10
Added /me/preference/:preference_name DELETE 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/mepreferencepreference_name_DELETE/index.html
|
e7bc2616d11e-0
|
/pmse_Project/:record/dproject GET
Overview
Exports a .bpm file with a Process Definition
Summary
This endpoint will retrieve a .bpm file containing JSON encoded data of a
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
N/A
Response
Note: The response is a MIME type application/bpm file attachment without any response parameters.
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_Projectrecorddproject_GET/index.html
|
47836fa70692-0
|
/pmse_Inbox/getLog GET
Overview
Return the text of the PMSE.log file
Summary
This endpoint gets the contents of the PMSE.log file
Request Arguments
There are no request arguments for this endpoint
Response Arguments
Name
Type
Description
none
string
Log Entries from PMSE.log
Response
"Test Log Entry1\nTest Log Entry2\n"
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_InboxgetLog_GET/index.html
|
a3771e94ee96-0
|
/ForecastWorksheets/:timeperiod_id GET
Returns a collection of ForecastWorksheet models
Summary:
This end point is used to return the Worksheets for a user at a given timeperiod. If no timeperiod is provide it
will use the default timeperiod, likewise if no user is provided, it will default to the logged in user.
Also this end points use the visibility requirements set forth by the application, that if the records being requested
belong to you, you will get the draft version, If the worksheet is not yours, you will only see the committed version.
Url Parameters:
Param
Description
Optional
timeperiod_id
Show for a specific time period, defaults to the current time period if one is not passed
Optional
user_id
Show for a specific user, defaults to current user if not defined
Optional
Query Parameters:
Param
Description
Optional
type
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetstimeperiod_id_GET/index.html
|
a3771e94ee96-1
|
Optional
Query Parameters:
Param
Description
Optional
type
Which type to return, currently the ones that are supported are, opportunity and product
Optional
Possible Errors
Error
Description
412 - Invalid Parameter
When the passed in timeperiod and/or user can not be found
403 - Not Authorized
If you are not a manager, but you are tyring to view another sales rep forecast worksheet, you will receive a 403 Not Authorized Error
Url Example:
/rest/v10/ForecastWorksheets/:timeperiod_id/:user_id
Output Example:
{ "next_offset": -1,
"records": [
{
"id": "ad3908c7-83a3-f360-c223-51117844c208",
"name": "Grow-Fast Inc - 1000 units",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetstimeperiod_id_GET/index.html
|
a3771e94ee96-2
|
"name": "Grow-Fast Inc - 1000 units",
"date_entered": "2013-02-05T21:22:00+00:00",
"date_modified": "2013-02-05T21:22:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "",
"deleted": "0",
"assigned_user_id": "seed_jim_id",
"assigned_user_name": "Jim Brennan",
"team_name": [
{
"id": "East",
"name": "East",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetstimeperiod_id_GET/index.html
|
a3771e94ee96-3
|
{
"id": "East",
"name": "East",
"name_2": "",
"primary": true
}
],
"parent_id": "50b90565-e748-ed77-d9d7-511178f5acae",
"parent_type": "Opportunities",
"account_name": "",
"account_id": "",
"likely_case": "75000",
"best_case": "75000",
"worst_case": "75000",
"base_rate": "1",
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "",
"date_closed": "2013-02-10",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetstimeperiod_id_GET/index.html
|
a3771e94ee96-4
|
"date_closed": "2013-02-10",
"date_closed_timestamp": "1360531443",
"sales_stage": "Perception Analysis",
"probability": "70",
"commit_stage": "include",
"draft": "1",
"my_favorite": false,
"_acl": {
"fields": {}
}
}]
}
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/ForecastWorksheetstimeperiod_id_GET/index.html
|
7331baaf0a51-0
|
/RevenueLineItems/multi-quote POST
Convert Multiple Revenue Line Item to a quote.
Summary:
This endpoint is used to convert multiple Revenue Line Items to a single quote
Query Parameters:
Param
Description
Optional
Valid Urls:
POST: /rest/v10/RevenueLineItems/multi-quote
Input Example:
{
records : [
'id_1',
'id_2',
]
opportunity_id:"123-456-789-0",
account_id:"12-3-4-5"
}
Output Example:
{
id:"123-456-789-0",
name:"My Test Quote"
}
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/RevenueLineItemsmulti-quote_POST/index.html
|
8ac95d3387e5-0
|
/Documents/:record/file/:field PUT
Overview
This endpoint takes a file or image and saves it to a record that already contains an attachment in the specified field. The PUT method is very similar to the POST method but differs slightly in how the request is constructed. PUT requests should send the file data as the body of the request. Optionally, a filename query parameter can be sent with the request to assign a name. Additionally, the PUT
method can accept base64 encoded file data which will be decoded by the endpoint
if the content_transfer_encoding parameter is set to 'base64'.NOTE: In lieu of the content_transfer_encoding parameter, a
request header of X-Content-Transfer-Encoding can also be sent with a value
of 'base64'. In the event both the content transfer encoding header and request
parameter are sent, the header will be used.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Documentsrecordfilefield_PUT/index.html
|
8ac95d3387e5-1
|
parameter are sent, the header will be used.
Request Arguments
Name
Type
Description
Required
filename
String
Filename to save the document as
False
content_transfer_encoding
String
When set to 'base64', indicates the file contents are base64 encoded
and will result in the file contents being base64 decoded before being
saved
False
Request
PUT /rest/v10/Notes/abcd-1234/file/field/ HTTP/1.1 Host: localhost Connection: keep-alive Content-Length: 23456 Content-Type: application/document-doc ...This is where the bin data would be
Response Arguments
Name
Type
Description
field
Array
The fields containing file properties.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Documentsrecordfilefield_PUT/index.html
|
8ac95d3387e5-2
|
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 name.
field.width
Integer
The width of the image.
field.height
Integer
The height of the image.
field.uri
String
The URI of the file.
Response
{
"picture":{
"content-type":"image\/png",
"content-length":72512,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Documentsrecordfilefield_PUT/index.html
|
8ac95d3387e5-3
|
"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"
}
"attachment":{
"content-type":"application/document-doc",
"content-length":"873921",
"name":"myFile.doc",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Documentsrecordfilefield_PUT/index.html
|
8ac95d3387e5-4
|
"name":"myFile.doc",
"uri": "http:\/\/sugarcrm\/rest\/v10\/Contacts\/f2f9aa4d-99a8-e86e-f4d5-512d0986effa\/file\/attachment"
}
}
Change Log
Version
Change
v10
Added /<module>/:record/file/:field 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/Documentsrecordfilefield_PUT/index.html
|
a5e2db94006d-0
|
/Administration/packages/:id/disable GET
Overview
[ADMIN] PackageManager disable a package.
Summary
Disable the specified package. Package id hash must be provided. Package id could be found in installed package list.
Response
Returns http status 200 OK and disabled package ID if request is successful.
{
"id": "56365210-4cce-11ea-a7bf-acde48001122"
}
Otherwise returns http status 4xx with errors.
{
"error": "not_found",
"error_message": "Could not find package by ID."
}
Change Log
Version
Change
v11.8
Added /Administration/packages/:id/disable 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/Administrationpackagesiddisable_GET/index.html
|
3f49179a8789-0
|
/Administration/elasticsearch/refresh/enable POST
Overview
[ADMIN] Elasticsearch enable refresh_interval
Summary
Enable refresh_interval for all indices managed by SugarCRM. This endpoint is only
available to administrators.
Response
{
"aabbcc_contactsleads": 200,
"aabbcc_accountsonly": 200,
"aabbcc_shared": 200
}
Change Log
Version
Change
v10
Added /Administration/elasticsearch/refresh/enable 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/Administrationelasticsearchrefreshenable_POST/index.html
|
f18a248ad5e1-0
|
/<module>/:record/link/:link_name/filter/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_namefiltercount_GET/index.html
|
f18a248ad5e1-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_namefiltercount_GET/index.html
|
f18a248ad5e1-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_namefiltercount_GET/index.html
|
f18a248ad5e1-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_namefiltercount_GET/index.html
|
f18a248ad5e1-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_namefiltercount_GET/index.html
|
f18a248ad5e1-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_namefiltercount_GET/index.html
|
f18a248ad5e1-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_namefiltercount_GET/index.html
|
f18a248ad5e1-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_namefiltercount_GET/index.html
|
f18a248ad5e1-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_namefiltercount_GET/index.html
|
f18a248ad5e1-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_namefiltercount_GET/index.html
|
f18a248ad5e1-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_namefiltercount_GET/index.html
|
f18a248ad5e1-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_namefiltercount_GET/index.html
|
f18a248ad5e1-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_namefiltercount_GET/index.html
|
f18a248ad5e1-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_namefiltercount_GET/index.html
|
f18a248ad5e1-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_namefiltercount_GET/index.html
|
f18a248ad5e1-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_namefiltercount_GET/index.html
|
f18a248ad5e1-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_namefiltercount_GET/index.html
|
f18a248ad5e1-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_namefiltercount_GET/index.html
|
f18a248ad5e1-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_namefiltercount_GET/index.html
|
f18a248ad5e1-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_namefiltercount_GET/index.html
|
6c5e02a065c4-0
|
/Activities/filter GET
Activities on the home page
Summary:
This endpoint lists activities across the entire sytstem. It uses a subscription model, and can be queried like a normal bean collection, but without search, ordering or filtering.
Query Parameters:
ParamDescriptionOptionalmax_numA maximum number of records to returnOptionaloffsetHow many records to skip over before records are returnedOptional
Input Example:
This endpoint does not accept any input
Output Example:
{
"next_offset": 20, This will be set to -1 when there are no more records after this "page".
"records": [{
"id": "22fb8b16-de1d-f1dc-b15b-51240efde177",
"date_entered": "2013-02-19T23:47:11+00:00",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Activitiesfilter_GET/index.html
|
6c5e02a065c4-1
|
"date_modified": "2013-02-19T23:47:11+00:00",
"created_by": "1",
"deleted": "0",
"parent_id": "f5bb0331-2c0f-5c7c-b4db-5123caac0056",
"parent_type": "Contacts",
"activity_type": "post", This will be the type of activity performed.
"data": {
"value": "This is a test post on a contact I'm subscribed to."
},
"comment_count": 0, This will be set to the total number of comments on the post.
"last_comment": { This will be the last comment on the post, which can be used to create a comment model on the frontend.
"deleted": 0,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Activitiesfilter_GET/index.html
|
6c5e02a065c4-2
|
"deleted": 0,
"data": []
},
"fields": [],
"first_name": null,
"last_name": "Administrator",
"created_by_name": " Administrator" This will be the locale-formatted full name of the user.
}, ... ]
}
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/Activitiesfilter_GET/index.html
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.