Performs the same action on multiple rows/objects in one SOAP request. For a single object, use proxy.performItem.

Syntax

var result = proxy.performBatch(objectType, propertiesArray, action[, performOptions]);

Parameters

Name Type Required Description
objectType string Yes SOAP API object type
propertiesArray object[] Yes One property object per target row (identify each item, e.g. ObjectID)
action string Yes Must be "Start" (lowercase "start" fails)
performOptions object No SOAP PerformOptions fields

Return value

Object with Status, StatusMessage, RequestID, and Results (one entry per input item when successful).

Example

var proxy = new Script.Util.WSProxy();
var items = [{ ObjectID: id1 }, { ObjectID: id2 }];
var result = proxy.performBatch("QueryDefinition", items, "Start");
Write(result.Status);

See Also