Recurrence-related APIs
Sterling™ Order Management System Software provides APIs for recurrence plan actions. As a developer, you can refer to this page to see the APIs to manage a recurrence plan in Sterling Order Management System Software. You can see various recurrence plan actions and understand the APIs used to do those actions.
Recurrence plan APIs
A recurrence plan is used to schedule repeated business actions to run at regular intervals. After set up, the recurrence plan lists all future trigger dates for its scheduled actions. The repetition of the recurrence plan is defined as a time-based schedule, modeled as a CRON expression.
Sterling Order Management System Software provides APIs to manage recurrence plans. As a developer or system integrator, you can refer to this page to see the APIs to manage a recurrence plan in Sterling Order Management System Software. You can see various recurrence plan actions and understand the APIs used to do those actions. For more information about Recurrence plan APIs, see Javadoc. To access Javadoc, see Accessing development-related documentation.
-
- Create a recurrence plan
-
createRecurrencePlan API
-
- Retrieve the details of a recurrence plan
-
getRecurrencePlanDetails API
-
- Modify a recurrence plan
-
modifyRecurrencePlan API
-
- Delete a recurrence plan
-
deleteRecurrencePlan API
-
- Retrieve the recurrence plans matching the particular search criteria
- getRecurrencePlanList API
-
- Find the date matches and number of recurrences for a recurrence plan
- Checks whether a particular date matches the periodicity definition of the recurrence plan, returns the number of recurrences within the particular start and end dates and lists the date of each recurrence.