Retrieves one or more custom objects using a combination of criteria consisting of zero or one custom object keys.
Returns a list of matching custom objects, all of a single type, up to 100 in a batch, and a stream position token for retrieving successive batches.
Request
Field Name |
Required/Optional |
Description |
---|---|---|
objTypeName | Required | Name of the Custom Object |
customObjKeyLists->keyList->attribute | Required | The attribute is a key/value pair that is used to identify the custom objects you want to retrieve. You can specify multiple attributes in the customObjKeyLists |
includeAttributes | Required | The list of custom object’s fields that you wish to retrieve. Passing none will return all values. |
batchSize | Optional | The number of objects to be returned (max of 100) |
streamPosition | Optional | Used to paginate through multiple results sets. The value passed is the value returned by the previous getCustomObjects call. |
Request XML
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.marketo.com/mktows/"> <SOAP-ENV:Header> <ns1:AuthenticationHeader> <mktowsUserId>demo17_1_809934544BFABAE58E5D27</mktowsUserId> <requestSignature>974ad482f5625657d82f38ee1522b69f0d6bc715</requestSignature> <requestTimestamp>2013-08-20T11:18:12-07:00</requestTimestamp> </ns1:AuthenticationHeader> </SOAP-ENV:Header> <SOAP-ENV:Body> <ns1:paramsGetCustomObjects> <objTypeName>RoadShow</objTypeName> <customObjKeyList> <attribute> <attrName>MKTOID</attrName> <attrValue>1090177</attrValue> </attribute> </customObjKeyList> <includeAttributes /> </ns1:paramsGetCustomObjects> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
Response XML
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="http://www.marketo.com/mktows/"> <SOAP-ENV:Body> <ns1:successGetCustomObjects> <result> <objTypeName>Roadshow</objTypeName> <returnCount>6</returnCount> <remainingCount>0</remainingCount> <newStreamPosition>{"ky":["1090177"],"os":6}</newStreamPosition> <customObjList> <customObj> <customObjKeyList> <attribute> <attrName>MKTOID</attrName> <attrType xsi:nil="true" /> <attrValue>1090177</attrValue> </attribute> <attribute> <attrName>rid</attrName> <attrType xsi:nil="true" /> <attrValue>123456</attrValue> </attribute> </customObjKeyList> <customObjAttributeList> <attribute> <attrName>city</attrName> <attrType xsi:nil="true" /> <attrValue>city4</attrValue> </attribute> <attribute> <attrName>state</attrName> <attrType xsi:nil="true" /> <attrValue>state4</attrValue> </attribute> <attribute> <attrName>zip</attrName> <attrType xsi:nil="true" /> <attrValue>zip4</attrValue> </attribute> </customObjAttributeList> </customObj> <customObj> <customObjKeyList> <attribute> <attrName>MKTOID</attrName> <attrType xsi:nil="true" /> <attrValue>1090177</attrValue> </attribute> <attribute> <attrName>rid</attrName> <attrType xsi:nil="true" /> <attrValue>rid0</attrValue> </attribute> </customObjKeyList> <customObjAttributeList> <attribute> <attrName>city</attrName> <attrType xsi:nil="true" /> <attrValue>city0</attrValue> </attribute> <attribute> <attrName>state</attrName> <attrType xsi:nil="true" /> <attrValue>state0</attrValue> </attribute> <attribute> <attrName>zip</attrName> <attrType xsi:nil="true" /> <attrValue>zip0</attrValue> </attribute> </customObjAttributeList> </customObj> <customObj> <customObjKeyList> <attribute> <attrName>MKTOID</attrName> <attrType xsi:nil="true" /> <attrValue>1090177</attrValue> </attribute> <attribute> <attrName>rid</attrName> <attrType xsi:nil="true" /> <attrValue>rid1</attrValue> </attribute> </customObjKeyList> <customObjAttributeList> <attribute> <attrName>city</attrName> <attrType xsi:nil="true" /> <attrValue>SanMateo</attrValue> </attribute> <attribute> <attrName>state</attrName> <attrType xsi:nil="true" /> <attrValue>California</attrValue> </attribute> <attribute> <attrName>zip</attrName> <attrType xsi:nil="true" /> <attrValue>94404</attrValue> </attribute> </customObjAttributeList> </customObj> <customObj> <customObjKeyList> <attribute> <attrName>MKTOID</attrName> <attrType xsi:nil="true" /> <attrValue>1090177</attrValue> </attribute> <attribute> <attrName>rid</attrName> <attrType xsi:nil="true" /> <attrValue>rid2</attrValue> </attribute> </customObjKeyList> <customObjAttributeList> <attribute> <attrName>city</attrName> <attrType xsi:nil="true" /> <attrValue>city2</attrValue> </attribute> <attribute> <attrName>state</attrName> <attrType xsi:nil="true" /> <attrValue>state2</attrValue> </attribute> <attribute> <attrName>zip</attrName> <attrType xsi:nil="true" /> <attrValue>zip2</attrValue> </attribute> </customObjAttributeList> </customObj> <customObj> <customObjKeyList> <attribute> <attrName>MKTOID</attrName> <attrType xsi:nil="true" /> <attrValue>1090177</attrValue> </attribute> <attribute> <attrName>rid</attrName> <attrType xsi:nil="true" /> <attrValue>rid3</attrValue> </attribute> </customObjKeyList> <customObjAttributeList> <attribute> <attrName>city</attrName> <attrType xsi:nil="true" /> <attrValue>city3</attrValue> </attribute> <attribute> <attrName>state</attrName> <attrType xsi:nil="true" /> <attrValue>state3</attrValue> </attribute> <attribute> <attrName>zip</attrName> <attrType xsi:nil="true" /> <attrValue>zip3</attrValue> </attribute> </customObjAttributeList> </customObj> <customObj> <customObjKeyList> <attribute> <attrName>MKTOID</attrName> <attrType xsi:nil="true" /> <attrValue>1090177</attrValue> </attribute> <attribute> <attrName>rid</attrName> <attrType xsi:nil="true" /> <attrValue>rid4</attrValue> </attribute> </customObjKeyList> <customObjAttributeList> <attribute> <attrName>city</attrName> <attrType xsi:nil="true" /> <attrValue>city4</attrValue> </attribute> <attribute> <attrName>state</attrName> <attrType xsi:nil="true" /> <attrValue>state4</attrValue> </attribute> <attribute> <attrName>zip</attrName> <attrType xsi:nil="true" /> <attrValue>zip4</attrValue> </attribute> </customObjAttributeList> </customObj> </customObjList> </result> </ns1:successGetCustomObjects> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
Sample Code – PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
<?php $debug = true; $marketoSoapEndPoint = ""; // CHANGE ME $marketoUserId = ""; // CHANGE ME $marketoSecretKey = ""; // CHANGE ME $marketoNameSpace = "http://www.marketo.com/mktows/"; // Create Signature $dtzObj = new DateTimeZone("America/Los_Angeles"); $dtObj = new DateTime('now', $dtzObj); $timeStamp = $dtObj->format(DATE_W3C); $encryptString = $timeStamp . $marketoUserId; $signature = hash_hmac('sha1', $encryptString, $marketoSecretKey); // Create SOAP Header $attrs = new stdClass(); $attrs->mktowsUserId = $marketoUserId; $attrs->requestSignature = $signature; $attrs->requestTimestamp = $timeStamp; $authHdr = new SoapHeader($marketoNameSpace, 'AuthenticationHeader', $attrs); $options = array("connection_timeout" => 15, "location" => $marketoSoapEndPoint); if ($debug) { $options["trace"] = 1; } // Create Request $keyAttrib1 = new stdClass(); $keyAttrib1->attrName = 'MKTOID'; $keyAttrib1->attrValue = '1090177'; $keyAttrList = array($keyAttrib1); $keyList = new stdClass(); $keyList->attribute = $keyAttrList; $params = new stdClass(); $params->objTypeName = 'RoadShow'; $params->customObjKeyList = $keyList; $params->includeAttributes = null; $soapClient = new SoapClient($marketoSoapEndPoint ."?WSDL", $options); try { $leads = $soapClient->__soapCall('getCustomObjects', array($params), $options, $authHdr); // print_r($leads); } catch(Exception $ex) { var_dump($ex); } if ($debug) { print "RAW request:\n" .$soapClient->__getLastRequest() ."\n"; print "RAW response:\n" .$soapClient->__getLastResponse() ."\n"; } ?> |
Sample Code – Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
import com.marketo.mktows.*; import java.net.URL; import javax.xml.namespace.QName; import java.text.DateFormat; import java.text.SimpleDateFormat; import java.util.Date; import javax.crypto.Mac; import javax.crypto.spec.SecretKeySpec; import org.apache.commons.codec.binary.Hex; import javax.xml.bind.JAXBContext; import javax.xml.bind.JAXBElement; import javax.xml.bind.Marshaller; public class GetCustomObjects { public static void main(String[] args) { System.out.println("Executing Get Custom Objects"); try { URL marketoSoapEndPoint = new URL("CHANGE ME" + "?WSDL"); String marketoUserId = "CHANGE ME"; String marketoSecretKey = "CHANGE ME"; QName serviceName = new QName("http://www.marketo.com/mktows/", "MktMktowsApiService"); MktMktowsApiService service = new MktMktowsApiService(marketoSoapEndPoint, serviceName); MktowsPort port = service.getMktowsApiSoapPort(); // Create Signature DateFormat df = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssZ"); String text = df.format(new Date()); String requestTimestamp = text.substring(0, 22) + ":" + text.substring(22); String encryptString = requestTimestamp + marketoUserId ; SecretKeySpec secretKey = new SecretKeySpec(marketoSecretKey.getBytes(), "HmacSHA1"); Mac mac = Mac.getInstance("HmacSHA1"); mac.init(secretKey); byte[] rawHmac = mac.doFinal(encryptString.getBytes()); char[] hexChars = Hex.encodeHex(rawHmac); String signature = new String(hexChars); // Set Authentication Header AuthenticationHeader header = new AuthenticationHeader(); header.setMktowsUserId(marketoUserId); header.setRequestTimestamp(requestTimestamp); header.setRequestSignature(signature); // Create Request ParamsGetCustomObjects request = new ParamsGetCustomObjects(); request.setObjTypeName("RoadShow"); ArrayOfAttribute arrayOfAttribute = new ArrayOfAttribute(); Attribute attr = new Attribute(); attr.setAttrName("MKTOID"); attr.setAttrValue("1090177"); arrayOfAttribute.getAttributes().add(attr); JAXBElement<ArrayOfAttribute> attributes = new ObjectFactory().createParamsGetCustomObjectsCustomObjKeyList(arrayOfAttribute); request.setCustomObjKeyList(attributes); SuccessGetCustomObjects result = port.getCustomObjects(request, header); JAXBContext context = JAXBContext.newInstance(SuccessGetCustomObjects.class); Marshaller m = context.createMarshaller(); m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true); m.marshal(result, System.out); } catch(Exception e) { e.printStackTrace(); } } } |
Sample Code – Ruby
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
require 'savon' # Use version 2.0 Savon gem require 'date' mktowsUserId = "" # CHANGE ME marketoSecretKey = "" # CHANGE ME marketoSoapEndPoint = "" # CHANGE ME marketoNameSpace = "http://www.marketo.com/mktows/" #Create Signature Timestamp = DateTime.now requestTimestamp = Timestamp.to_s encryptString = requestTimestamp + mktowsUserId digest = OpenSSL::Digest.new('sha1') hashedsignature = OpenSSL::HMAC.hexdigest(digest, marketoSecretKey, encryptString) requestSignature = hashedsignature.to_s #Create SOAP Header headers = { 'ns1:AuthenticationHeader' => { "mktowsUserId" => mktowsUserId, "requestSignature" => requestSignature, "requestTimestamp" => requestTimestamp } } client = Savon.client(wsdl: 'http://app.marketo.com/soap/mktows/2_3?WSDL', soap_header: headers, endpoint: marketoSoapEndPoint, namespaces: namespaces, open_timeout: 90, read_timeout: 90, namespace_identifier: :ns1, env_namespace: 'SOAP-ENV') #Create Request request = { :obj_type_name => "RoadShow", :custom_obj_key_list => { :attribute => { :attr_name => "MKTOID", :attr_value => "1090177" } }, :"include_attributes/" => "" } response = client.call(:get_custom_objects, message: request) puts response |