Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

When creating the job through the REST API, you can enable the rendition behavior in the transfer block.

POST {{url}}v1/jobs

Code Block
{
    "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

Code Block
{
    "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"
    }
}

Info

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.