File upload API

Upload a new file using a multipart request to specify destination and file information.

Note:

File names are not case-sensitive; that is, File_Name and file_name are considered identical. Two files cannot have the same name in a given folder.

By default, if a file with the same name exists in the target destination, the uploaded file replaces the existing file as a new revision.

The request is a multipart HTTP request where one part is a JSON object (jsonInputParameters) with the parentID and the other part is the content of the file itself (primaryFile). It is also possible to set metadata values using another JSON object (metadataValues).

• accessToken(optional): string

  Applink access token authorizing the current user to access the parent folder. This parameter is mandatory if appLinkID is used. It can be used as accessToken or AccessToken.

• appLinkID(optional): string

  Applink ID authorizing the current user to access the parent folder. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. To work, this applink must have at least the contributor role granted. It can be used as appLinkID or AppLinkID.

• dAccessCode(optional): string

  Access code needed to use protected public links. It needs to be sent as part of a Cookie header in the following format: dAccessCode-<linkID>=<passcodeValue>

• linkID(optional): string

  Public link ID of a public link authorizing the current user to access this file. To work, this public link must have the contributor role granted. It can be used as linkID or LinkID.

• jsonInputParameters: string

  You can use this parameter to include the parentID parameter and the duplicateResolution parameter as a JSON payload with the request. This parameter must come before the primaryFile parameter.

  Set parentID to the globally unique identifier (GUID) of the folder to upload the file to.

  The parentID parameter must be sent as a part of this JSON payload. This parameter is required.

  For example:{

  "parentID ": "FB4CD874EF94CD2CC1B60B72T"

  }

  Also, to resolve any conflict with duplicate file names, you can set duplicateResolution to TimeStampSuffix.

  The duplicateResolution parameter can be sent as a part of this JSON payload. This parameter is optional.

  For example:{

  "parentID ": "FB4CD874EF94CD2CC1B60B72T",

  "duplicateResolution ": "TimeStampSuffix"

  }
• metadataValues(optional): string

  You can use this parameter to set metadata values to a collection already assigned to any parent folder. The rules are the same as those applied to the set metadata values REST API. Use Content-Type: application/json to describe this information as a JSON object.

  For example:

  {

  "collection ": "CollectionA",

  "fieldA ": "valueA",

  "fieldB ": "valueB",

  "fieldC ": "valueC"

  }
• primaryFile: file
  File to upload. This must come after the jsonInputParameters parameter.

201 Response

400 Response

403 Response

404 Response