Simple File Upload

Simple Upload is meant for uploading files of size 5 GB or smaller. The Ingestion API performs a simple upload in three basic steps:

1. Initiate a transaction: While initiating a transaction, the user token is authenticated and authorized. When it is successfully authorized, the API returns a Transaction ID that is the unique identifier for this upload.

2. Upload files: After Transaction ID is received, the user can now use this Transaction ID to upload files. Multiple files can be uploaded as a part of the same transaction. Every file must have a set of API request parameters defined in the section Ingestion API Request Parameters, that enable orchestration to understand the type of processing required for this file. Once it is successfully called, Ingestion API returns a pre-signed S3 URL for each file in the transaction. The actual file is then put into this pre-signed S3 URL.

   To upload files of size 5 GB or smaller, you can use the Simple Upload API. To upload files above the size 5 GB, you must use the Multipart Upload API.

3. Complete the transaction: Once all the files are successfully uploaded into their respective S3 URLs, the transaction can now be closed.

For each of these steps, an endpoint has been created in the API. To perform these steps, the Ingestion API provides respective endpoints:

• /api/load/init - Initiate a new transaction.

• /api/load/uploadurl - Get S3 presigned URLs to upload files.

• /api/load/complete - Complete the transaction.

This Load API internally has the following three calls in sequence:

Initiate a New Load

/api/load/init – Initiate a new load.

This endpoint returns a new Transaction ID to be used for the subsequent API calls.

HEADERS

You must pass the following two headers as described below:

• Authorization

  You must pass a valid CONNECT Bearer JWT token.

• Transaction ID

This is optional. You may pass the Transaction ID in the Header.

REQUEST BODY

Example Value

{

"assetId": "string"

}

RESPONSES

Get the Upload URL

/api/load/uploadurl – Get the redirect URL for uploading the file.

This endpoint returns the redirect URL for uploading the file. The number of redirect URLs varies based on the number of files required to be uploaded.

Notes:

• The redirect URL is valid for one hour only.

• You must write your own code to upload your files depending on the redirect URL you have received.

Each load can have multiple files and you can call the API once or multiple times by providing details of one or more files in the Request Body and passing the appropriate headers.

HEADERS

You must pass the following two headers:

• Authorization

  This is a valid CONNECT Bearer JWT token.

• Transaction ID

  This is generated as part of the init API request.

REQUEST BODY

Example Value

[{

"target": "string",

"source": "string",

"publishOriginal": true,

"publishRendition": true,

"publishReference": true,

"documentIdentifier": "string",

"context": "string",

"additionalMetadata": {

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

},

"fileName": "string",

"registerIdentifier": "string"

}]

RESPONSES

Complete the load

/api/load/complete – Complete the load.

This endpoint is used to either complete or abort the load which is started as part of the init API request.

When you choose to complete the load, the orchestration happens. When you choose to abort the load process, no orchestration happens.

HEADERS

You must pass the following two headers:

• Authorization

  This is a valid CONNECT Bearer JWT token.

• Transaction ID

  This is generated as part of the init API request.

REQUEST BODY

{

"status": "completed"

}

RESPONSES