Step 1: Create an upload transaction

post https://{OrangeLogicURL}/webapi/mediafile/import/upload/transaction/24_v1

Create an upload transaction ID and begin an upload session

Before uploading assets to the Orange Logic platform, you need to create an upload transaction ID for your upload session. In this step, you’ll also define which folder to upload the assets to and specify any metadata you want to add to the assets as they’re uploaded.

This page shows the POST method, but you can also use GET.

Response

This call returns the Upload Transaction ID as transactionID. You’ll use this ID in subsequent calls.

Body Params

targetFolderID

string

The Record ID of the folder you want to upload to.

keepFolderStructure

boolean

Defaults to true

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

mappingTemplateId

string

The Orange Logic Import Mapping Template API ID.
Notes:

To find the API ID of an import mapping template, go to Admin > Archives > Manage Import Mapping Templates and open the template. The API ID is in the Edit import mapping template window.
Go to the Import mapping templates article to learn more.

noMappingTemplate

boolean

Defaults to true

When true, you are using a mapping template.
When false, you are not using a mapping template.

metadata

object

Metadata to apply to all assets included in the upload transaction.

uploadMethod

string

Defaults to CortexTools

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.

useCache

boolean

Defaults to true

If available, use a cached transaction.

clearanceLevel

int32

The security clearance that will be added to the created asset’s Security Clearance field. For more information go to the security clearance article.

Response

Language

Credentials

OAuth2

URL


xxxxxxxxxx
12
1
curl --request POST \
2
     --url https://orangelogicurl/webapi/mediafile/import/upload/transaction/24_v1 \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "keepFolderStructure": true,
8
  "noMappingTemplate": true,
9
  "uploadMethod": "CortexTools",
10
  "useCache": true
11
}
12
'

Choose an example:

application/json

Response

200200