InvokeExtract
→ stringInvokes the SOAP API Extract method on a configured API object. Used for data extract operations such as generating export files.
Available in:
Email
CloudPage
Automation
Triggered Send
Syntax
Platform.Function.InvokeExtract(apiObject, statusArray[, options])
2–3 arguments
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
apiObject |
object | Yes | SOAP API object built with CreateObject and configured with SetObjectProperty |
statusArray |
array | Yes | Array that receives the status and RequestID of the API call |
options |
object | No | Additional API configure options; may be null |
Examples
var extractDef = Platform.Function.CreateObject("DataExtractDefinition");
Platform.Function.SetObjectProperty(extractDef, "CustomerKey", "MyExtractDef");
var statusArr = [];
var result = Platform.Function.InvokeExtract(extractDef, statusArr, null);
Write("Result: " + result);
Write("Request ID: " + statusArr[1]);
WSProxy is the recommended approach for most SOAP API interactions. Use InvokeExtract only when the Extract SOAP verb is specifically required for your operation.