Migrate Job Schedules

Product version: 11.2.1

Last modified: 13 August 2026

Converts one or more jobs from the legacy retention approach to the schedule retention approach. The method is the API equivalent of the MIGRATE SETTINGS action in the product interface: it maps the legacy schedule types and the legacy rule-set retention of the job to their schedule retention equivalents, field-for-field.

A single request can carry one job ID or a batch of job IDs.

Endpoint

https://<Director_IP_address>:4443/c/router

Tenant Endpoint

For tenants of the multi-tenant product the endpoint must be:

https://<Director_IP_address>:4443/t/<tenant_UUID>/c/router

Request Example

Copy 
curl --request POST \
    --url https://<Director_IP_address>:4443/c/router \
    --header "content-type: application/json" \
    --cookie @cookies.txt \
    --data '{
        "action": "JobManagement",
        "method": "migrateJobSchedules",
        "data": [{
            "jobIds": [33, 34, 37]}],
        "type": "rpc",
        "tid": 1}'

Request Fields

Field Type Value(s)
action string JobManagement
method string migrateJobSchedules
data array Parameters
type string rpc
tid integer 1

Data

Field Type Description
jobIds array Required. IDs of the jobs to migrate. Provide a single ID to migrate one job, or several IDs to migrate a batch.

Response Sample

Copy 
{
  "action": "JobManagement",
  "method": "migrateJobSchedules",
  "tid": "1",
  "type": "rpc",
  "message": null,
  "where": null,
  "cause": null,
  "data": {
    "results": [
      {"jobId": 33, "jobName": "Backup job 01", "status": "MIGRATED", "message": null},
      {"jobId": 34, "jobName": "Backup job 02", "status": "MIGRATED", "message": null},
      {"jobId": 37, "jobName": null, "status": "FAILED", "message": "the object does not exist (IllegalArgumentException)"}
    ]
  }
}

Response Fields

Field
Type
Description
message string Message if the request failed
where string Reference to the method where a problem occurred
cause string Cause of failure
data object The results array, with one entry per requested job in the order of the job IDs in the request

Results

Field Type Description
jobId integer The job ID, echoed from the request.
jobName string Name of the job. The value is null if the job no longer exists.
status string Outcome for this job: MIGRATED, SKIPPED_ALREADY_MIGRATED, or FAILED.
message string Details for a skipped or failed job. The value is null for a migrated job.

Notes

  • Every job in a batch is processed independently. A job that fails to migrate, or that no longer exists, is reported in its own result and the rest of the batch completes.

  • A job that already uses the schedule retention approach is reported as SKIPPED_ALREADY_MIGRATED. This is a normal outcome, not an error.

  • The caller must have the permission to edit job schedules for every existing job in the request. If the permission is missing for any of them, the entire request is denied and no job is processed. A job ID that does not exist passes this check and is reported as FAILED in its own result.

  • A request without data, or with an empty jobIds array, is rejected before any job is processed. The caller receives an error instead of a response with an empty result list.

  • A single call migrated 325 jobs in 6.5 seconds in internal testing.