sfapi-ts

Home > @cjh1/sfapi > StorageService > startTransfer

StorageService.startTransfer() method

Start Transfer Initiate a Globus transfer.

Before calling this method, make sure you have a valid [globus token](https://docs.nersc.gov/services/globus/#generate-a-globus-token-for-use-at-nersc) and have activated the endpoints you want to use.

• **source**: source endpoint UUID - **target**: target endpoint UUID - **outdir**: target endpoint output directory - **infile**: file containing list of full path of input files - **username**: (optional) run this operation as another user (needs special permission)

You can use special UUID-s of “dtn”, “hpss” or “cori”.

Signature:

startTransfer(formData: TransferStorageBody): CancelablePromise<TransferResult>;

Parameters

Parameter	Type	Description
formData	TransferStorageBody

Returns:

CancelablePromise<TransferResult>

TransferResult Successful Response

Exceptions

ApiError