proxy.describe
Retrieve structural metadata for one or more SOAP API object types — useful for exploring available fields and relationships on an API object.
Syntax
var result = proxy.describe(objectType);
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
objectType |
string | string[] | Yes | SOAP API object type name, or an array of type names |
Return Value
An object with two properties:
| Property | Type | Description |
|---|---|---|
RequestID |
string | The SOAP request ID for the call |
Results |
object[] | Array of ObjectDefinition items describing the requested types |
Examples
Describe a single object type
var proxy = new Script.Util.WSProxy();
var result = proxy.describe("DataExtension");
Write(Stringify(result.Results));
Describe multiple object types
var proxy = new Script.Util.WSProxy();
var result = proxy.describe(["DataExtension", "Subscriber"]);
for (var i = 0; i < result.Results.length; i++) {
Write(result.Results[i].ObjectType + "<br>");
}
Notes
Use describe to discover what properties are available on a SOAP API object before building a retrieve or create call. This is especially useful when working with unfamiliar object types.