Generate or regenerate proxies

get

https://{OrangeLogicURL}/api/Media_DbBO/v1.0/RegenerateProxiesForAsset

Generate or regenerate specific asset proxies

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Example 1: Generate a proxy for one asset

'https://university1.orangelogic.com/api/Media_DbBO/v1.0/RegenerateProxiesForAsset?AssetIdentifier=ZZ12P07&FileFormat=CMS1&DocType=Image' \

Example 2: Regenerate proxies for multiple assets

https://university1.orangelogic.com/api/Media_DbBO/v1.0/RegenerateProxiesForAsset?AssetIdentifier=ZZ12PAM%2CZZ12PAW%2CZZ12PAQ&FileFormat=TR7&DocType=Image&Priority=-100

Example 3: Generate new proxies for a subtype

https://university1.orangelogic.com/api/Media_DbBO/v1.0/RegenerateProxiesForAsset?AssetIdentifier=*&FileFormat=WebHigh&Priority=-100&GenerateOnlyIf=TheFormatDoesntExist&DocType=Video

Query Params

AssetIdentifier

string

required

The Unique Identifier of an asset.

Enter * to generate proxies for all assets.
❗ Warning: Generating or regenerating a large number of proxies can take a significant amount of system resources. Review our recommendations and submit a support request if you’d like to consult with the Orange Logic support team before you generate or regenerate a large number of proxies.
Enter a comma-separated list of IDs to generate proxies for multiple assets.
Enter temptable to generate proxies for the assets identified in a table. Enter the table name in the IdentifiersTableName parameter.

FileFormat

string

The code of the proxy format to generate. When you specify a proxy format, you must also specify an asset type in the DocType parameter.

Enter a pipe-delimited list to generate multiple proxy formats.
Example: CMS1|TR10|WebHigh
If you don’t specify formats, all formats are generated.

ℹ️ Note

This parameter is not required. However, we highly recommend specifying one or more formats. In most cases, generating all formats is unnecessary and takes time, processing bandwidth, and storage space that could be better used for other tasks.

DocType

string

The asset type or subtype. Required when the FileFormat parameter is used.

Priority

int32

Defaults to -999999

The priority of the proxy generation task in the application queue. By default, the task is scheduled in the very low priority queue.

GenerateOnlyIf

string

Whether the Orange Logic platform generates a proxy when the relevant format already exists.

TheFormatExists: When the relevant proxy format already exists for an asset, the proxy is regenerated. If the proxy format doesn’t exist, a new proxy is not generated.
TheFormatDoesntExist: When the relevant proxy format doesn’t exist for an asset, the proxy is generated. If the proxy format already exists, the proxy is not regenerated.
If you don’t specify a value, the relevant proxy format is always generated or regenerated.

ℹ️ Note

This parameter is supported only for audio and video assets. It is not supported for images, so image proxies are always generated or regenerated.

ForceUpdateRepresentative

boolean

Defaults to false

Set to true to regenerate any proxy used as the representative of the asset. This proxy regeneration will happen regardless of any other settings, such as the specified proxy format.

UpdateMediaData

boolean

Defaults to false

Set to true to update media data in the database before generating proxies. This option is useful when ingest errors resulted in incorrect media data in the database.

Media data is the following information:

For images: width, height
For audio: width, height, duration, bit rate, frame rate, format
For video: duration, bit rate, format

AsyncTransactionRecordID

string

Enter a transaction record ID to add the proxy generation task to an existing asynchronous transaction.

format

string

Defaults to XML

The response format (XML or JSON)

dateformat

string

Defaults to yyyy-MM-ddTHH:mm:ss

The output date format

Token

string

An authentication token. If empty, the token included in the current cookie is used.

IdentifiersTableName

string

The name of the table in which asset identifiers are stored. Use this parameter only when the AssetIdentifier parameter is set to temptable.

For example, you could run the /api/Documents/v1.0/CheckIncorrectProfileImages call to generate a list of images that are the wrong color due to a missing profile. The response to this call is the name of a table storing the record IDs of the affected assets. Enter the table name in this parameter to regenerate the proxies of those assets.

Response

200200