Uniphore Customer Portal

Method: GET

URL: /policy/schedules

Unlike other requests the get all schedules request does not require a request body.

{
    "schedule": [
        {
            "id": "35",
            "weekly": {
                "daysOfWeek": [
                    "MON",
                    "TUE"
                ],
                "executionTime": "00:00",
                "timezone": "UTC"
            },
            "interval": "3",
            "name": "3 week schedule",
            "description": "weekly schedule to trigger every 3 weeks on Monday and Tuesday"
        },
        {
            "id": "217",
            "hourly": {
                "executionTime": "17:00",
                "timezone": "UTC"
            },
            "interval": "12",
            "name": "12 hours schedule",
            "description": "hourly schedule to trigger twice a day"
        }
    ]
}

Method: GET

URL: /policy/Schedule/:scheduleId

{
    "schedule": {
        "id": "35",
        "weekly": {
            "daysOfWeek": [
                "MON",
                "TUE"
            ],
            "executionTime": "00:00",
            "timezone": "UTC"
        },
        "interval": "3",
        "name": "3 week schedule",
        "description": "weekly schedule to trigger every 3 weeks on Monday and Tuesday"
    }
}

Method: POST

URL: /policy/schedule

For example Requests, see Sample Requests.

As mentioned above there are different types of Schedule that can be used to specify the frequency that affected policies are applied, and the type of Schedule works with the interval parameter. In order to provide fine control of your captured data the following types and their sub parameters are available. For example create schedule requests for each type, see Sample Requests.

Use minutes to apply affected policies every set amount of minutes.

There are no sub-parameters for the minutes frequency type.

If minutes is used, then valid interval values are 1 to 59.

Use hourly to apply affected policies every set amount of hours.

If hourly is used, then valid interval values are 1 to 99.

Use daily to apply affected policies every set amount of days.

If daily is used, then valid interval values are 1 to 99.

Use weekly to apply affected policies every set amount of weeks.

If weekly is used, then valid interval values are 1 to 99.

Use monthly to apply affected policies every specific day of the month, either by date (for example the 15th day) or specific day of a specific week of the month (for example the Tuesday of the last week of the month).

If monthly is used, then valid interval values are 1 to 99.

Use yearly to apply affected policies every specific day of the year, either by date (for example the 15th or July) or specific day of a specific week of a specific month (for example the Tuesday of the last week of the July).

If yearly is used, then valid interval values are 1 to 99.

For an example response, see Sample Response.

Add a Schedule with minutes frequency:

{"schedule":{
    "interval": 15,
    "minute": {
    },
    "name":"15 minute schedule",
    "description":"minute schedule to trigger every 15 minutes"
}}

Add a Schedule with hourly frequency:

{"schedule":{
    "interval": 12,
    "hourly": {
        "executionTime": "17:00",
        "timezone": "UTC"
    },
    "name":"12 hours schedule",
    "description":"hourly schedule to trigger twice a day"
}}

Add a Schedule with daily frequency:

{"schedule":{
    "interval": 10,
    "daily": {
        "executionTime": "17:00",
        "timezone": "UTC"
     },
    "name":"10 days schedule",
    "description":"schedule to trigger every 10 days"
}}

Add a Schedule with weekly frequency:

{"schedule":{
    "interval": 3,
    "weekly": {
        "executionTime": "00:00",
        "timezone": "UTC",
        "daysOfWeek":["mon","tue"]
    },
    "name":"3 week schedule",
    "description":"weekly schedule to trigger every 3 weeks on Monday and Tuesday"
}}

Add a Schedule with monthly frequency (specific date of the month):

{"schedule": {
    "interval": 1,
    "monthly": {
        "executionTime": "17:00",
        "timezone": "UTC",
        "scheduleByDay": {
            "dayOfMonth": "15"
        }
    },
    "name":"monthly schedule",
    "description":"monthly schedule to trigger every 15th day of the month"
}}

Add a Schedule with monthly frequency (nth day of the nth week of a month):

{"schedule": {
    "interval": 2,
    "monthly": {
        "executionTime": "17:00",
        "timezone": "UTC",
        "scheduleByOccurrence": {
            "nthOccurrence": "last",
            "nthOccurrence_day": "tuesday"
        }
    },
    "name":"monthly schedule",
    "description":"monthly schedule to trigger on the last Tuesday of every other month"
}}

Add a Schedule with yearly frequency (specific day of a specific month):

{"schedule": {
    "interval": 2,
    "yearly": {
        "executionTime": "17:00",
        "timezone": "UTC",
        "month": "July",
        "scheduleByDay": {
            "day_of_month": "19"
        }
    },
    "name":"yearly schedule",
    "description":"yearly schedule to trigger on the 19 of July every other year"
}}

Add a Schedule with yearly frequency (nth day of the nth week of a specific month):

{"schedule": {
    "interval": 3,
    "yearly": {
        "executionTime": "17:00",
        "timezone": "UTC",
        "month": "July",
        "scheduleByOccurrence": {
            "nthOccurrence": "first",
            "nthOccurrenceDay": "monday"
        }
    },
    "name":"yearly schedule",
    "description":"yearly schedule to trigger on the first Monday of July every 3 years"
}}

{
    "scheduleId": "407"
}

Method: PUT

URL: /policy/schedule/:scheduleId

For an example Request, see Sample Request.

for an extensive understanding on the frequency types available see the add a schedule topic, this topic covers the sub-parameters required when updating frequency type.

Required no sub-parameters.

Requires the following sub-parameters:

Requires the following sub-parameters:

Requires the following sub-parameters:

Requires the following sub-parameters:

Required the following sub-paramters:

The above 202 Accepted response i

For an example response, see Sample Response.

The sample request below would update the Schedule name, description, and the sub-parameters for the weekly type. As mentioned above for the type sub-parameters all sub-parameters must be listed for a valid request, even if only one of the sub-parameters is to be updated.

{
"schedule":{
    "name": "Updated Weekly",
    "description": "Updated Mon Tue Wed weekly schedule 15-09-24",
    "weekly": {
        "daysOfWeek": [
            "MON",
            "TUE",
            "WED"
        ],
        "executionTime": "00:00",
        "timezone": "UTC"
    }
}}

{
    "scheduleId": "412"
}

Method: DELETE

URL: /policy/schedule

For an example Request, see Sample Request.

{
    "schedule_ids": [
        412,
        425
    ]
}