Upload new media

Upload a single file from your computer to Orange Logic

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

ℹ️

Notes

There are three versions of the Upload Media API:

  • v3.0 is the most robust. It takes all the parameters listed below, and it accepts either a record ID or a unique identifier for the FolderRecordID parameter.
  • v2.0 uses a boolean ProcessAssetInBackground parameter in place of the UploadMode parameter, just like the Upload media API does. It doesn’t take the IgnoreCheckContainer or Metadata query parameters.
  • v1.0 is the most basic. It doesn’t take the UploadMode, IgnoreCheckContainer, or Metadata query parameters.

This API returns standard headers in an APIRequestInfo section.

Query Params
string
required

RecordID of the folder to upload the asset to. If you are using v3.0, you can use the Unique ID or the Record ID.

string
enum
required
Defaults to ProcessInLine

Determines how the upload is processed in the background. Go to Upload processing options for more information.

Allowed:
string
required

A name for the file being uploaded, including the file extension. For example: London Eye.jpg

string
enum
required

The response format.

Allowed:
boolean
Defaults to false

Whether to check that the FolderRecordID represents a container.

  • False: The upload will fail if the FolderRecordID does not represent a folder.
  • True: The file is uploaded to the first container in the hierarchy that includes the asset identified by the FolderRecordID.

Metadata
object

Metadata applied to the uploaded asset.

string
Defaults to yyyy-MM-ddTHH:mm:ss

The output date format

string

An authentication token. If empty, the token included in the current cookie is used.

Body Params
file
required

The file to upload

Headers
string
Defaults to multipart/form-data

The multipart/form-data header parameter is required for this call.

Response

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json