Sign in

v1

latestOpenAPI 3.1.02026-07-24440202.2 KB

Upload new version

Upload a single file from your computer to Orange Logic as a new version of an existing asset

post/v2.0/UploadNewVersion

Query parameters

AssetRecordIDstring required

The asset's <a href="https://developer.orangelogic.com/reference/assets#record-id">RecordID or unique identifier</a>. The file you upload will be a new version of this asset.

FileNamestring required

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

Format'XML' | 'JSON' required

The response format.

UploadMode'processInLine' | 'ProcessProxiesInBackground' | 'ProcessFullyInBackgroundLite' | 'ProcessFullyInBackground' | 'ProcessProxiesAndParentAndIndexInBackground'

Determines whether the update is processed in the background. Go to <a href="https://developer.orangelogic.com/reference/upload#upload-processing-options">Upload processing options</a> for more information.

[Custom_Metadata]string

Enter a comma-separated list of field name and value pairs, enclosed in curly brackets <code>{}</code><br>Example: <code>{"CoreField.Title":"New asset title", "MyNameSpace.MyField":"Custom field value"}</code>

<a href="https://developer.orangelogic.com/reference/metadata-field-identifiers">Metadata</a> applied to the uploaded asset.

dateformatstring

The output <a href="https://developer.orangelogic.com/reference/date-and-time">date format</a>.

Tokenstring

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

Headers

Content-Typestring required

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

Request body

InputStreamstring binary required

The file to upload.<br><br><span style="color: #46B8DA">ℹ️ Note</span> This file must be encoded as multipart/form-data. This call does not support base64-encoded strings.

Response

200

Example response

{
  "APIRequestInfo": {
    "ProviderVersion": "MILAN.R4.2162P.218145",
    "ProviderIdentity": "OLU-T-USW2-APP",
    "ProviderID": "44ddde3ac27a33c394335f249d4007d4",
    "Module": "UploadMedia",
    "APIVersion": "v2.0",
    "Resource": "UploadNewVersion",
    "IsLoggedIn": true,
    "Status": "LoggedIn",
    "UserLogin": "jennifer.fance@orangelogic.com",
    "Session": "Jen Demo",
    "TimeoutPeriodMinutes": 120
  },
  "APIResponse": {
    "RequestInterpretation": {
      "ParametersInformation": {
        "AssetRecordID": {
          "Value": "ZZ14283",
          "ValueCount": 1
        },
        "InputStream": {
          "Value": "Binary data"
        },
        "FileName": {
          "Value": "Parliament building in Ottawa.png",
          "ValueCount": 1
        },
        "UploadMode": {
          "IsOptional": true
        },
        "Metadata": {
          "Value": "{&quot;CoreField.Title&quot;:&quot;Parliament building&quot;, &quot;CoreField.Description&quot;:&quot;Parliament building on a sunny day in Ottawa&quot;}",
          "IsOptional": true,
          "ValueCount": 1
        }
      }
    },
    "Response": {
      "AssetVersion": 2
    },
    "ExecutionStatus": "Executed",
    "HTTPCode": 200,
    "Code": "SUCCESS"
  }
}