Scheduling Object

Skip to end of metadata
Go to start of metadata

Overview

In the IDX API used by IdentitySync, a scheduling object defines the date, time and frequency at which to run a given dataflow. It includes the ID of a Dataflow to execute, when and how often to execute it, and some additional settings such as notification emails.

For an introduction to IdentitySync, read the IdentitySync guide.

Methods

Fields

FieldTypeDescription
namestringThe title of the scheduling object.
dataflowIdstringThe unique identifier of a dataflow that exists in the system.
frequencyTypestring

Set to once to execute the dataflow one time.

Otherwise set to minute, hour, day, week, or month.

frequencyIntervalstring

The interval between dataflow executions, in the time units set in frequencyType.

For example, to execute the dataflow twice a day, set frequencyType="hour" and frequencyInterval=12.

You don't have to set this parameter if you set frequencyType="once".

nextJobStartTimestring

Date and time in which to start executing the dataflow. Format: yyyy-MM-dd HH:mm:ss

Default: current date and time.

successEmailNotificationstring

A comma-separated list of emails that the service will notify when the dataflow is executed successfully.

For example: "john@example.com,jason@example.com"

failureEmailNotificationstring

A comma-separated list of emails that the service will notify when the dataflow fails to execute successfully.

For example: "john@example.com,jason@example.com"

limitinteger

The maximum number of records to fetch.

Default: no limit.

fullExtractboolean

Set to true to perform a full extract. Default: false (service will perform an incremental extract).

enabledbooleanSet to false to disable the scheduled dataflow. Default is true.

Save

Save

Save

Save

  • No labels