GET api/v2/Study/{studyId}/Config?configLastUpdatedTimestamp={configLastUpdatedTimestamp}
Get study configuration. Returns the config if it was updated after the timestamp passed in; otherwise no content.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| studyId |
Study ID |
globally unique identifier |
Required |
| configLastUpdatedTimestamp |
Configuration last updated timestamp. |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
Ok, NoContent
ResearchStudyDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Title | string |
None. |
|
| StudyId | globally unique identifier |
None. |
|
| HasParentStudy | boolean |
None. |
|
| AllowDeleteUnsynced | boolean |
None. |
|
| RecommendedMaxSaveBatchSize | integer |
None. |
|
| ConfigLastUpdatedTimestamp | date |
None. |
|
| DisplayOptionForQueryCreator | integer |
None. |
|
| CustomCreatorNameForManualQuery | string |
None. |
|
| CustomCreatorNameForCustomQueryAndRangeCheck | string |
None. |
|
| IncludeOtherReasonForDataEntry | boolean |
None. |
|
| RefireMissingQueryOnDataUpdate | integer |
None. |
|
| RequireSignOnChanges | integer |
None. |
|
| DataEntryDateFormat | string |
None. |
|
| HasSiteSpecificCustomSubjectId | boolean |
None. |
|
| IsMedrioIdShown | boolean |
None. |
|
| IsSubjectEnrollmentAllowed | boolean |
None. |
|
| SubjectIdFormat | string |
None. |
|
| SubjectIdRegex | string |
None. |
|
| TimeZone | string |
None. |
|
| QueryDesignations | Collection of QueryDesignationDto |
None. |
|
| ReasonsForDataChange | Collection of ReasonForDataChangeDto |
None. |
|
| Variables | Collection of StudyVariableDto |
None. |
|
| Visits | Collection of VisitDto |
None. |
|
| Forms | Collection of StudyFormDto |
None. |
|
| Sites | Collection of ResearchSiteDto |
None. |
|
| Groups | Collection of GroupDto |
None. |
|
| ApprovalSteps | Collection of ApprovalStepDto |
None. |
|
| SubjectStatuses | Collection of SubjectStatusDto |
None. |
|
| FormRules | Collection of FormRuleDto |
None. |
|
| CustomQueryDefinitions | Collection of CustomQueryDefinitionDto |
None. |
|
| SkipRules | Collection of SkipRuleDto |
None. |
|
| Roles | Collection of MedrioRoleDto |
None. |
|
| IsFieldLevelAuditTrailEnabled | boolean |
None. |
|
| Languages | Dictionary of string [key] and string [value] |
None. |
|
| EproEnabled | boolean |
None. |
|
| SubjectEmailPHI | boolean |
None. |
|
| Version | integer |
None. |
|
| Id | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"title": "sample string 1",
"studyId": "d341af61-b576-4daf-abf8-119937dd5992",
"hasParentStudy": true,
"allowDeleteUnsynced": true,
"recommendedMaxSaveBatchSize": 5,
"configLastUpdatedTimestamp": "2025-04-25T06:31:28.7666756-05:00",
"displayOptionForQueryCreator": 7,
"customCreatorNameForManualQuery": "sample string 8",
"customCreatorNameForCustomQueryAndRangeCheck": "sample string 9",
"includeOtherReasonForDataEntry": true,
"refireMissingQueryOnDataUpdate": 11,
"requireSignOnChanges": 12,
"dataEntryDateFormat": "sample string 13",
"hasSiteSpecificCustomSubjectId": true,
"isMedrioIdShown": true,
"isSubjectEnrollmentAllowed": true,
"subjectIdFormat": "sample string 17",
"subjectIdRegex": "sample string 18",
"timeZone": "sample string 19",
"queryDesignations": [
{
"disabled": true,
"name": "sample string 2",
"version": 3,
"id": 4
},
{
"disabled": true,
"name": "sample string 2",
"version": 3,
"id": 4
}
],
"reasonsForDataChange": [
{
"fieldChangeEnabled": true,
"disabled": true,
"name": "sample string 3",
"version": 4,
"id": 5
},
{
"fieldChangeEnabled": true,
"disabled": true,
"name": "sample string 3",
"version": 4,
"id": 5
}
],
"variables": [
{
"isRequired": true,
"isReadOnly": true,
"controlType": 3,
"type": 4,
"yearRequired": true,
"monthRequired": true,
"dayRequired": true,
"includeFindForm": true,
"sliderMaxLabel": "sample string 6",
"sliderMidLabel": "sample string 7",
"sliderMinLabel": "sample string 8",
"sliderLabelDefinition": [
{
"id": 1,
"labelText": "sample string 2",
"location": "sample string 3",
"position": 4,
"tickMark": 5
},
{
"id": 1,
"labelText": "sample string 2",
"location": "sample string 3",
"position": 4,
"tickMark": 5
}
],
"sliderValueText": "sample string 9",
"showSliderValueOnSelection": true,
"sliderDisplaySelectedValue": true,
"sliderMinorTickMark": 12,
"sliderBeginningLabelAlignment": 13,
"sliderEndingLabelAlignment": 14,
"sliderValueTextLabelAlignment": 15,
"validationErrorMessage": "sample string 16",
"validationWarningMessage": "sample string 17",
"missingDataMessage": "sample string 18",
"timeFormat": 1,
"includeSeconds": true,
"showNowLink": true,
"precision": 20,
"maxDecimalPlace": 1,
"minIntegerLength": 1,
"maxIntegerLength": 1,
"length": 21,
"disabled": true,
"min": {},
"max": {},
"softMin": {},
"softMax": {},
"futureDateCheck": 27,
"patientIdentifiable": true,
"unit": "sample string 29",
"name": "sample string 30",
"enableQueryOnValidationWarning": true,
"enableQueryOnValidationError": true,
"enableQueryOnMissing": true,
"labelText": "sample string 34",
"validationErrorQueryDesignationId": 1,
"validationMissingQueryDesignationId": 1,
"validationWarningQueryDesignationId": 1,
"values": [
{
"value": {},
"disabled": true,
"isExclusionValue": true,
"displayOrder": 4,
"version": 5,
"id": 6
},
{
"value": {},
"disabled": true,
"isExclusionValue": true,
"displayOrder": 4,
"version": 5,
"id": 6
}
],
"version": 35,
"id": 36
},
{
"isRequired": true,
"isReadOnly": true,
"controlType": 3,
"type": 4,
"yearRequired": true,
"monthRequired": true,
"dayRequired": true,
"includeFindForm": true,
"sliderMaxLabel": "sample string 6",
"sliderMidLabel": "sample string 7",
"sliderMinLabel": "sample string 8",
"sliderLabelDefinition": [
{
"id": 1,
"labelText": "sample string 2",
"location": "sample string 3",
"position": 4,
"tickMark": 5
},
{
"id": 1,
"labelText": "sample string 2",
"location": "sample string 3",
"position": 4,
"tickMark": 5
}
],
"sliderValueText": "sample string 9",
"showSliderValueOnSelection": true,
"sliderDisplaySelectedValue": true,
"sliderMinorTickMark": 12,
"sliderBeginningLabelAlignment": 13,
"sliderEndingLabelAlignment": 14,
"sliderValueTextLabelAlignment": 15,
"validationErrorMessage": "sample string 16",
"validationWarningMessage": "sample string 17",
"missingDataMessage": "sample string 18",
"timeFormat": 1,
"includeSeconds": true,
"showNowLink": true,
"precision": 20,
"maxDecimalPlace": 1,
"minIntegerLength": 1,
"maxIntegerLength": 1,
"length": 21,
"disabled": true,
"min": {},
"max": {},
"softMin": {},
"softMax": {},
"futureDateCheck": 27,
"patientIdentifiable": true,
"unit": "sample string 29",
"name": "sample string 30",
"enableQueryOnValidationWarning": true,
"enableQueryOnValidationError": true,
"enableQueryOnMissing": true,
"labelText": "sample string 34",
"validationErrorQueryDesignationId": 1,
"validationMissingQueryDesignationId": 1,
"validationWarningQueryDesignationId": 1,
"values": [
{
"value": {},
"disabled": true,
"isExclusionValue": true,
"displayOrder": 4,
"version": 5,
"id": 6
},
{
"value": {},
"disabled": true,
"isExclusionValue": true,
"displayOrder": 4,
"version": 5,
"id": 6
}
],
"version": 35,
"id": 36
}
],
"visits": [
{
"name": "sample string 1",
"periodNumber": 2,
"disabled": true,
"isUnscheduled": true,
"repeatVisits": true,
"repeatLabelFormatType": 6,
"repeatLabelFormat": "sample string 7",
"minRepeatCount": 8,
"maxRepeatCount": 9,
"formCollections": [
{
"disabled": true,
"order": 2,
"repeatForms": true,
"repeatLabelFormatType": 4,
"repeatLabelFormat": "sample string 5",
"minRepeatCount": 6,
"maxRepeatCount": 7,
"isMsdeAllowed": true,
"formId": 9,
"formObjectCollections": [
{
"disabled": true,
"autoFillEnabled": true,
"autoFillOrder": 1,
"formObjectId": 3,
"formCollectionScheduleId": 4,
"version": 5,
"id": 6
},
{
"disabled": true,
"autoFillEnabled": true,
"autoFillOrder": 1,
"formObjectId": 3,
"formCollectionScheduleId": 4,
"version": 5,
"id": 6
}
],
"repeatSettings": [
{
"sequenceNumber": 1,
"label": "sample string 2",
"disabled": true,
"version": 4,
"id": 5
},
{
"sequenceNumber": 1,
"label": "sample string 2",
"disabled": true,
"version": 4,
"id": 5
}
],
"formRuleId": 1,
"version": 10,
"id": 11
},
{
"disabled": true,
"order": 2,
"repeatForms": true,
"repeatLabelFormatType": 4,
"repeatLabelFormat": "sample string 5",
"minRepeatCount": 6,
"maxRepeatCount": 7,
"isMsdeAllowed": true,
"formId": 9,
"formObjectCollections": [
{
"disabled": true,
"autoFillEnabled": true,
"autoFillOrder": 1,
"formObjectId": 3,
"formCollectionScheduleId": 4,
"version": 5,
"id": 6
},
{
"disabled": true,
"autoFillEnabled": true,
"autoFillOrder": 1,
"formObjectId": 3,
"formCollectionScheduleId": 4,
"version": 5,
"id": 6
}
],
"repeatSettings": [
{
"sequenceNumber": 1,
"label": "sample string 2",
"disabled": true,
"version": 4,
"id": 5
},
{
"sequenceNumber": 1,
"label": "sample string 2",
"disabled": true,
"version": 4,
"id": 5
}
],
"formRuleId": 1,
"version": 10,
"id": 11
}
],
"repeatSettings": [
{
"sequenceNumber": 1,
"label": "sample string 2",
"disabled": true,
"version": 4,
"id": 5
},
{
"sequenceNumber": 1,
"label": "sample string 2",
"disabled": true,
"version": 4,
"id": 5
}
],
"version": 10,
"id": 11
},
{
"name": "sample string 1",
"periodNumber": 2,
"disabled": true,
"isUnscheduled": true,
"repeatVisits": true,
"repeatLabelFormatType": 6,
"repeatLabelFormat": "sample string 7",
"minRepeatCount": 8,
"maxRepeatCount": 9,
"formCollections": [
{
"disabled": true,
"order": 2,
"repeatForms": true,
"repeatLabelFormatType": 4,
"repeatLabelFormat": "sample string 5",
"minRepeatCount": 6,
"maxRepeatCount": 7,
"isMsdeAllowed": true,
"formId": 9,
"formObjectCollections": [
{
"disabled": true,
"autoFillEnabled": true,
"autoFillOrder": 1,
"formObjectId": 3,
"formCollectionScheduleId": 4,
"version": 5,
"id": 6
},
{
"disabled": true,
"autoFillEnabled": true,
"autoFillOrder": 1,
"formObjectId": 3,
"formCollectionScheduleId": 4,
"version": 5,
"id": 6
}
],
"repeatSettings": [
{
"sequenceNumber": 1,
"label": "sample string 2",
"disabled": true,
"version": 4,
"id": 5
},
{
"sequenceNumber": 1,
"label": "sample string 2",
"disabled": true,
"version": 4,
"id": 5
}
],
"formRuleId": 1,
"version": 10,
"id": 11
},
{
"disabled": true,
"order": 2,
"repeatForms": true,
"repeatLabelFormatType": 4,
"repeatLabelFormat": "sample string 5",
"minRepeatCount": 6,
"maxRepeatCount": 7,
"isMsdeAllowed": true,
"formId": 9,
"formObjectCollections": [
{
"disabled": true,
"autoFillEnabled": true,
"autoFillOrder": 1,
"formObjectId": 3,
"formCollectionScheduleId": 4,
"version": 5,
"id": 6
},
{
"disabled": true,
"autoFillEnabled": true,
"autoFillOrder": 1,
"formObjectId": 3,
"formCollectionScheduleId": 4,
"version": 5,
"id": 6
}
],
"repeatSettings": [
{
"sequenceNumber": 1,
"label": "sample string 2",
"disabled": true,
"version": 4,
"id": 5
},
{
"sequenceNumber": 1,
"label": "sample string 2",
"disabled": true,
"version": 4,
"id": 5
}
],
"formRuleId": 1,
"version": 10,
"id": 11
}
],
"repeatSettings": [
{
"sequenceNumber": 1,
"label": "sample string 2",
"disabled": true,
"version": 4,
"id": 5
},
{
"sequenceNumber": 1,
"label": "sample string 2",
"disabled": true,
"version": 4,
"id": 5
}
],
"version": 10,
"id": 11
}
],
"forms": [
{
"specialFormType": 1,
"name": "sample string 2",
"disabled": true,
"order": 4,
"objects": null,
"version": 5,
"id": 6
},
{
"specialFormType": 1,
"name": "sample string 2",
"disabled": true,
"order": 4,
"objects": null,
"version": 5,
"id": 6
}
],
"sites": [
{
"name": "sample string 1",
"enrollmentGoal": 1,
"enrollmentLimit": 1,
"disabled": true,
"version": 3,
"id": 4
},
{
"name": "sample string 1",
"enrollmentGoal": 1,
"enrollmentLimit": 1,
"disabled": true,
"version": 3,
"id": 4
}
],
"groups": [
{
"name": "sample string 1",
"enrollmentGoal": 1,
"enrollmentLimit": 1,
"disabled": true,
"version": 3,
"id": 4
},
{
"name": "sample string 1",
"enrollmentGoal": 1,
"enrollmentLimit": 1,
"disabled": true,
"version": 3,
"id": 4
}
],
"approvalSteps": [
{
"name": "sample string 1",
"iconText": "sample string 2",
"isOpenQueriesAllowed": true,
"allowEditDataWithOpenQueries": 4,
"requireESignature": true,
"signingStatement": "sample string 6",
"disabled": true,
"appliesToAllForms": true,
"approvalStepRoleAssignments": null,
"approvalStepForms": [
{
"disabled": true,
"formId": 2,
"version": 3,
"id": 4
},
{
"disabled": true,
"formId": 2,
"version": 3,
"id": 4
}
],
"version": 9,
"id": 10
},
{
"name": "sample string 1",
"iconText": "sample string 2",
"isOpenQueriesAllowed": true,
"allowEditDataWithOpenQueries": 4,
"requireESignature": true,
"signingStatement": "sample string 6",
"disabled": true,
"appliesToAllForms": true,
"approvalStepRoleAssignments": null,
"approvalStepForms": [
{
"disabled": true,
"formId": 2,
"version": 3,
"id": 4
},
{
"disabled": true,
"formId": 2,
"version": 3,
"id": 4
}
],
"version": 9,
"id": 10
}
],
"subjectStatuses": [
{
"name": "sample string 1",
"enrolledStatus": true,
"disabledStatus": true,
"excludedStatus": true,
"order": 5,
"disabled": true,
"version": 7,
"id": 8
},
{
"name": "sample string 1",
"enrolledStatus": true,
"disabledStatus": true,
"excludedStatus": true,
"order": 5,
"disabled": true,
"version": 7,
"id": 8
}
],
"formRules": null,
"customQueryDefinitions": null,
"skipRules": null,
"roles": [
{
"name": "sample string 1",
"systemName": "sample string 2",
"description": "sample string 3",
"isReadOnly": true,
"rolePermissions": [
{
"formAccessOption": 1,
"permission": 1,
"roleId": 2,
"disabled": true,
"isReadOnly": true,
"formIds": [
1,
2
],
"rolePermissionForm": [
{
"formAccessOption": 1,
"formId": 2,
"disabled": true,
"version": 4,
"id": 5
},
{
"formAccessOption": 1,
"formId": 2,
"disabled": true,
"version": 4,
"id": 5
}
],
"version": 5,
"id": 6
},
{
"formAccessOption": 1,
"permission": 1,
"roleId": 2,
"disabled": true,
"isReadOnly": true,
"formIds": [
1,
2
],
"rolePermissionForm": [
{
"formAccessOption": 1,
"formId": 2,
"disabled": true,
"version": 4,
"id": 5
},
{
"formAccessOption": 1,
"formId": 2,
"disabled": true,
"version": 4,
"id": 5
}
],
"version": 5,
"id": 6
}
],
"approvalStepRoles": null,
"disabled": true,
"createUserId": 1,
"createdDate": "2025-04-25T06:31:28.7861918-05:00",
"isAdmin": true,
"requiresAllSites": true,
"version": 9,
"id": 10
},
{
"name": "sample string 1",
"systemName": "sample string 2",
"description": "sample string 3",
"isReadOnly": true,
"rolePermissions": [
{
"formAccessOption": 1,
"permission": 1,
"roleId": 2,
"disabled": true,
"isReadOnly": true,
"formIds": [
1,
2
],
"rolePermissionForm": [
{
"formAccessOption": 1,
"formId": 2,
"disabled": true,
"version": 4,
"id": 5
},
{
"formAccessOption": 1,
"formId": 2,
"disabled": true,
"version": 4,
"id": 5
}
],
"version": 5,
"id": 6
},
{
"formAccessOption": 1,
"permission": 1,
"roleId": 2,
"disabled": true,
"isReadOnly": true,
"formIds": [
1,
2
],
"rolePermissionForm": [
{
"formAccessOption": 1,
"formId": 2,
"disabled": true,
"version": 4,
"id": 5
},
{
"formAccessOption": 1,
"formId": 2,
"disabled": true,
"version": 4,
"id": 5
}
],
"version": 5,
"id": 6
}
],
"approvalStepRoles": null,
"disabled": true,
"createUserId": 1,
"createdDate": "2025-04-25T06:31:28.7861918-05:00",
"isAdmin": true,
"requiresAllSites": true,
"version": 9,
"id": 10
}
],
"isFieldLevelAuditTrailEnabled": true,
"languages": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"eproEnabled": true,
"subjectEmailPHI": true,
"version": 23,
"id": 24
}