Schedules

Add a schedule to a component

post/studies/{studyId}/components/{componentId}/schedules

Request

Base URL: http://localhost:8080/api/v0
URL: http://localhost:8080/api/v0/studies/{studyId}/components/{componentId}/schedules
Auth: HTTP bearer

Path parameters

studyIdstring uuid required

componentIdstring uuid required

Request body

completionPolicy'sameDay' | 'afterStart' | 'sameDayAfterStart' | 'duringEvent' | 'anytime' required

When a scheduled event is allowed to be completed

notificationboolean required

Whether notifications are enabled for this schedule. When true, uses task-based notification threading.

Example request

{
  "scheduleDefinition": {
    "pattern": {
      "type": "event",
      "event": {
        "type": "activation"
      },
      "offsetInDays": 1,
      "time": {
        "hour": 9,
        "minute": 0
      }
    }
  }
}

Response

Schedule added

idstring uuid required

Schedule ID (assigned by server on creation)

completionPolicy'sameDay' | 'afterStart' | 'sameDayAfterStart' | 'duringEvent' | 'anytime' required

When a scheduled event is allowed to be completed

notificationboolean required

Whether notifications are enabled for this schedule. When true, uses task-based notification threading.

Example response

{
  "scheduleDefinition": {
    "pattern": {
      "type": "event",
      "event": {
        "type": "activation"
      },
      "offsetInDays": 1,
      "time": {
        "hour": 9,
        "minute": 0
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.