Create Time Bound Request

Creates a time bound request.

Timezones
Pacific/Asia Pacific/Honolulu America/Anchorage
America/Los_Angeles America/Denver America/Chicago
America/New_York America/Puerto_Rico America/St_Johns
America/Buenos_Aires Atlantic/Azores GMT
Europe/Paris Europe/Istanbul Africa/Addis_Ababa
Asia/Tehran Asia/Yerevan Asia/Karachi
Asia/Calcutta Asia/Dacca Asia/Saigon
Asia/Shanghai Asia/Tokyo Australia/Darwin
Australia/Sydney Pacific/Guadalcanal Pacific/Auckland

Schedule Pattern Types

Define the time duration for the time bound request to occur once or repeatedly.

Define the time bound request to occur for one-time only:

{
  "type": "one-time",
  "startTime": "2016-04-10T12:15:00+0000",
  "endTime": "2016-04-10T12:15:00+0000",
  "timezone": "America/Los_Angeles"
}

Define the time bound request to occur repeatedly:

{
  "type": "recurring",
  "startTime": "2016-04-10T12:15:00+0000",
  "endTime": "2016-04-10T12:15:00+0000",
  "timezone": "America/Los_Angeles",
  "pattern": {
    "type": "daily",
    "dayFrequency": "everyday"
  }
}

Below are the recurrence schedule pattern types:

  1. Daily
"pattern": {
    "type": "daily",
    "dayFrequency": "everyday"
  }
  1. Weekly
"pattern": {
    "type": "weekly",
    "weekDays": "Monday"
}
  1. Monthly
"pattern": {
    "type": "monthly",
    "dayOfMonth": "1",
    "weekIndex": "First",
    "dayOfWeek": "Monday"
}
post
/api/v2/tenants/{tenantId}/timeBoundRequests

Path Parameters

  • tenantIdstringrequired

    Describes the clientId of the tenant