Retrieve a list of study treatment schedules.
GET {{baseUrl}}/StudyTreatmentSchedules?$top=<integer>&$skip=<integer>&$search=<string>&$filter=<string>&$count=<boolean>&$orderby=isLastPeriodRepeatEnabled,weeksPriorToLastPeriodForRepeat desc&$select=weeksPriorToLastPeriodForRepeat,weeksPriorToLastPeriodForRepeat&$expand=scenario,randomizationGroup
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
$top | string | Show only the first n items, see Paging - Top | |
$skip | string | Skip the first n items, see Paging - Skip | |
$search | string | Search items by search phrases, see Searching | |
$filter | string | Filter items by property values, see Filtering | |
$count | string | Include count of items, see Count | |
$orderby | string | Order items by property values, see Sorting | |
$select | string | Select properties to be returned, see Select | |
$expand | string | Expand related entities, see Expand |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"@odata.count":"\u003cnumber\u003e","value":[{"ID":"\u003cuuid\u003e","siteGroupId":"\u003cstring\u003e","isLastPeriodRepeatEnabled":false,"weeksPriorToLastPeriodForRepeat":"\u003cinteger\u003e","scenario":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios detected\u003e"},"scenario_ID":"\u003cuuid\u003e","randomizationGroup":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups detected\u003e"},"randomizationGroup_ID":"\u003cuuid\u003e","treatmentPeriods":[{"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods detected\u003e"}],"treatmentPeriods@odata.count":"\u003cnumber\u003e","desynchronizedTreatmentGroups":[{"ID":"\u003cuuid\u003e","isLastPeriodRepeatEnabled":false,"weeksPriorToLastPeriodForRepeat":"\u003cinteger\u003e","treatmentGroup_BK":"\u003cstring\u003e","treatmentSchedule":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules detected\u003e"},"treatmentSchedule_ID":"\u003cuuid\u003e","treatmentGroup":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups detected\u003e"},"treatmentGroup_ID":"\u003cuuid\u003e"},{"ID":"\u003cuuid\u003e","isLastPeriodRepeatEnabled":false,"weeksPriorToLastPeriodForRepeat":"\u003cinteger\u003e","treatmentGroup_BK":"\u003cstring\u003e","treatmentSchedule":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules detected\u003e"},"treatmentSchedule_ID":"\u003cuuid\u003e","treatmentGroup":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups detected\u003e"},"treatmentGroup_ID":"\u003cuuid\u003e"}],"desynchronizedTreatmentGroups@odata.count":"\u003cnumber\u003e","assignedTreatments":[{"schdule_ID":"\u003cuuid\u003e","treatmentPeriod_ID":"\u003cuuid\u003e","treatmentPeriodID":"\u003cstring\u003e","treatmentPeriod_description":"\u003cstring\u003e","isDispensationPeriod":"\u003cboolean\u003e","dispensationEvent_ID":"\u003cuuid\u003e","dispensationEventID":"\u003cstring\u003e","dispensationEvent_description":"\u003cstring\u003e","treatmentAssignment_ID":"\u003cuuid\u003e","treatmentID":"\u003cstring\u003e","treatment_description":"\u003cstring\u003e"},{"schdule_ID":"\u003cuuid\u003e","treatmentPeriod_ID":"\u003cuuid\u003e","treatmentPeriodID":"\u003cstring\u003e","treatmentPeriod_description":"\u003cstring\u003e","isDispensationPeriod":"\u003cboolean\u003e","dispensationEvent_ID":"\u003cuuid\u003e","dispensationEventID":"\u003cstring\u003e","dispensationEvent_description":"\u003cstring\u003e","treatmentAssignment_ID":"\u003cuuid\u003e","treatmentID":"\u003cstring\u003e","treatment_description":"\u003cstring\u003e"}],"assignedTreatments@odata.count":"\u003cnumber\u003e","switches":[{"ID":"\u003cuuid\u003e","switchID":"\u003cstring\u003e","switchRate":"\u003cnumber\u003e","fromPeriod_BK":"\u003cstring\u003e","toPeriod_BK":"\u003cstring\u003e","treatmentSchedule":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules detected\u003e"},"treatmentSchedule_ID":"\u003cuuid\u003e","fromTreatmentGroup":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups detected\u003e"},"fromTreatmentGroup_ID":"\u003cuuid\u003e","toTreatmentGroup":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups detected\u003e"},"toTreatmentGroup_ID":"\u003cuuid\u003e","fromPeriod":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods detected\u003e"},"fromPeriod_ID":"\u003cuuid\u003e","toPeriod":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods detected\u003e"},"toPeriod_ID":"\u003cuuid\u003e"},{"ID":"\u003cuuid\u003e","switchID":"\u003cstring\u003e","switchRate":"\u003cnumber\u003e","fromPeriod_BK":"\u003cstring\u003e","toPeriod_BK":"\u003cstring\u003e","treatmentSchedule":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules detected\u003e"},"treatmentSchedule_ID":"\u003cuuid\u003e","fromTreatmentGroup":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups detected\u003e"},"fromTreatmentGroup_ID":"\u003cuuid\u003e","toTreatmentGroup":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups detected\u003e"},"toTreatmentGroup_ID":"\u003cuuid\u003e","fromPeriod":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods detected\u003e"},"fromPeriod_ID":"\u003cuuid\u003e","toPeriod":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods detected\u003e"},"toPeriod_ID":"\u003cuuid\u003e"}],"switches@odata.count":"\u003cnumber\u003e"},{"ID":"\u003cuuid\u003e","siteGroupId":"\u003cstring\u003e","isLastPeriodRepeatEnabled":false,"weeksPriorToLastPeriodForRepeat":"\u003cinteger\u003e","scenario":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios detected\u003e"},"scenario_ID":"\u003cuuid\u003e","randomizationGroup":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups detected\u003e"},"randomizationGroup_ID":"\u003cuuid\u003e","treatmentPeriods":[{"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods detected\u003e"}],"treatmentPeriods@odata.count":"\u003cnumber\u003e","desynchronizedTreatmentGroups":[{"ID":"\u003cuuid\u003e","isLastPeriodRepeatEnabled":false,"weeksPriorToLastPeriodForRepeat":"\u003cinteger\u003e","treatmentGroup_BK":"\u003cstring\u003e","treatmentSchedule":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules detected\u003e"},"treatmentSchedule_ID":"\u003cuuid\u003e","treatmentGroup":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups detected\u003e"},"treatmentGroup_ID":"\u003cuuid\u003e"},{"ID":"\u003cuuid\u003e","isLastPeriodRepeatEnabled":false,"weeksPriorToLastPeriodForRepeat":"\u003cinteger\u003e","treatmentGroup_BK":"\u003cstring\u003e","treatmentSchedule":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules detected\u003e"},"treatmentSchedule_ID":"\u003cuuid\u003e","treatmentGroup":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups detected\u003e"},"treatmentGroup_ID":"\u003cuuid\u003e"}],"desynchronizedTreatmentGroups@odata.count":"\u003cnumber\u003e","assignedTreatments":[{"schdule_ID":"\u003cuuid\u003e","treatmentPeriod_ID":"\u003cuuid\u003e","treatmentPeriodID":"\u003cstring\u003e","treatmentPeriod_description":"\u003cstring\u003e","isDispensationPeriod":"\u003cboolean\u003e","dispensationEvent_ID":"\u003cuuid\u003e","dispensationEventID":"\u003cstring\u003e","dispensationEvent_description":"\u003cstring\u003e","treatmentAssignment_ID":"\u003cuuid\u003e","treatmentID":"\u003cstring\u003e","treatment_description":"\u003cstring\u003e"},{"schdule_ID":"\u003cuuid\u003e","treatmentPeriod_ID":"\u003cuuid\u003e","treatmentPeriodID":"\u003cstring\u003e","treatmentPeriod_description":"\u003cstring\u003e","isDispensationPeriod":"\u003cboolean\u003e","dispensationEvent_ID":"\u003cuuid\u003e","dispensationEventID":"\u003cstring\u003e","dispensationEvent_description":"\u003cstring\u003e","treatmentAssignment_ID":"\u003cuuid\u003e","treatmentID":"\u003cstring\u003e","treatment_description":"\u003cstring\u003e"}],"assignedTreatments@odata.count":"\u003cnumber\u003e","switches":[{"ID":"\u003cuuid\u003e","switchID":"\u003cstring\u003e","switchRate":"\u003cnumber\u003e","fromPeriod_BK":"\u003cstring\u003e","toPeriod_BK":"\u003cstring\u003e","treatmentSchedule":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules detected\u003e"},"treatmentSchedule_ID":"\u003cuuid\u003e","fromTreatmentGroup":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups detected\u003e"},"fromTreatmentGroup_ID":"\u003cuuid\u003e","toTreatmentGroup":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups detected\u003e"},"toTreatmentGroup_ID":"\u003cuuid\u003e","fromPeriod":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods detected\u003e"},"fromPeriod_ID":"\u003cuuid\u003e","toPeriod":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods detected\u003e"},"toPeriod_ID":"\u003cuuid\u003e"},{"ID":"\u003cuuid\u003e","switchID":"\u003cstring\u003e","switchRate":"\u003cnumber\u003e","fromPeriod_BK":"\u003cstring\u003e","toPeriod_BK":"\u003cstring\u003e","treatmentSchedule":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules detected\u003e"},"treatmentSchedule_ID":"\u003cuuid\u003e","fromTreatmentGroup":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups detected\u003e"},"fromTreatmentGroup_ID":"\u003cuuid\u003e","toTreatmentGroup":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups detected\u003e"},"toTreatmentGroup_ID":"\u003cuuid\u003e","fromPeriod":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods detected\u003e"},"fromPeriod_ID":"\u003cuuid\u003e","toPeriod":{"nullable":true,"value":"\u003cCircular reference to #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods detected\u003e"},"toPeriod_ID":"\u003cuuid\u003e"}],"switches@odata.count":"\u003cnumber\u003e"}]}