An object that represents an instance of a file transfer activity within an account. Use the perform method on an existing file transfer activity. To start a FileTransferActivity using the perform method, you need the Interactions | Activities | File Transfer | Start permission.
Properties
| Name | Data Type | Description |
|---|---|---|
Client |
ClientID object | Specifies the account ownership and context of an object. |
CorrelationID |
String | Identifies correlation of objects across several requests. |
CreatedDate |
DateTime | The date and time when the object was created. |
CustomerKey |
String | User-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object. |
Description |
String | Describes and provides information regarding the object. |
ID |
Int | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID. |
InteractionObjectID |
String | Returns associated ID for activities within the asynchronous process of the overall conversation or program. |
Keyword |
String | Not used. |
ModifiedDate |
DateTime | The date and time when the object was last modified. |
Name |
String | Name of the object or property. |
ObjectID |
String | System-controlled, read-only text string identifier for object. |
ObjectState |
String | Not used. |
Owner |
Owner object | Describes account ownership of subscriber in an on-your-behalf account. |
PartnerKey |
String | Unique identifier provided by partner for an object. This property is accessible only via API. |
PartnerProperties |
Array of APIProperty objects | A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API. |
PartnerProperties Values
The PartnerProperties property for this object accepts the value and data types listed in this table.
| Value | 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 for this object in a Perform call accepts the value and data types listed in this table.
| Value | Data Type |
|---|---|
| Type | string |
| SourceResourceSpec | string |
| IsCompressed | bool |
| OutputFilename | string |
| IsEncrypted | bool |
| Encrypt | string |
| EncryptionKey | string |