Sign in

v1

latestOpenAPI 3.1.02026-07-24440202.2 KB

Step 2: Register upload assets

Register each asset you’ll upload as part of the transaction created in the previous step

post/register_25_v1

Request body

transactionIdstring required

The transaction ID created with the <a href="https://developer.orangelogic.com/reference/create-upload-transaction">Create Upload Transaction API</a> in Step 1.

folderRecordIDstring

The <a href="https://developer.orangelogic.com/reference/assets#record-id">Record ID</a> of the folder you’ll upload the asset to.

uploaderNamestring

Name of the upload method you’re using.

skipValidityboolean

When <code>false</code>, OrangeDAM runs a validity check on files to prevent user errors and ensure they are safe to process. When <code>true</code>, OrangeDAM skips this check.

updateIncompleteUIboolean

This parameter is currently unused.

clientIDstring

The user RecordID for web upload. <br/> This parameter is set by the client uploader application. You do not need to enter anything in this parameter.

cloudCompatibleboolean

When <code>false</code>, upload files are sent to the local buffer (the server that hosts the web application) and cannot use a cloud bucket as a buffer. </br> When <code>true</code>, upload files can use a cloud bucket as a buffer. To use a cloud buffer, there are some constraints depending on the cloud service provider. For example, for Amazon S3 the chunk size must be: <ul> <li>Constant for all the chunks (except the last chunk).</li> <li>Between 5MB and 5GB (no min size for the last chunk).</li> <li>The asset can contain no more than 10,000 chunks.</li> </ul>

Response

200

Example response

{
  "files": [
    {
      "status": "ToUpload",
      "uploadItemId": "2RBKM47GUS5M",
      "requestedFileName": "Season 1 trailer.mp4",
      "requestedFileSize": 85997454
    }
  ]
}