Retrieve

Retrieve query definitions that match a set of search criteria.

Syntax

Retrieve(1)

Properties

JSON Object Structure for a Basic Search

A simple search contains a single criterion. To perform a simple search, pass a JSON object that contains a Property, a SimpleOperator, and a Value. In some cases, such as when you search for a null value, you can omit the Value.

For example, a simple search can return all query definitions that were modified between January 1, 2025 and February 1, 2025, as shown in this code sample.

{
  Property: "ModifiedDate",
  SimpleOperator: "between",
  Value: ["2025-01-01T00:00:00.000","2025-02-01T00:00:00.000"]
}

JSON Object Structure for a Complex Search

A complex search contains two criteria that are connected with AND or OR logic. To perform a complex search, pass a JSON object that contains a LeftOperand object, a LogicalOperator, and a RightOperand object.

The LeftOperand and RightOperand objects both contain the same content: a Property, a SimpleOperator, and a Value.

The value of LogicalOperator is either AND or OR, depending on the type of logic that you want to use to connect the two operands.

This sample shows a complex search that returns active query definitions where the name of the query definition begins with the phrase "LoyaltyRewards."

{
  LeftOperand: {
    Property: "Status",
    SimpleOperator: "equals",
    Value: "Active"
  },
  LogicalOperator: "AND",
  RightOperand: {
    Property: "Name",
    SimpleOperator: "like",
    Value: "LoyaltyRewards%"
  }
}

Property

The Property contains the name of the field to perform the search in. For example, to search for query definitions based on their name, specify Name. This table lists several common properties.

SimpleOperator

For the SimpleOperator property, specify the comparison that you want to perform between the Property and the Value. This table lists the comparisons that you can perform.

Value

For the Value property, specify the value that you want to search for. You can omit the Value property if the value of the SimpleOperator property is isNull or isNotNull.

Usage

This sample code retrieves all active query definitions.

<script runat="server">
  Platform.Load("Core","1");

  try {
    var result = QueryDefinition.Retrieve({
        Property:"Status",
        SimpleOperator:"equals",
        Value:"Active"
    });

    Write(Stringify(result));
  } catch (e) {
    Write(Stringify(e));
  };
</script>

The response is an array of objects. Each object in the array represents a query definition that meets the search criteria.

[
  {
    "Name": "Staging_Clear",
    "ObjectID": "1510cbd5-0d53-4259-a1c1-99dc7654be09",
    "QueryText": "select 'w@w.com' as [Email], 'test' as [Link], 'test' as [Version], 'test' as [Product] where 1 = 2",
    "TargetType": "DE",
    "DataExtensionTarget": {
      "Name": "Staging",
      "Description": "Used to store data for send",
      "Keyword": null,
      "Client": null,
      "PartnerKey": null,
      "PartnerProperties": null,
      "CreatedDate": "0001-01-01T00:00:00.000",
      "CreatedDateSpecified": false,
      "ModifiedDate": null,
      "ModifiedDateSpecified": false,
      "ID": 0,
      "IDSpecified": false,
      "ObjectID": null,
      "CustomerKey": "Staging",
      "Owner": null,
      "CorrelationID": null,
      "ObjectState": null,
      "IsPlatformObject": false,
      "IsPlatformObjectSpecified": false
    },
    "TargetUpdateType": "Overwrite",
    "FileSpec": "",
    "FileType": "",
    "Status": "Active",
    "CategoryID": 0,
    "CategoryIDSpecified": false,
    "InteractionObjectID": null,
    "Description": "Clears the Staging DE after a send",
    "Keyword": null,
    "Client": null,
    "PartnerKey": null,
    "PartnerProperties": null,
    "CreatedDate": "2011-12-20T08:02:17.437",
    "CreatedDateSpecified": true,
    "ModifiedDate": "2011-12-20T08:02:17.437",
    "ModifiedDateSpecified": true,
    "ID": 0,
    "IDSpecified": false,
    "CustomerKey": "Staging_Clear",
    "Owner": null,
    "CorrelationID": null,
    "ObjectState": null,
    "IsPlatformObject": false,
    "IsPlatformObjectSpecified": false
  }
]