POST api/file/uploadsftp/{id}?connectionID={connectionID}&filename={filename}&creator={creator}&description={description}
Uploads a file from an external SFTP server into the system under a specified destination node.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The internal node ID of the destination container (e.g., folder, workbox). If negative, the file is considered unstructured (e.g., profile picture). |
integer |
Required |
| connectionID |
The ID of the configured SFTP connection to use for downloading the file. Must correspond to a valid and active connection in the system. |
integer |
Required |
| filename |
The name of the file to download from the SFTP server. Must match an existing file at the configured SFTP location. |
string |
Required |
| creator |
Optional username of the file creator. If not provided, the authenticated user's name is used. |
string |
Default value is |
| description |
Optional description of the uploaded file. |
string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
On success: HTTP 201 Created with the metadata of the newly uploaded file. On failure: HTTP 400 Bad Request with an error message, or 403 Forbidden if access is denied.
IHttpActionResultNone.
Response Formats
application/json, text/json, application/scim+json
Sample not available.