InvokeRetrieve
→ object[]Executes a SOAP Retrieve operation to retrieve SFMC objects. Typically used with CreateObject and filter configuration.
Available in:
Email
CloudPage
Automation
Triggered Send
Syntax
Platform.Function.InvokeRetrieve(object)
1 argument
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
object |
object | Yes | Configured Retrieve request object |
Examples
var req = Platform.Function.CreateObject("RetrieveRequest");
Platform.Function.SetObjectProperty(req, "ObjectType", "DataExtensionObject[MyDE]");
Platform.Function.SetObjectProperty(req, "Properties", ["Email", "FirstName"]);
var filter = Platform.Function.CreateObject("SimpleFilterPart");
Platform.Function.SetObjectProperty(filter, "Property", "Status");
Platform.Function.SetObjectProperty(filter, "SimpleOperator", "equals");
Platform.Function.SetObjectProperty(filter, "Value", "Active");
Platform.Function.SetObjectProperty(req, "Filter", filter);
var results = Platform.Function.InvokeRetrieve(req);
WSProxy.retrieve() is simpler and preferred for new code.