Skip to content

AutomationsCreateParameters1.md

Latest commit

 

History

History
35 lines (28 loc) · 2.06 KB

AutomationsCreateParameters1.md

File metadata and controls

35 lines (28 loc) · 2.06 KB
Raw

Phrase::AutomationsCreateParameters1

Properties

Name Type Description Notes
name String name of the automation
trigger String
project_ids Array<String> List of project IDs to associate with the automation. Providing more than one project ID requires the `advanced_job_automation` plan feature; accounts without this feature receive a 422 response with error field `project_ids`.
job_template_id String id of job template that the automation uses to create jobs from [optional]
status_filters Array<String> translation key statuses used to filter keys that are added to jobs
tags Array<String> used to filter which keys are added to jobs [optional]
cron_schedule String along with time_zone, specifies when the scheduled automation is supposed to run [optional]
time_zone String along with cron_schedule, specifies when the scheduled automation is supposed to run [optional]
job_owner_id String User ID of the job owner that newly created jobs are assigned to. [optional]
include_only_updated_locales Boolean When `true`, the automation only acts on locales that changed since its last run. [optional]

Code Sample

require 'phrase'

instance = Phrase::AutomationsCreateParameters1.new(name: 'Scheduled Job Automation - Hourly',
                                 trigger: nil,
                                 project_ids: ["abcd1234cdef1234abcd1234cdef1234"],
                                 job_template_id: 'abcd1234cdef1234abcd1234cdef1234',
                                 status_filters: nil,
                                 tags: ["myTag"],
                                 cron_schedule: '00 13 * * 1,2',
                                 time_zone: 'GMT',
                                 job_owner_id: 'abcd1234abcd1234abcd1234abcd1234',
                                 include_only_updated_locales: false)