Table of Contents

Search

  1. Preface
  2. Informatica Intelligent Cloud Services REST API
  3. Platform REST API version 2 resources
  4. Platform REST API version 3 resources
  5. Data Integration REST API
  6. File Ingestion and Replication REST API
  7. Streaming Ingestion and Replication REST API
  8. Model Serve REST API
  9. RunAJob utility
  10. ParamSetCli utility
  11. REST API codes
  12. REST API resource quick references

REST API Reference

REST API Reference

Getting schedule details

Getting schedule details

Use the schedule resource to request details about the schedules in the organization.

GET request

To get the details of all schedules in the organization, use the following URI:
/public/core/v3/schedule
To get the details of a schedule using the schedule ID, use the following URI:
/public/core/v3/schedule/<id>
You can use a query parameter to get the details for specific schedules. For example, to get the details of all disabled schedules created by the user jdoe, you might use the following URI:
/public/core/v3/schedule?q=status=='Disabled' and createdBy=='jdoe'
You can use the following query parameters in the URI:
Parameter
Type
Description
status
Boolean
Status of the schedule.
You can use the following operators:
  • ==
  • !=
id
String
Schedule ID.
Use the == operator.
scheduleFederatedId
String
Global unique identifier for the schedule.
Use the == operator.
name
String
Schedule name.
Use the == operator.
If the schedule name includes a space, replace the space with
%20
updateTime
Date
Last time the schedule was updated, in UTC format.
You can use the following operators:
  • <
  • <=
  • ==
  • =>
  • >
  • !=
updatedBy
String
User who updated the schedule.
Use the == operator.
createdBy
String
User who created the schedule.
Use the == operator.
interval
String
Interval or repeat frequency at which the schedule runs. You can use the following values:
  • None
  • Minutely
  • Hourly
  • Daily
  • Weekly
  • Biweekly
  • Monthly
You can use the following operators:
  • ==
  • !=

GET response

If successful, returns the schedules object for the requested schedule. If you request the details for all schedules, the schedules object contains details for each schedule in the organization.
Returns the error object if errors occur.
The schedules object includes the following attributes:
Field
Type
Description
id
String
Schedule ID.
scheduleFederatedId
String
Global unique identifier for the schedule.
name
String
Schedule name.
status
String
Status of the schedule. Returns one of the following values:
  • enabled
  • disabled
description
String
Description of the schedule.
createTime
Date/time
Time the schedule was created.
updateTime
Date/time
Last time the schedule was updated.
createdBy
String
User who created the schedule.
updatedBy
String
User who last updated the schedule.
startTime
Date/time
Date and time when the schedule starts running, in UTC format.
endTime
Date/time
Date and time when the schedule stops running.
interval
String
Interval or repeat frequency at which the schedule runs tasks. Returns one of the following codes:
  • None. The schedule does not repeat.
  • Minutely. Tasks run on an interval based on the specified number of minutes, days, and time range.
  • Hourly. Tasks run on an hourly interval based on the start time of the schedule.
  • Daily. Tasks run on a daily interval based on the start time of the schedule.
  • Weekly. Tasks run on a weekly interval based on the start time of the schedule.
  • Biweekly. Tasks run every two weeks based on the start time of the schedule.
  • Monthly. Tasks run on a monthly interval based on the start time of the schedule.
frequency
Int
Frequency that the schedule runs for the specified interval. For example, if the interval is Hourly, a frequency of 2 means the task runs every 2 hours.
Returned for Minutely, Hourly, and Daily intervals only.
rangeStartTime
Date/time
The start of the time range within a day that tasks run.
Returned for Minutely and Hourly intervals only.
rangeEndTime
Date/time
The end of the time range within a day that tasks run.
Returned for Minutely and Hourly intervals only.
sun
Boolean
Tasks run on Sunday. Returns one of the following codes:
  • true
  • false
Returned for Minutely, Hourly, Weekly, and Biweekly intervals only.
mon
Boolean
Tasks run on Monday.
See description for sun.
tue
Boolean
Tasks run on Tuesday.
See description for sun.
wed
Boolean
Tasks run on Wednesday.
See description for sun.
thu
Boolean
Tasks run on Thursday.
See description for sun.
fri
Boolean
Tasks run on Friday.
See description for sun.
sat
Boolean
Tasks run on Saturday.
See description for sun.
weekDay
Boolean
Tasks run on weekdays only. Returns one of the following codes:
  • true
  • false
Returned for the Daily interval only.
dayOfMonth
Int
Date of the month that tasks run. Returns a date between 1-28.
Returned for the Monthly interval only.
weekOfMonth
String
Week of the month that tasks run. Returns one of the following codes:
  • First. The tasks run in the first week of the month.
  • Second. The tasks run in the second week of the month.
  • Third. The tasks run in the third week of the month.
  • Fourth. The tasks run in the fourth week of the month.
  • Last. The tasks run in the last week of the month.
Returned for the Monthly interval only.
dayOfWeek
String
Day of the week that tasks run. Returns one of the following codes:
  • Day. Tasks run on the first day or last day of the month, based on the selected weekOfMonth option.
  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
Returned for the Monthly interval only.
timeZoneId
String
Time zone used for the day of the week, day of the month, or week of the month that the tasks run.

GET example

To request information about a schedule using the schedule ID, you might use the following request:
GET <baseApiUrl>/public/core/v3/schedule/0An1v84VPL3k6kypOlxq06D0000000000003 Accept: application/json INFA-SESSION-ID: <sessionId>
A successful response might look like the following example:
{ "id": "0An1v84VPL3k6kypOlxq06D0000000000003", "scheduleFederatedId" : "24bDtKg6d9SbaNlqDolHSR", "name": "MI_FILE_LISTENER_10107", "status":"enabled", "createTime": "2018-12-03T17:34:45.000Z", "updateTime": "2019-05-09T12:13:34.000Z", "createdBy": "clouddemo", "updatedBy": "vnath", "startTime": "2020-06-09T00:15:55.000Z", "interval": "Minutely", "frequency": 5, "rangeStartTime" : "", "rangeEndTime" : "", "mon": true, "tue": true, "wed": true, "thu": true, "fri": true, "sat": true, "sun": true, "weekDay": false, "dayOfMonth": 0, "weekOfMonth": null, "dayOfWeek": null, "timeZoneId": "America/Los Angeles" }

0 COMMENTS

We’d like to hear from you!