GET /api/v1/edc/studies/PHARMADEMO/intervals?page=0&size=25&sort=intervalId%2CASC&filter=intervalId%3D%3D161 HTTP/1.1
Content-Type: application/json
Host: localhost:8080
Given a StudyKey, fetch the set of intervals. An interval is a design resource that represents a set of forms that must be completed for each subject in a study. It is related to visits in that each visit is a single instance of an interval for a given subject.
A GET
request is used to access the index
GET /api/v1/edc/studies/PHARMADEMO/intervals?page=0&size=25&sort=intervalId%2CASC&filter=intervalId%3D%3D161 HTTP/1.1
Content-Type: application/json
Host: localhost:8080
Path parameters are required.
Parameter | Description |
---|---|
|
StudyKey to retrieve list of intervals |
Request parameters are optional. Default values are used unless specified.
Parameter | Description |
---|---|
|
Which index page to be returned. Default value is 0. |
|
Items per page to be returned. Default value is 25. Maximum items allowed per page is 500 |
|
Name of the property by which to sort the result set. To sort in a particular direction add a comma to the property name and either |
|
Optional filter search criteria. Must follow correct syntax. Refer to filter section for details. |
Below is an example response payload.
{
"metadata" : {
"status" : "OK",
"method" : "GET",
"path" : "/api/v1/edc/studies/PHARMADEMO/intervals",
"timestamp" : "2024-03-22 15:32:18",
"error" : { }
},
"pagination" : {
"currentPage" : 0,
"size" : 25,
"totalPages" : 1,
"totalElements" : 1,
"sort" : [ {
"property" : "intervalId",
"direction" : "ASC"
} ]
},
"data" : [ {
"studyKey" : "PHARMADEMO",
"intervalId" : 1,
"intervalName" : "Day 1",
"intervalDescription" : "Day 1",
"intervalSequence" : 110,
"intervalGroupId" : 10,
"intervalGroupName" : "ePRO",
"disabled" : true,
"dateCreated" : "2024-03-22 15:32:18",
"dateModified" : "2024-03-22 15:32:19",
"timeline" : "Start Date End Date",
"definedUsingInterval" : "Baseline",
"windowCalculationForm" : "Procedure",
"windowCalculationDate" : "PROCDT",
"actualDateForm" : "Follow Up",
"actualDate" : "FUDT",
"dueDateWillBeIn" : 30,
"negativeSlack" : 7,
"positiveSlack" : 7,
"eproGracePeriod" : 2,
"forms" : [ {
"formId" : 123,
"formKey" : "MY-FORM-KEY",
"formName" : "myFormName"
} ]
} ]
}
Path | Type | Description |
---|---|---|
|
|
Http status |
|
|
Http method |
|
|
Requested URI path |
|
|
Timestamp when response was generated |
|
|
Detail error message from request if error occur |
|
|
Current index page |
|
|
Size per page |
|
|
Total pages return from search |
|
|
Total elements return from search |
|
|
Sort property |
|
|
Sort direction |
|
|
Unique study key for a given study |
|
|
Unique system identifier for Interval |
|
|
User defined interval/visit name |
|
|
User defined interval/visit description |
|
|
User defined sequence of interval |
|
|
User defined interval groupId |
|
|
User defined interval group name |
|
|
Type of Interval Visit Window. Valid responses: None, Due Date, Start - End Date, or Actual Date |
|
|
The baseline Interval where the calculate from date is collected |
|
|
The baseline Form where the calculate from date is collected |
|
|
The baseline Field where the calculate from date is collected |
|
|
The actual date Form for a specific Interval |
|
|
The actual date Field for a specific Interval |
|
|
The number of days the actual date is due from the calculate from date |
|
|
The number of negative days allowed from the due date |
|
|
The number of positive days allowed from the due date |
|
|
The number of positive days allowed for ePRO from the due date |
|
|
Form ID |
|
|
Form Key |
|
|
Form name |
|
|
Interval form is soft delete status |
|
|
Date when this interval was created |
|
|
Date when this interval was last modified |