FileTransferActivity

The FileTransferActivity object 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

NameData TypeDescription
ClientClientIDSpecifies the account ownership and context of an object.
CorrelationIDxsdIdentifies correlation of objects across several requests.
CreatedDatexsdRead-only date and time of the object's creation.
CustomerKeyxsdUser-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object in Marketing Cloud.
DescriptionxsdDescribes and provides information regarding the object.
IDxsdRead-only identifier for an object. Some objects use the ObjectID property as the Marketing Cloud unique ID.
InteractionObjectIDxsdReturns associated ID for activities within the asynchronous process of the overall conversation or program.
KeywordxsdReserved for future use.
ModifiedDateNullable`1Indicates the last time object information was modified.
NamexsdName of the object or property.
ObjectIDxsdSystem-controlled, read-only text string identifier for object.
ObjectStatexsdReserved for future use.
OwnerOwnerDescribes account ownership of subscriber in an on-your-behalf account.
PartnerKeyxsdUnique identifier provided by partner for an object. This property is accessible only via API.
PartnerPropertiesAPIProperty[]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 on this object accepts the following value and data types:

ValueData Type
FileTransferLocationKeystring
FileTransferLocationIDGUID
PublicKeyManagementKeystring
PublicKeyManagementIdint
FileTransferActivityIDGUID
ClientIDint
OwnerIDint
Namestring
Descriptionstring
CustomerKeystring
FileSpecstring
IsActivebool
IsEncryptedbool
IsCompressedbool
IsSignedbool
Retriesint
RetryIntervalint
MaxFileAgeint
MaxFileAgeScheduleOffsetint
MaxImportFrequencyint
CreatedByint
CreatedDatedatetime
ModifiedByint
ModifiedDatedatetime
IsSequentialbool
IsSuccessfulWithoutFilebool
IsUploadbool
IsPgpbool
MaxAgeUnitFileTransferActivityMaxAgeUnit 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 and data types:

ValueData Type
Typestring
SourceResourceSpecstring
IsCompressedbool
OutputFilenamestring
IsEncryptedbool
Encryptstring
EncryptionKeystring