Executing recurring (C_PERIOD) tasks via Automic REST API
search cancel

Executing recurring (C_PERIOD) tasks via Automic REST API

book

Article ID: 444574

calendar_today

Updated On:

Products

CA Automic Workload Automation - Automation Engine CA Automic One Automation

Issue/Introduction

This article provides the JSON payload structure and parameter or execution mappings for executing tasks with recurring options (recurring executions, C_PERIOD, or periodic tasks) via the Automic REST API /executions endpoint.  The documentation is currently limited with regards to the options for recurring tasks.

Environment

This is valid for any versions 21.0, 24.x, and 26.x

Resolution

 To trigger a recurring execution that mimics a C_PERIOD object, set the execution_option to recurring and provide a recurring configuration block.

All options for JSON Schema for Recurring Executions:

json
{
  "object_name": "NAME.OF.OBJECT",
  "execution_option": "recurring",
  "timezone": "TZ.CET",
  "recurring": {
      "period_description" : "Period desc",
      "start_date" : null,
      "end_date" : null,
      "end_after_executions" : null,
      "execute_at" : null,
      "execute_interval" : null,
      "execute_after" : null,
      "allow_one_overlap" : false,
      "between_start" : null,
      "between_end" : null,
      "execute_weekly" : null,
      "execute_calendar_match" : null,
      "adjust_start_time" : false,
      "execute_calendar_list" : null
  }
}

Key Parameter Mappings:

 
 
AWI / UI FieldREST API KeyFormat / Example
Start Datestart_dateyyyy-MM-dd (e.g., 2026-06-10)
Execute in intervals of everyexecute_intervalISO 8601 Duration (e.g., P0DT0H10M for 10 mins)
Between [Time]between_startHH:mm (e.g., 16:00)
And [Time]between_endHH:mm (e.g., 18:00)
Adjust initial start timeadjust_start_timetrue / false
TimezonetimezoneObject name (e.g., TZ.CET)

Example: Run every 10 minutes between 16:00 and 18:00 starting June 10th

json
{
  "object_name": "SCRI.RECURRING.TASK",
  "execution_option": "recurring",
  "recurring": {
    "execute_interval": "P0DT0H10M",
    "adjust_start_time": true,
    "start_date": "2026-06-10",
    "between_start": "16:00",
    "between_end": "18:00"
  }
}

Important Notes:

  • Duration Format: execute_interval must follow the ISO 8601 duration format (e.g., P for period, T for time).
  • Timezone: If no timezone is specified, the API defaults to UTC in version 21.0+.
  • Initial Start Time: Setting adjust_start_time to true aligns the first execution to the next regular clock-time segment based on the interval (e.g., a 15-minute interval started at 9:07 will trigger at 9:15).

Additional Information

Additional information can be found in the REST API documentation for POST /{client_id}/executions

Contact Broadcom Support for further assistance.