v1

latestOpenAPI 3.1.02026-07-24440202.2 KB

Upload new media

Upload a single file from your computer to Orange Logic

post/v3.0/UploadNewMedia

Query parameters

FolderRecordIDstring required

<a href="https://developer.orangelogic.com/reference/assets#record-id">RecordID</a> of the folder to upload the asset to. If you are using v3.0, you can use the Unique ID or the Record ID.

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

Determines how the upload 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.

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.

IgnoreCheckContainerboolean

Whether to check that the FolderRecordID represents a container.<ul><li><code>False</code>: The upload will fail if the FolderRecordID does not represent a folder.</li><li><code>True</code>: The file is uploaded to the first container in the hierarchy that includes the asset identified by the FolderRecordID.</ul>

[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 forma</a>t

Tokenstring

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

Headers

Content-Typestring

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

Request body

InputStreamstring binary required

The file to upload

Response

200

Example response

{
  "APIRequestInfo": {
    "ProviderVersion": "MILAN.R4.2162P.218145",
    "ProviderIdentity": "OLU-T-USW2-APP",
    "ProviderID": "44ddde3ac27a33c394335f249d4007d4",
    "Module": "UploadMedia",
    "APIVersion": "v3.0",
    "Resource": "UploadNewMedia",
    "IsLoggedIn": true,
    "Status": "LoggedIn",
    "Session": "No session (production configuration)",
    "TimeoutPeriodMinutes": 120
  },
  "APIResponse": {
    "RequestInterpretation": {
      "ParametersInformation": {
        "FolderRecordID": {
          "Value": "ZZ1282Z",
          "ValueCount": 1
        },
        "InputStream": {
          "Value": "Binary data"
        },
        "FileName": {
          "Value": "Mangovations.png",
          "ValueCount": 1
        },
        "UploadMode": {
          "Value": "ProcessInLine",
          "ValueCount": 1
        },
        "IgnoreCheckContainer": {
          "Value": "false",
          "IsOptional": true,
          "ValueCount": 1
        },
        "Metadata": {
          "Value": "{&quot;CoreField.Title&quot;:&quot;Mangovations logo&quot;, &quot;CoreField.Description&quot;: Approved logo for 2025&quot;}",
          "IsOptional": true,
          "ValueCount": 1
        }
      }
    },
    "ExecutionStatus": "Executed",
    "HTTPCode": 200,
    "Code": "SUCCESS",
    "SystemIdentifier": "ZZ1409J"
  }
}