On This Page
Overview
This option is only available for certain platforms. When enabled, it takes native file formats from the source and converts them into supported file formats on the destination. This ensures you retain the files and can access the information on the destination. If you don't enable this behavior, the file will still be transferred, but the contents of the file may not be formatted as expected. Refer to the information below to understand how native formats are handled per platform.
Box Notes
Currently, the rendition feature is only available for Box to convert Box Notes.
Enabled: Box Notes will be transferred to other platforms as docx files.
Disabled: Box Notes will be transferred in JSON format.
Warning! Enabling renditions will cause your job to run slower since Box doesn't support native event detection for Box Note files and must crawl to detect changes.
Enabling Renditions Through REST API
When creating the job through the REST API, you can enable the rendition behavior in the transfer block.
POST {{url}}v1/jobs |
|---|
{
"name":"Job Name",
"kind": "transfer",
"transfer": {
"transfer_type": "copy",
"source": {
"connection": { "id": "source_connection_id" },
"target": {
"path": "source_connection_path"
}
},
"destination": {
"connection": { "id": "destination_connection_id" },
"target": {
"path": "destination_connection_path"
}
},
"rendition": "rendition"
}
}
|
Disabling Renditions Through REST API
When creating the job through the REST API, you can disable the rendition behavior in the transfer block.
POST {{url}}v1/jobs |
|---|
{
"name":"Job Name",
"kind": "transfer",
"transfer": {
"transfer_type": "copy",
"source": {
"connection": { "id": "source_connection_id" },
"target": {
"path": "source_connection_path"
}
},
"destination": {
"connection": { "id": "destination_connection_id" },
"target": {
"path": "destination_connection_path"
}
},
"rendition": "original"
}
}
|
Even though the rendition feature can be enabled through the REST API, you cannot enable it using the scripting block when creating the job. Instead, use the toggle in the UI to enable the feature.