Help Center/ ROMA Connect/ User Guide (ME-Abu Dhabi Region)/ FAQs/ Data Integration Tasks/ How Do I Set the Custom Period for the API Data Source at the Source?
Updated on 2024-07-10 GMT+08:00

How Do I Set the Custom Period for the API Data Source at the Source?

During a common FDI task creation, if you select API as the data source type and enable Incremental Migration at the source, you can customize the period. The following examples describe how to configure the period.

  • If Time Interval is set to Hour, the configuration scenarios are as follows:

    2020-11-05 22:10 is used as an example.

    1. Period is set to Current period and Right Periodic Boundary is set to Open interval.

      The values of Start Time Field and End Time Field are the start time and end time of the current period, respectively.

      The time interval for obtaining data is [2020-11-05 22:00:00.0, 2020-11-05 23:00:00.0].

    2. Period is set to Current period and Right Periodic Boundary is set to Closed interval.

      The values of Start Time Field and End Time Field are the start time and the end time subtracted by 1 ms of the current period, respectively.

      The time interval for obtaining data is [2020-11-05 22:00:00.0, 2020-11-05 22:59:59.999].

    3. Period is set to Previous period and Right Periodic Boundary is set to Open interval.

      The values of Start Time Field and End Time Field are the start time and end time of the previous period, respectively.

      The time interval for obtaining data is [2020-11-05 21:00:00.0, 2020-11-05 22:00:00.0].

    4. Period is set to Previous period and Right Periodic Boundary is set to Closed interval.

      The values of Start Time Field and End Time Field are the start time and the end time subtracted by 1 ms of the previous period, respectively.

      The time interval for obtaining data is [2020-11-05 21:00:00.0, 2020-11-05 21:59:59.999].

  • If Time Interval is set to Day, the following configuration scenarios are available:

    2020-11-06 22:10 is used as an example.

    1. Period is set to Current period and Right Periodic Boundary is set to Open interval.

      The values of Start Time Field and End Time Field are the start time and end time of the current period, respectively.

      The time interval for obtaining data is [2020-11-06 00:00:00.0, 2020-11-07 00:00:00.0].

    2. Period is set to Current period and Right Periodic Boundary is set to Closed interval.

      The values of Start Time Field and End Time Field are the start time and the end time subtracted by 1 ms of the current period, respectively.

      The time interval for obtaining data is [2020-11-06 00:00:00.0, 2020-11-06 23:59:59.999].

    3. Period is set to Previous period and Right Periodic Boundary is set to Open interval.

      The values of Start Time Field and End Time Field are the start time and end time of the previous period, respectively.

      The time interval for obtaining data is [2020-11-05 00:00:00.0, 2020-11-06 00:00:00.0].

    4. Period is set to Previous period and Right Periodic Boundary is set to Closed interval.

      The values of Start Time Field and End Time Field are the start time and the end time subtracted by 1 ms of the previous period, respectively.

      The time interval for obtaining data is [2020-11-05 00:00:00.0, 2020-11-05 23:59:59.999].

  • If Time Interval is set to Week, the following configuration scenarios are available:

    2020-11-06 22:10 is used as an example.

    1. Period is set to Current period and Right Periodic Boundary is set to Open interval.

      The values of Start Time Field and End Time Field are the start time and end time of the current period, respectively.

      The time interval for obtaining data is [2020-11-02 00:00:00.0, 2020-11-09 00:00:00.0].

    2. Period is set to Current period and Right Periodic Boundary is set to Closed interval.

      The values of Start Time Field and End Time Field are the start time and the end time subtracted by 1 ms of the current period, respectively.

      The time interval for obtaining data is [2020-11-02 00:00:00.0, 2020-11-08 23:59:59.999].

    3. Period is set to Previous period and Right Periodic Boundary is set to Open interval.

      The values of Start Time Field and End Time Field are the start time and end time of the previous period, respectively.

      The time interval for obtaining data is [2020-10-26 00:00:00.0, 2020-11-02 00:00:00.0].

    4. Period is set to Previous period and Right Periodic Boundary is set to Closed interval.

      The values of Start Time Field and End Time Field are the start time and the end time subtracted by 1 ms of the previous period, respectively.

      The time interval for obtaining data is [2020-10-26 00:00:00.0, 2020-11-01 23:59:59.999].

  • If Time Interval is set to Month, the following configuration scenarios are available:

    2020-11-06 22:10 is used as an example.

    1. Period is set to Current period and Right Periodic Boundary is set to Open interval.

      The values of Start Time Field and End Time Field are the start time and end time of the current period, respectively.

      The time interval for obtaining data is [2020-11-01 00:00:00.0, 2020-12-01 00:00:00.0].

    2. Period is set to Current period and Right Periodic Boundary is set to Closed interval.

      The values of Start Time Field and End Time Field are the start time and the end time subtracted by 1 ms of the current period, respectively.

      The time interval for obtaining data is [2020-11-01 00:00:00.0, 2020-11-30 23:59:59.999].

    3. Period is set to Previous period and Right Periodic Boundary is set to Open interval.

      The values of Start Time Field and End Time Field are the start time and end time of the previous period, respectively.

      The time interval for obtaining data is [2020-10-01 00:00:00.0, 2020-11-01 00:00:00.0].

    4. Period is set to Previous period and Right Periodic Boundary is set to Closed interval.

      The values of Start Time Field and End Time Field are the start time and the end time subtracted by 1 ms of the previous period, respectively.

      The time interval for obtaining data is [2020-10-01 00:00:00.0, 2020-10-31 23:59:59.999].