SugarCRM SupportProduct GuidesSugar DeveloperSugar Developer Guide 10.1IntegrationWeb ServicesREST APIEndpoints/<module>/export/:record_list_id GET
This release is only available for SugarCloud customers.

/<module>/export/:record_list_id GET

Overview

Returns a record set in CSV format along with HTTP headers to indicate content type.

Request Arguments

Name Type Description Required
uid Array A list of bean ids. False
filter Array The filter expression. More information on filter expressions can be found in /<module>/filter. False
sample Array Indicates whether to download sample data. False

Request

Exporting Records by Specific IDs

{
   "uid":"d43243c6-9b8e-2973-aee2-512d09bc34b4"
}

Exporting Records by a List of IDs

{
   "uid":[
      "d43243c6-9b8e-2973-aee2-512d09bc34b4",
      "b3e87a3f-cd8f-7b86-467a-512d09e8d240"
   ]
}

Exporting Records Using a Filter

{
   "filter":[
      {
         "name":"airline"
      }
   ]
}

Exporting a Sample Result Set

{
    "sample":true
}

Response Arguments

Name Type Description
<csv export> String Returns the selected records in CSV format with the content headers.

Response

result: HTTP/1.1 200 OK
Date: Fri, 01 Mar 2013 04:05:55 GMT
Server: Apache/2.2.22 (Unix) DAV/2 PHP/5.3.17
X-Powered-By: PHP/5.3.17
Expires: Mon, 26 Jul 1997 05:00:00 GMT
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Pragma: cache
Content-Disposition: attachment; filename=Accounts.csv
Content-transfer-encoding: binary
Last-Modified: Fri, 01 Mar 2013 04:05:55 GMT
Cache-Control: post-check=0, pre-check=0
Content-Length: 1080
Connection: close
Content-Type: application/octet-stream; charset=UTF-8

"Name","ID","Website","Email Address","Office Phone","Alternate Phone","Fax","Billing Street","Billing City","Billing State","Billing Postal Code","Billing Country","Shipping Street","Shipping City","Shipping State","Shipping Postal Code","Shipping Country","Description","Type","Industry","Annual Revenue","Employees","SIC Code","Ticker Symbol","Parent Account ID","Ownership","Campaign ID","Rating","Assigned User Name","Assigned To","Team ID","Teams","Team Set ID","Date Created","Date Modified","Modified By","Created By","Deleted","Image","last_activity_date","Linkedin Company ID","Facebook Account","Twitter Account","Google Plus ID"
"Arts & Crafts Inc","d43243c6-9b8e-2973-aee2-512d09bc34b4","","","(052) 034-1853","","","777 West Filmore Ln","Santa Monica","CA","35354","USA","777 West Filmore Ln","Santa Monica","CA","35354","USA","","Customer","Transportation","","","","","","","","","sally","seed_sally_id","West","West","West","02/26/2013 07:12 pm","02/26/2013 07:12 pm","1","1","0","","02/26/2013 07:12 pm","","","",""

Change Log

Version Change
v10 Added /<module>/export GET endpoint.

Last modified: 2020-06-17 13:08:13