REST API:bulk Resource
Provides Data Import capabilities using the REST API. Using this API, a CSV file containing data records can be uploaded to an object.
- Learn more:
Requirements
- A valid Login session.
- A sessionId for the request header.
- A Mapping Profile, which maps CSV fields to record fields and specifies the Data Merge strategy, created either in the GUI, or using the import Mapping Profile Resource
Tip: To upload a record that has a raw data field (like an image), add a URL field for the path to an image. Then create an action-driven Data Policy to load the image from the URL. The bulk upload then reads URLs from the CSV data, while the data policy processes them to load the raw data.
Bulk Upload Object Data
Loads CSV data into an object.
- Method
- POST
- URI
- https://{yourDomain}/networking/rest/bulk/{objectName}
- Parameter
- objectName: An Object Identifier. Object names are recommended, but Object IDs are supported for backward compatibility.
- All Custom Objects support bulk upload. In addition, these CRM Objects are supported:
Name (shown in the GUI) Object Name (used in the URI) Accounts Accounts Contacts Contacts Prospect Leads Opportunity Opportunities Activity Activities
Note: Specify the Object Name in the URI. Case is significant.
- Request
- A multipart request with file part for the CSV data and an XML part with information.
- Here's a sample request that uploads data to a Customers object:
- <syntaxhighlight lang="xml" enclose="div">
Content-Type: multipart/form-data; boundary=.............................103832778631715
--.............................103832778631715 Content-Disposition: form-data; name="bulk"; Content-Type: application/xml;
<platform>
<bulk>
<mapping>CustomerMap</mapping>
</bulk>
</platform>
.............................103832778631715 Content-Disposition: form-data; name="Customers.csv"; filename="Customers.csv" Content-type: application/octet-stream
{contents of file} .............................103832778631715-- </syntaxhighlight>
- Learn more: REST API:Multipart Request
- Response
Returns the id of the submitted import job, along with a message telling whether or not the job was accepted for processing. (Use the REST import Status resource to follow the progress of the job.)
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<message>
0
<description>Success</description>
<id>yur456poi967</id>
</message>
</platform> </syntaxhighlight>
- See also: REST API:Error Codes
Fields
Name Type Required Description mapping String Yes Name of the Mapping Profile created in the platform UI leadSource String for import into Prospects Prospect source. Applies to all imported records. ownerName String for import into Activities Default owner ID or name. (This user is assigned the activity when assignedid and contactid are not mapped, or when neither field in a record has a value.)
Sample Http Client for bulk uploads
- This sample client uploads Customer data. It is contained in the Samples Zip file.
(For the JAR files it uses, see Setting Up the Development Enviroment.) - Learn more about the login process: REST login resource
- <syntaxhighlight lang="java" enclose="div">
package demo.rest;
import java.io.ByteArrayInputStream; import java.io.File; import java.io.InputStream;
import javax.ws.rs.core.MediaType; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.xpath.XPath; import javax.xml.xpath.XPathConstants; import javax.xml.xpath.XPathExpression; import javax.xml.xpath.XPathFactory;
import org.apache.commons.httpclient.HttpClient; import org.apache.commons.httpclient.methods.PostMethod; import org.apache.commons.httpclient.methods.StringRequestEntity; import org.apache.commons.httpclient.methods.multipart.FilePart; import org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity; import org.apache.commons.httpclient.methods.multipart.Part; import org.apache.commons.httpclient.methods.multipart.StringPart;
import org.w3c.dom.Document; import org.xml.sax.InputSource;
public class BulkUploadClient {
public static void main(String[] args)
{
try
{
// Modify the login() method to specify user name and password.
HttpClient httpClient = login();
String url = "http://localhost/networking/rest/bulk/Customer"; String importXml = "<platform>" + "<bulk>" + "<mapping>CustomerMap</mapping>" + // For Prospects, add: "<leadSource>...</leadSource>" + // For Activities, add: "<ownerName>...</ownerName>" + "</bulk>" + "</platform>" ; // XML part StringPart sp = new StringPart("bulk", importXml); sp.setContentType(MediaType.APPLICATION_XML); // File part File file = new File("c:/document/customers.csv"); // Multipart wrapper Part[] part = { new FilePart(file.getName(),file), sp }; // Create the request PostMethod postMethod = new PostMethod(url); MultipartRequestEntity requestEntity = new MultipartRequestEntity( part, postMethod.getParams() ); postMethod.setRequestEntity(requestEntity);
// Send it
int status = httpClient.executeMethod(postMethod);
System.out.println("HTTP Status = " + status);
String responseXml = postMethod.getResponseBodyAsString();
String jobId = getValue("platform/message/id", responseXml);
System.out.println("Use the following URL to check job status:");
System.out.println("https://{domain}/networking/rest/status/import/"
+ jobId);
}
catch (Exception e)
{
e.printStackTrace();
}
}
/**
* Log into the platform. After doing so, session ID is automatically
* set for all future requests that use the HttpClient. (The server sets up
* a cookie string for the session, and returns it in the response. The
* HttpClient instance saves that string and adds it to subsequent requests.
* Reusing an instance of HttpClient, in effect, defines a "session".)
*
* @return The HttpClient object when the login succeeds.
* @throws An exception if the login fails.
*/
public static HttpClient login() throws Exception
{
String url = "https://{domain}/networking/rest/login";
PostMethod postMethod = new PostMethod(url);
String loginXml =
"<platform>" +
"<login>" +
"<userName>yourLoginName</userName>" +
"<password>YourPassword</password>" +
"</login>" +
"</platform>" ;
StringRequestEntity reqXml =
new StringRequestEntity(loginXml, MediaType.APPLICATION_XML, "UTF-8");
postMethod.setRequestEntity(reqXml);
// Log in
HttpClient httpClient = new HttpClient();
int status = httpClient.executeMethod(postMethod);
if (status != 200) {
throw new Exception("Login failed with HTTP status " + status);
}
return httpClient;
}
/**
* Given an XPath expression and XML, parse for a specific value.
* @param xpath_expr An XPATH expression.
* For example: "/platform/message/description"
* @param xml The XML string to be parsed.
*/
public static String getValue(String xpath_expr, String xml)
{
try {
DocumentBuilderFactory docFactory =
DocumentBuilderFactory.newInstance();
docFactory.setNamespaceAware(true);
DocumentBuilder docbuilder = docFactory.newDocumentBuilder();
InputStream is = new ByteArrayInputStream(xml.getBytes());
Document doc = docbuilder.parse(new InputSource(is));
XPathFactory factory = XPathFactory.newInstance();
XPath xpath = factory.newXPath();
XPathExpression expr = xpath.compile(xpath_expr);
Object result = expr.evaluate(doc, XPathConstants.STRING);
return result.toString();
}
catch (Exception e)
{
e.printStackTrace();
}
return null;
}
}
</syntaxhighlight>