(Click the banner to go to the related Docs.Code.ExactTarget.com page.)
Definition
Represents an instance of a file transfer activity within an account.
Properties
This object has following properties.
| Name | Data Type | Description |
|---|
| Client | ClientID | Specifies the account ownership and context of an object. |
| CorrelationID | xsd:string | Identifies correlation of objects across several requests. |
| CreatedDate | xsd:dateTime | Read-only date and time of the object's creation. |
| CustomerKey | xsd:string | User-supplied unique identifier for an object within an object type (corresponds to the external key assigned to an object in the user interface). |
| Description | xsd:string | Describes and provides information regarding the object. |
| ID | xsd:int | Read-only legacy identifier for an object. Not supported on all objects. Some objects use the ObjectID property as the ExactTarget unique ID. |
| InteractionObjectID | xsd:string | Returns associated ID for activities within the asynchronous process of the overall conversation or program. |
| Keyword | xsd:string | Reserved for future use. |
| ModifiedDate | Nullable`1 | Indicates the last time object information was modified. |
| Name | xsd:string | Name of the object or property. |
| ObjectID | xsd:string | System-controlled, read-only text string identifier for object. |
| ObjectState | xsd:string | Reserved for future use. |
| Owner | Owner | Describes account ownership of subscriber in an on-your-behalf account. |
| PartnerKey | xsd:string | Unique identifier provided by partner for an object, accessible only via API. |
| PartnerProperties | APIProperty[] | A collection of metadata supplied by client and stored by system - only accessible via API. |
Description
This object represents an activity created within the user interface. At this time, you cannot retrieve, update, or delete a file transfer activity via the API. You can use the Create call or use the Perform method on an existing file transfer activity.
The PartnerProperties property on this object in a Create call accepts the following value/data types:
| Value Type | Data Type |
| FileTransferLocationKey | string |
| FileTransferLocationID | GUID |
| PublicKeyManagementKey | string |
| PublicKeyManagementId | int |
| FileTransferActivityID | GUID |
| ClientID | int |
| OwnerID | int |
| Name | string |
| Description | string |
| CustomerKey | string |
| FileSpec | string |
| IsActive | bool |
| IsEncrypted | bool |
| IsCompressed | bool |
| IsSigned | bool |
| Retries | int |
| RetryInterval | int |
| MaxFileAge | int |
| MaxFileAgeScheduleOffset | int |
| MaxImportFrequency | int |
| CreatedBy | int |
| CreatedDate | datetime |
| ModifiedBy | int |
| ModifiedDate | datetime |
| IsSequential | bool |
| IsSuccessfulWithoutFile | bool |
| IsUpload | bool |
| IsPgp | bool |
| MaxAgeUnit | FileTransferActivityMaxAgeUnit enumeration |
Currently, 0-Hour is the only valid enumeration for MaxAgeUnit.
The PartnerProperties property on this object in a Perform call accepts the following value/data types:
| Value Type | Data Type |
| Type | string |
| SourceResourceSpec | string |
| IsCompressed | bool |
| OutputFilename | string |
| IsEncrypted | bool |
| Encrypt | string |
| EncryptionKey | string |
Methods
This object has the following methods.
| Name | Description |
|---|
| Create | Creates an individual object or a batch of objects. |
| Perform | Method description goes here. |
| Update | Updates an individual object or a batch of objects. |
This page was last updated by Ryan Williams on Fri, 06 Jan 2012 21:36: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:
You are not logged in. Log in 
