FilterDefinition

From $1

    Table of contents
    1. 1. Definition
    2. 2. Properties
    3. 3. Description
    4. 4. Methods
    5. 5. Use Cases
    Doc-Wiki-BannerHK.png

    (Click the banner to go to the related Docs.Code.ExactTarget.com page.)

    Definition

    Defines an audience based on specified rules in a filter.

    Properties

    This object has following properties.

    NameData TypeDescription
    ClientClientIDSpecifies the account ownership and context of an object.
    CorrelationIDxsd:stringIdentifies correlation of objects across several requests.
    CreatedDatexsd:dateTimeRead-only date and time of the object's creation.
    CustomerKeyxsd:stringUser-supplied unique identifier for an object within an object type (corresponds to the external key assigned to an object in the user interface).
    DataFilterFilterPartFilter parts for a filter definition
    DataSourceAPIObjectSource of data (such as a data extension or list) referred to by API as part of a filter definition
    Descriptionxsd:stringDescribes and provides information regarding the object.
    IDxsd:intRead-only legacy identifier for an object. Not supported on all objects. Some objects use the ObjectID property as the ExactTarget unique ID.
    ModifiedDateNullable`1Indicates the last time object information was modified.
    Namexsd:stringName of the object or property.
    ObjectIDxsd:stringSystem-controlled, read-only text string identifier for object.
    ObjectStatexsd:stringReserved for future use.
    OwnerOwnerDescribes account ownership of subscriber in an on-your-behalf account.
    PartnerKeyxsd:stringUnique identifier provided by partner for an object, accessible only via API.
    PartnerPropertiesAPIProperty[]A collection of metadata supplied by client and stored by system - only accessible via API.

    Description

    This objects supports both subscriber lists and data extensions. The associated DataFilter property specifies the rules for the filter, although these rules cannot be specified hierarchically.

    Methods

    This object has the following methods.

    NameDescription
    CreateCreates an individual object or a batch of objects.
    DeleteDeletes an individual object or a batch of objects.
    RetrieveRetrieves an individual object or a batch of objects.
    UpdateUpdates an individual object or a batch of objects.

    Use Cases


    This page was last updated by Ryan Williams on Fri, 06 Jan 2012 21:32:51 GMT.

    If you require assistance with the ExactTarget application, please contact Global Support. If you wish to send Ryan direct feedback, fill out the form below:

     


    Was This Page Helpful?
    Suggestions or Comments:
    Name (optional):
    Email Address (optional):
    Enter 24910 backwards:
       
    Tags: (Edit tags)
    • No tags
     
    Comments (0)
    You must login to post a comment.

     
    Powered by MindTouch 2010
    Admin