file-transfers

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as IEnumerable<FileTransferDto>.

Field	Declared type	Nullable
Id	Guid	no
Code	string	no
Name	string	no
SourceFileStorageId	Guid	no
SourcePath	string	no
SourcePathWildcard	string	no
DestinationFileStorageId	Guid?	yes
DestinationPath	string	no
IsZip	bool?	yes
CanArchive	bool?	yes
ArchiveFileStorageId	Guid?	yes
ArchivePath	string	no
OverwriteType	int?	yes

Member names are the service's declaration names.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.

Field	Name on the wire	Declared type	Nullable
Id	id	Guid	no

Member names are the service's declaration names.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as FileTransferDto.

Field	Declared type	Nullable
Id	Guid	no
Code	string	no
Name	string	no
SourceFileStorageId	Guid	no
SourcePath	string	no
SourcePathWildcard	string	no
DestinationFileStorageId	Guid?	yes
DestinationPath	string	no
IsZip	bool?	yes
CanArchive	bool?	yes
ArchiveFileStorageId	Guid?	yes
ArchivePath	string	no
OverwriteType	int?	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
ERR_FILE_15	400	FILE_TRANSFER_CODE_IS_NOT_FOUND	File transfer code is not found

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
ERR_FILE_15	400	FILE_TRANSFER_CODE_IS_NOT_FOUND	File transfer code is not found
ERR_FILE_19	400	THERE_IS_ALREADY_EXIST_FILE_WITH_THIS_NAME	There is already exist file with this name
ERR_FILE_20	400	FILES_NOT_FOUND	Files not found
ERR_FILE_6	400	ARCHIEVE_FILE_STORAGE_ID_MUST_BE_NOT_NULL	Archive file storage ID must be not null
ERR_FILE_8	400	DESTINATION_FILE_STORAGE_ID_MUST_BE_NOT_NULL	Destination file storage ID must be not null

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as FileTransferDto.

Field	Declared type	Nullable
Id	Guid	no
Code	string	no
Name	string	no
SourceFileStorageId	Guid	no
SourcePath	string	no
SourcePathWildcard	string	no
DestinationFileStorageId	Guid?	yes
DestinationPath	string	no
IsZip	bool?	yes
CanArchive	bool?	yes
ArchiveFileStorageId	Guid?	yes
ArchivePath	string	no
OverwriteType	int?	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
ERR_FILE_14	400	FILE_TRANSFER_ID_IS_NOT_FOUND	File transfer ID is not found

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
ERR_FILE_14	400	FILE_TRANSFER_ID_IS_NOT_FOUND	File transfer ID is not found

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
ERR_FILE_14	400	FILE_TRANSFER_ID_IS_NOT_FOUND	File transfer ID is not found

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as IEnumerable<FileTransferHistoryDto>.

Field	Declared type	Nullable
Id	Guid	no
BeginDate	DateTime?	yes
CompletedDate	DateTime?	yes
FileName	string	no
FileSize	int?	yes
Status	int	no
ErrorDescription	string	no

Member names are the service's declaration names.