Retrieve an Item from Your Portfolio

Marketing Cloud Engagement has a new model for storing, finding, managing, creating, sharing, and distributing all content-related objects. Access the objects created with the new Content Builder tools using the REST API. Your existing SOAP API integrations only function with the Classic tools.

This page contains information regarding retrieving an object from your account’s Portfolio.

Why Retrieve an Item from Your Portfolio 

You can use the Retrieve method to find out more information about and use those items in email sends and other activities.

How to Retrieve an Item from Your Portfolio 

Use the sample code below as a model for your own API call.

Sample .NET Code 

1private void RetrievePortfolio()
2{
3SoapClient framework = new SoapClient();
4framework.ClientCredentials.UserName.UserName = "xxx";
5framework.ClientCredentials.UserName.Password = "xxx";
6String requestID;
7String status;
8SimpleFilterPart sfp = new SimpleFilterPart();
9sfp.Property = "CustomerKey";
10sfp.SimpleOperator = SimpleOperators.equals;
11sfp.Value = new string[] { "Parka Guy" };
12RetrieveRequest rr = new RetrieveRequest();
13rr.ObjectType = "Portfolio";
14rr.Properties = new string[] { "FileURL", "CustomerKey", "FileName", "IsUploaded" };
15rr.Filter = sfp;
16APIObject[] results;
17status = framework.Retrieve(rr, out requestID, out results);
18Console.WriteLine(status);
19if (status.ToUpper() == "OK")
20{
21foreach (Portfolio p in results)
22{
23Console.WriteLine("FileName: " + p.FileName);
24Console.WriteLine("IsUploaded: " + p.IsUploaded);
25Console.WriteLine("FileURL: " + p.FileURL);
26}
27}
28}

Sample Java Code (Axis 1.4) 

1public void testFileDetails() {
2    try {
3        Soap stub = init();
4        RetrieveRequest retrieveRequest = new RetrieveRequest();
5        retrieveRequest.setObjectType("Portfolio");
6        String[] stringArray = { "FileName", "IsUploaded", "FileURL"};
7        retrieveRequest.setProperties(stringArray);
8        RetrieveRequestMsg retrieveRequestMsg = new RetrieveRequestMsg();
9        retrieveRequestMsg.setRetrieveRequest(retrieveRequest);
10        retrieveRequest.setQueryAllAccounts(true);
11        SimpleFilterPart filter = new SimpleFilterPart();
12        filter.setProperty("FileName");
13        filter.setSimpleOperator(SimpleOperators.equals);
14        java.util.List filterValues = new ArrayList();
15        filterValues.add(new String("Test1.jpg"));
16        filter.setValue((String[]) filterValues.toArray(new String[filterValues.size()]));
17        retrieveRequest.setFilter(filter);
18        RetrieveResponseMsg retrieveResponseMsg = stub.retrieve(retrieveRequestMsg);
19        System.out.println("[overall status message] " + retrieveResponseMsg.getOverallStatus());
20        APIObject[] apiObjectList = retrieveResponseMsg.getResults();
21        List<APIObject> list1 =Arrays.asList(apiObjectList);
22        Iterator it = list1.iterator();
23        while (it.hasNext()) {
24            Portfolio o = (Portfolio) it.next();
25            System.out.println("FileLocation ::: " + o.getFileName());
26        }
27    } catch (RemoteException e) {
28        e.printStackTrace();  //To change body of catch statement use File | Settings | File Templates.
29    }

Sample SOAP Envelope 

1<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
2<soapenv:Header>
3    <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
4        <wsse:UsernameToken wsu:Id="UsernameToken-24440876" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
5        <wsse:Username>XXXXX</wsse:Username>
6        <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">XXXXX</wsse:Password>
7        </wsse:UsernameToken>
8    </wsse:Security>
9</soapenv:Header>
10<soapenv:Body>
11    <RetrieveRequestMsg xmlns="http://exacttarget.com/wsdl/partnerAPI">
12        <RetrieveRequest>
13        <ObjectType>Portfolio</ObjectType>
14        <Properties>RowObjectID</Properties>
15        <Properties>ObjectID</Properties>
16        <Properties>PartnerKey</Properties>
17        <Properties>CustomerKey</Properties>
18        <Properties>Client.ID</Properties>
19        <Properties>CategoryID</Properties>
20        <Properties>FileName</Properties>
21        <Properties>DisplayName</Properties>
22        <Properties>Description</Properties>
23        <Properties>TypeDescription</Properties>
24        <Properties>IsUploaded</Properties>
25        <Properties>IsActive</Properties>
26        <Properties>FileSizeKB</Properties>
27        <Properties>ThumbSizeKB</Properties>
28        <Properties>FileWidthPX</Properties>
29        <Properties>FileHeightPX</Properties>
30        <Properties>FileURL</Properties>
31        <Properties>ThumbURL</Properties>
32        <Properties>CacheClearTime</Properties>
33        <Properties>CategoryType</Properties>
34        <Properties>CreatedDate</Properties>
35        <Properties>CreatedBy</Properties>
36        <Properties>ModifiedBy</Properties>
37        <Properties>ModifiedDate</Properties>
38        <Properties>ModifiedByName</Properties>
39        <Filter xsi:type="ns1:SimpleFilterPart" xmlns:ns1="http://exacttarget.com/wsdl/partnerAPI">
40            <Property>CustomerKey</Property>
41            <SimpleOperator>equals</SimpleOperator>
42            <Value>header_image_01</Value>
43        </Filter>
44        </RetrieveRequest>
45    </RetrieveRequestMsg>
46</soapenv:Body>
47</soapenv:Envelope>

Related Items