v1

latestOpenAPI 3.1.02026-07-24440202.2 KB

Step 1: Create an upload transaction

Create an upload transaction ID and begin an upload session

post/transaction/24_v1

Request body

targetFolderIDstring

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

keepFolderStructureboolean

Whether to retain your folder structure. When <code>true</code>, the assets are uploaded with their original local folder structure.

mappingTemplateIdstring

The Orange Logic Import Mapping Template API ID. <br> <strong>Note</strong>: <ul> <li>To find the API ID of an import mapping template, go to <strong>Admin</strong> > <strong>Archives</strong> > <strong>Manage Import Mapping Templates</strong> and open the template. The <strong>API ID</strong> is in the <strong>Edit import mapping template</strong> window. </li> </ul>

noMappingTemplateboolean

When <code>true</code>, you are using a mapping template. </br> When <code>false</code>, you are not using a mapping template.

uploadMethod'CortexTools' | 'Web' | 'Agent' | 'DropBox' | 'Ftp' | 'Getty'

Used to categorize the upload requests and pass them to the client uploader app you want to use. The options are: CortexTools, Web, Agent, DropBox, Ftp, and Getty. However, your organization may not have all of these upload options.

useCacheboolean

If available, use a cached transaction.

clearanceLevelinteger

The security clearance that will be added to the created asset’s Security Clearance field. Security clearances are an optional layer of asset protection in addition to permissions. Orange Logic users with a Link account can go to the <a href="https://link.orangelogic.com/CMS4/Permalinks/2P7YOHNZQ04H" target="_blank">security clearance</a> article to learn more.

Response

200

transactionIdstring

Example response

{
  "transactionId": "2RBKMYFLD3UY"
}