Ingesting Assets

Every asset belongs to a project.

Bulk Ingest

Preparation

The assets must be in STORAGE_TEMP_DIR/import/{shortcode}, a folder named after the Project Shortcode. The assets may be organized in sub-folders inside the import/{shortcode} folder. For example:

import/
    └── 0001/ 
        ├── someImage.jp2
        └── some-sub-folder/
            ├── someText.txt
            …

Triggering a Bulk Ingest

You can trigger a Bulk Ingest with a request to the Bulk Ingest Endpoint. The Bulk Ingest will run in the background, and you can check its status in the logs of the service.

The Bulk Ingest will create a new asset for each valid file in the import/{shortcode}/ folder, and move the file to the STORAGE_ASSET_DIR/{shortcode} folder. It will create relevant derivatives for the asset, such as keyframes for videos or and archival version of images. It will extract the metadata from the file and store it with the asset. Once a file was successfully ingested, it will be deleted from the import/{shortcode}/ folder. Files that are not valid or could not be ingested will be ignored and remain in the import/{shortcode}/ folder unchanged.

Additionally, the Bulk Ingest will create a mapping-{shortcode}.csv CSV file in the {STORAGE_TEMP_DIR}/import folder. This file contains a mapping of the original filenames to the internal_filename of the assets.

original,derivative
someImage.jp2,4lNd38JEiHC-lofT60RQbYm.jp2
some-sub-folder/someText.txt,2hWjjyahcMM-Kkkm8qJpSGk.txt

You can use this mapping to create the respective resource in the DSP-API.

Finalizing a Bulk Ingest

Once you have verified the success of the ingest and/or created the resources in the DSP-API, you should finalize the Bulk Ingest with a request to the Bulk Ingest Finalize Endpoint. The Bulk Ingest will then delete the mapping-{shortcode}.csv file and the import/{shortcode}/ folder and all its content.