Skip navigation links
A B C D E F G H I J K L M N O P Q R S T U V W Y Z _ 

A

AbstractStudyParticipant - Class in org.sagebionetworks.bridge.rest.model
Common fields for the SignUp and StudyParticipant payloads.
AbstractStudyParticipant() - Constructor for class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
 
ABTestGroup - Class in org.sagebionetworks.bridge.rest.model
A list of these groups define the way schedules are allocated in an ABTestScheduleStrategy (each schedule associated to a percentage).
ABTestGroup() - Constructor for class org.sagebionetworks.bridge.rest.model.ABTestGroup
 
ABTestScheduleStrategy - Class in org.sagebionetworks.bridge.rest.model
A strategy that divides users into groups according to a percentage scheme, assigning each group a different [Schedule](/#Schedule).
ABTestScheduleStrategy() - Constructor for class org.sagebionetworks.bridge.rest.model.ABTestScheduleStrategy
 
Account - Class in org.sagebionetworks.bridge.rest.model
Account record for administrative accounts.
Account() - Constructor for class org.sagebionetworks.bridge.rest.model.Account
 
accountLimit(Integer) - Method in class org.sagebionetworks.bridge.rest.model.App
 
AccountRef - Class in org.sagebionetworks.bridge.rest.model
Identifying fields for an account
AccountRef() - Constructor for class org.sagebionetworks.bridge.rest.model.AccountRef
 
AccountsApi - Interface in org.sagebionetworks.bridge.rest.api
 
AccountStatus - Enum in org.sagebionetworks.bridge.rest.model
Status of a participant's account, for accounts that must verify an email address.
AccountStatus.Adapter - Class in org.sagebionetworks.bridge.rest.model
 
AccountSummary - Class in org.sagebionetworks.bridge.rest.model
Summary of a participant, used in APIs to search and retrieve participant accounts.
AccountSummary() - Constructor for class org.sagebionetworks.bridge.rest.model.AccountSummary
 
AccountSummaryList - Class in org.sagebionetworks.bridge.rest.model
Payload returning a list of [AccountSummary](/#AccountSummary) records.
AccountSummaryList() - Constructor for class org.sagebionetworks.bridge.rest.model.AccountSummaryList
 
AccountSummarySearch - Class in org.sagebionetworks.bridge.rest.model
Search criteria to retrieve account summaries of study participants.
AccountSummarySearch() - Constructor for class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
 
activated(String) - Method in class org.sagebionetworks.bridge.rest.model.ColorScheme
 
activities(List<Activity>) - Method in class org.sagebionetworks.bridge.rest.model.Schedule
 
ActivitiesApi - Interface in org.sagebionetworks.bridge.rest.api
 
Activity - Class in org.sagebionetworks.bridge.rest.model
When creating an activity as part of a Schedule, you will need to supply a SurveyReference or a TaskReference in the activity.
Activity() - Constructor for class org.sagebionetworks.bridge.rest.model.Activity
 
ActivityEvent - Class in org.sagebionetworks.bridge.rest.model
Activity event for a participant, used for scheduling activities.
ActivityEvent() - Constructor for class org.sagebionetworks.bridge.rest.model.ActivityEvent
 
ActivityEventList - Class in org.sagebionetworks.bridge.rest.model
ActivityEventList
ActivityEventList() - Constructor for class org.sagebionetworks.bridge.rest.model.ActivityEventList
 
ActivityEventsApi - Interface in org.sagebionetworks.bridge.rest.api
 
ActivityEventUpdateType - Enum in org.sagebionetworks.bridge.rest.model
The type of update that is allowed on an activity event.
ActivityEventUpdateType.Adapter - Class in org.sagebionetworks.bridge.rest.model
 
ActivityList - Class in org.sagebionetworks.bridge.rest.model
ActivityList
ActivityList() - Constructor for class org.sagebionetworks.bridge.rest.model.ActivityList
 
activityType(ActivityType) - Method in class org.sagebionetworks.bridge.rest.model.Activity
 
ActivityType - Enum in org.sagebionetworks.bridge.rest.model
An activity represents either a survey or a task to be performed (not both).
ActivityType.Adapter - Class in org.sagebionetworks.bridge.rest.model
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.AccountStatus.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.ActivityEventUpdateType.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.ActivityType.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.AdherenceRecordType.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.ContactRole.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.CountryCode.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.DataType.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.EnrollmentFilter.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.Environment.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.FileDisposition.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.FileRevisionStatus.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.IrbDecisionType.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.MimeType.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.NotificationProtocol.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.NotificationType.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.Operator.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.PerformanceOrder.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.ReportType.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.ResourceCategory.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.Role.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.ScheduleStatus.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.ScheduleType.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.SearchTermPredicate.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.SharedModuleType.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.SharingScope.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.SignInType.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.SmsType.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.SortOrder.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.StringSearchPosition.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.StudyPhase.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.SynapseExporterStatus.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.TemplateType.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.UIHint.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.Unit.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.Upload.CompletedByEnum.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.UploadFieldType.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.UploadSchemaType.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.UploadStatus.Adapter
 
Adapter() - Constructor for class org.sagebionetworks.bridge.rest.model.UploadValidationStrictness.Adapter
 
addActivitiesItem(Activity) - Method in class org.sagebionetworks.bridge.rest.model.Schedule
 
addAdminIdsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.AppAndUsers
 
addAfterRulesItem(SurveyRule) - Method in class org.sagebionetworks.bridge.rest.model.SurveyElement
 
addAllOfGroupsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
 
addAllOfGroupsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.Criteria
 
addAllOfStudyIdsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.Criteria
 
addAndroidAppLinksItem(AndroidAppLink) - Method in class org.sagebionetworks.bridge.rest.model.App
 
addAppleAppLinksItem(AppleAppLink) - Method in class org.sagebionetworks.bridge.rest.model.App
 
addAssessmentIdsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
 
addAssessmentReferencesItem(AssessmentReference) - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
 
addAssessmentsItem(AssessmentReference2) - Method in class org.sagebionetworks.bridge.rest.model.Session
 
addBeforeRulesItem(SurveyRule) - Method in class org.sagebionetworks.bridge.rest.model.SurveyElement
 
addConfigReferencesItem(ConfigReference) - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
 
addContactsItem(Contact) - Method in class org.sagebionetworks.bridge.rest.model.Study
 
addContributorsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
 
addCreatorsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
 
addCustomEventsItem(CustomEvent) - Method in class org.sagebionetworks.bridge.rest.model.Study
 
addDataGroupsAssignedWhileConsentedItem(String) - Method in class org.sagebionetworks.bridge.rest.model.Subpopulation
 
addDataGroupsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
 
addDataGroupsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.Account
 
addDataGroupsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.App
 
addDataGroupsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.DataGroups
 
addDataGroupsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.SignUp
 
addDataGroupsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
 
addDataGroupsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.SurveyRule
 
addDiseasesItem(String) - Method in class org.sagebionetworks.bridge.rest.model.Study
 
addElementsItem(SurveyElement) - Method in class org.sagebionetworks.bridge.rest.model.Survey
 
addEnumerationItem(SurveyQuestionOption) - Method in class org.sagebionetworks.bridge.rest.model.MultiValueConstraints
 
addFieldDefinitionsItem(UploadFieldDefinition) - Method in class org.sagebionetworks.bridge.rest.model.UploadSchema
 
addFileReferencesItem(FileReference) - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
 
addFitBitScopesItem(String) - Method in class org.sagebionetworks.bridge.rest.model.App
 
addInstanceGuidsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
 
addLabelsItem(Label) - Method in class org.sagebionetworks.bridge.rest.model.Assessment
 
addLabelsItem(Label) - Method in class org.sagebionetworks.bridge.rest.model.AssessmentReference2
 
addLabelsItem(Label) - Method in class org.sagebionetworks.bridge.rest.model.Session
 
addLanguagesItem(String) - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
 
addLanguagesItem(String) - Method in class org.sagebionetworks.bridge.rest.model.Account
 
addLanguagesItem(String) - Method in class org.sagebionetworks.bridge.rest.model.SignUp
 
addLanguagesItem(String) - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
 
addMember(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Add user as a member of the organization (this will return an error if the user is already assigned to another organization).
addMember(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForOrgAdminsApi
Add user as a member of the organization (this will return an error if the user is already assigned to another organization).
addMember(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.OrganizationsApi
Add user as a member of the organization (this will return an error if the user is already assigned to another organization).
addMessagesItem(NotificationMessage) - Method in class org.sagebionetworks.bridge.rest.model.Notification
 
addMultiChoiceAnswerListItem(String) - Method in class org.sagebionetworks.bridge.rest.model.UploadFieldDefinition
 
addNewDefaultConsentRevision() - Method in interface org.sagebionetworks.bridge.rest.api.ConsentsApi
Deprecated. 
addNewDefaultConsentRevision() - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Deprecated. 
addNoneOfGroupsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
 
addNoneOfGroupsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.Criteria
 
addNoneOfStudyIdsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.Criteria
 
addNotificationsItem(Notification) - Method in class org.sagebionetworks.bridge.rest.model.Session
 
addParticipantReportRecord(String, ReportDataForWorker) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Add a participant report record Endpoint for a worker to add a report record for a participant.
addParticipantReportRecord(String, ReportDataForWorker) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantReportsApi
Add a participant report record Endpoint for a worker to add a report record for a participant.
addParticipantReportRecordV4(String, String, ReportData) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Add a participant report record The report can be accessed if the participant is requesting their own report, or the caller is a researcher, worker, or admin, or the caller is a study coordinator for a study that includes the participant.
addParticipantReportRecordV4(String, String, ReportData) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Add a participant report record The report can be accessed if the participant is requesting their own report, or the caller is a researcher, worker, or admin, or the caller is a study coordinator for a study that includes the participant.
addParticipantReportRecordV4(String, String, ReportData) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Add a participant report record The report can be accessed if the participant is requesting their own report, or the caller is a researcher, worker, or admin, or the caller is a study coordinator for a study that includes the participant.
addParticipantReportRecordV4(String, String, ReportData) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantReportsApi
Add a participant report record The report can be accessed if the participant is requesting their own report, or the caller is a researcher, worker, or admin, or the caller is a study coordinator for a study that includes the participant.
addPathsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.AppleAppLink
 
addPublishersItem(String) - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
 
addRecordIdsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.RecordExportStatusRequest
 
addRecordsItem(AdherenceRecord) - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordUpdates
 
Address - Class in org.sagebionetworks.bridge.rest.model
Address
Address() - Constructor for class org.sagebionetworks.bridge.rest.model.Address
 
address(Address) - Method in class org.sagebionetworks.bridge.rest.model.Contact
 
addRolesItem(Role) - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
 
addRolesItem(Role) - Method in class org.sagebionetworks.bridge.rest.model.Account
 
addRolesItem(Role) - Method in class org.sagebionetworks.bridge.rest.model.SignUp
 
addRolesItem(Role) - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
 
addScheduleCriteriaItem(ScheduleCriteria) - Method in class org.sagebionetworks.bridge.rest.model.CriteriaScheduleStrategy
 
addScheduleGroupsItem(ABTestGroup) - Method in class org.sagebionetworks.bridge.rest.model.ABTestScheduleStrategy
 
addSchemaListItem(SchemaReference) - Method in class org.sagebionetworks.bridge.rest.model.CompoundActivity
 
addSchemaListItem(SchemaReference) - Method in class org.sagebionetworks.bridge.rest.model.CompoundActivityDefinition
 
addSchemaReferencesItem(SchemaReference) - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
 
addSessionGuidsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
 
addSessionsItem(Session) - Method in class org.sagebionetworks.bridge.rest.model.Schedule2
 
addSha256CertFingerprintsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.AndroidAppLink
 
addSignInTypesItem(SignInType) - Method in class org.sagebionetworks.bridge.rest.model.Study
 
addStudyDesignTypesItem(String) - Method in class org.sagebionetworks.bridge.rest.model.Study
 
addStudyIdsAssignedOnConsentItem(String) - Method in class org.sagebionetworks.bridge.rest.model.Subpopulation
 
addStudyIdsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.ReportData
 
addStudyIdsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.ReportDataForWorker
 
addStudyIdsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.ReportIndex
 
addStudyReportRecord(String, ReportData) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Add a record to a study report Any member of an organization sponsoring a study, or any app-scoped administrative user, can access a study report.
addStudyReportRecord(String, ReportData) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Add a record to a study report Any member of an organization sponsoring a study, or any app-scoped administrative user, can access a study report.
addStudyReportRecord(String, ReportData) - Method in interface org.sagebionetworks.bridge.rest.api.StudyReportsApi
Add a record to a study report Any member of an organization sponsoring a study, or any app-scoped administrative user, can access a study report.
addStudySponsor(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Add this organization as a sponsor
addStudySponsor(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.OrganizationsApi
Add this organization as a sponsor
addStudySponsor(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.StudiesApi
Add this organization as a sponsor
addStudySponsorship(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Sponsor this study
addStudySponsorship(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.OrganizationsApi
Sponsor this study
addSurveyListItem(SurveyReference) - Method in class org.sagebionetworks.bridge.rest.model.CompoundActivity
 
addSurveyListItem(SurveyReference) - Method in class org.sagebionetworks.bridge.rest.model.CompoundActivityDefinition
 
addSurveyReferencesItem(SurveyReference) - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
 
addTag(Tag) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Create a tag if it does not yet exist.
addTag(Tag) - Method in interface org.sagebionetworks.bridge.rest.api.TagsApi
Create a tag if it does not yet exist.
addTagsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.Assessment
 
addTagsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleMetadata
 
addTaskIdentifiersItem(String) - Method in class org.sagebionetworks.bridge.rest.model.App
 
addTimesItem(String) - Method in class org.sagebionetworks.bridge.rest.model.Schedule
 
addTimeWindowGuidsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
 
addTimeWindowsItem(TimeWindow) - Method in class org.sagebionetworks.bridge.rest.model.Session
 
addTopicGuidsItem(String) - Method in class org.sagebionetworks.bridge.rest.model.SubscriptionRequest
 
addUploadMetadataFieldDefinitionsItem(UploadFieldDefinition) - Method in class org.sagebionetworks.bridge.rest.model.App
 
addUserProfileAttributesItem(String) - Method in class org.sagebionetworks.bridge.rest.model.App
 
addUserSessionInfoChangeListener(UserSessionInfoProvider.UserSessionInfoChangeListener) - Method in class org.sagebionetworks.bridge.rest.ApiClientProvider.AuthenticatedClientProviderBuilder
 
addUsersItem(StudyParticipant) - Method in class org.sagebionetworks.bridge.rest.model.AppAndUsers
 
AdherenceRecord - Class in org.sagebionetworks.bridge.rest.model
A record describing the performance state of a scheduled session or assessment, as requested in a `Timeline`.
AdherenceRecord() - Constructor for class org.sagebionetworks.bridge.rest.model.AdherenceRecord
 
AdherenceRecordList - Class in org.sagebionetworks.bridge.rest.model
AdherenceRecordList
AdherenceRecordList() - Constructor for class org.sagebionetworks.bridge.rest.model.AdherenceRecordList
 
AdherenceRecordsApi - Interface in org.sagebionetworks.bridge.rest.api
 
AdherenceRecordsSearch - Class in org.sagebionetworks.bridge.rest.model
AdherenceRecordsSearch
AdherenceRecordsSearch() - Constructor for class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
 
adherenceRecordType(AdherenceRecordType) - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
 
AdherenceRecordType - Enum in org.sagebionetworks.bridge.rest.model
The AdherenceRecordType can be used to limit search results for adherence records to either assessment or session records.
AdherenceRecordType.Adapter - Class in org.sagebionetworks.bridge.rest.model
 
AdherenceRecordUpdates - Class in org.sagebionetworks.bridge.rest.model
AdherenceRecordUpdates
AdherenceRecordUpdates() - Constructor for class org.sagebionetworks.bridge.rest.model.AdherenceRecordUpdates
 
adminChangeApp(SignIn) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Change the app a super administrator is in.
adminIds(List<String>) - Method in class org.sagebionetworks.bridge.rest.model.AppAndUsers
 
adminOnly(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
 
adminSignIn(SignIn) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Sign in using an administrative account.
affiliation(String) - Method in class org.sagebionetworks.bridge.rest.model.Contact
 
afterRules(List<SurveyRule>) - Method in class org.sagebionetworks.bridge.rest.model.SurveyElement
 
allOfGroups(List<String>) - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
 
allOfGroups(List<String>) - Method in class org.sagebionetworks.bridge.rest.model.Criteria
 
allOfStudyIds(List<String>) - Method in class org.sagebionetworks.bridge.rest.model.Criteria
 
allowFuture(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.DateConstraints
 
allowFuture(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.DateTimeConstraints
 
allowFuture(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.YearConstraints
 
allowFuture(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.YearMonthConstraints
 
allowMultiple(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.MultiValueConstraints
 
allowOther(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.MultiValueConstraints
 
allowOtherChoices(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.UploadFieldDefinition
 
allowPast(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.DateConstraints
 
allowPast(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.DateTimeConstraints
 
allowPast(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.YearConstraints
 
allowPast(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.YearMonthConstraints
 
allowSnooze(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.Notification
 
AndroidAppLink - Class in org.sagebionetworks.bridge.rest.model
AndroidAppLink
AndroidAppLink() - Constructor for class org.sagebionetworks.bridge.rest.model.AndroidAppLink
 
androidAppLinks(List<AndroidAppLink>) - Method in class org.sagebionetworks.bridge.rest.model.App
 
answerValue(String) - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEventRequest
 
ApiClientProvider - Class in org.sagebionetworks.bridge.rest
Base class for creating clients that are correctly configured to communicate with the Bridge server.
ApiClientProvider(String, String, String, String) - Constructor for class org.sagebionetworks.bridge.rest.ApiClientProvider
Creates a builder for accessing services associated with an environment and app.
ApiClientProvider(String, String, String, String, SocketFactory, List<Interceptor>, List<Interceptor>) - Constructor for class org.sagebionetworks.bridge.rest.ApiClientProvider
Creates a builder for accessing services associated with an environment and appId.
ApiClientProvider.AuthenticatedClientProvider - Class in org.sagebionetworks.bridge.rest
Base class for creating authenticated clients that are correctly configured to communicate with a Bridge study.
ApiClientProvider.AuthenticatedClientProviderBuilder - Class in org.sagebionetworks.bridge.rest
Builder for AuthenticatedClientProvider.
App - Class in org.sagebionetworks.bridge.rest.model
An app with its many configuration options.
App() - Constructor for class org.sagebionetworks.bridge.rest.model.App
 
app(App) - Method in class org.sagebionetworks.bridge.rest.model.AppAndUsers
 
AppAndUsers - Class in org.sagebionetworks.bridge.rest.model
The holder object for App, a list of User and a list of admin IDs
AppAndUsers() - Constructor for class org.sagebionetworks.bridge.rest.model.AppAndUsers
 
AppConfig - Class in org.sagebionetworks.bridge.rest.model
An app configuration object.
AppConfig() - Constructor for class org.sagebionetworks.bridge.rest.model.AppConfig
 
AppConfigElement - Class in org.sagebionetworks.bridge.rest.model
An element of an app configuration object.
AppConfigElement() - Constructor for class org.sagebionetworks.bridge.rest.model.AppConfigElement
 
AppConfigElementList - Class in org.sagebionetworks.bridge.rest.model
AppConfigElementList
AppConfigElementList() - Constructor for class org.sagebionetworks.bridge.rest.model.AppConfigElementList
 
AppConfigList - Class in org.sagebionetworks.bridge.rest.model
AppConfigList
AppConfigList() - Constructor for class org.sagebionetworks.bridge.rest.model.AppConfigList
 
AppConfigsApi - Interface in org.sagebionetworks.bridge.rest.api
 
appID(String) - Method in class org.sagebionetworks.bridge.rest.model.AppleAppLink
 
appId(String) - Method in class org.sagebionetworks.bridge.rest.model.AssessmentReference2
 
appId(String) - Method in class org.sagebionetworks.bridge.rest.model.EmailSignIn
 
appId(String) - Method in class org.sagebionetworks.bridge.rest.model.EmailSignInRequest
 
appId(String) - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordEx3
 
appId(String) - Method in class org.sagebionetworks.bridge.rest.model.Identifier
 
appId(String) - Method in class org.sagebionetworks.bridge.rest.model.IntentToParticipate
 
appId(String) - Method in class org.sagebionetworks.bridge.rest.model.OAuthAuthorizationToken
 
appId(String) - Method in class org.sagebionetworks.bridge.rest.model.PhoneSignIn
 
appId(String) - Method in class org.sagebionetworks.bridge.rest.model.PhoneSignInRequest
 
appId(String) - Method in class org.sagebionetworks.bridge.rest.model.SignIn
 
appId(String) - Method in class org.sagebionetworks.bridge.rest.model.SignUp
 
appId(String) - Method in class org.sagebionetworks.bridge.rest.model.SmsMessage
 
appIdExcludedInExport(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.App
 
AppleAppLink - Class in org.sagebionetworks.bridge.rest.model
AppleAppLink
AppleAppLink() - Constructor for class org.sagebionetworks.bridge.rest.model.AppleAppLink
 
appleAppLinks(List<AppleAppLink>) - Method in class org.sagebionetworks.bridge.rest.model.App
 
AppList - Class in org.sagebionetworks.bridge.rest.model
AppList
AppList() - Constructor for class org.sagebionetworks.bridge.rest.model.AppList
 
appName(String) - Method in class org.sagebionetworks.bridge.rest.model.ClientInfo
 
AppsApi - Interface in org.sagebionetworks.bridge.rest.api
 
appVersion(Integer) - Method in class org.sagebionetworks.bridge.rest.model.ClientInfo
 
appVersion(String) - Method in class org.sagebionetworks.bridge.rest.model.HealthDataSubmission
 
Assessment - Class in org.sagebionetworks.bridge.rest.model
The assessment object contains the general cataloguing information we have on an assessment, and includes both a set of links to documents that describe the assessment and its use, as well as a configuration object for client applications.
Assessment() - Constructor for class org.sagebionetworks.bridge.rest.model.Assessment
 
AssessmentConfig - Class in org.sagebionetworks.bridge.rest.model
AssessmentConfig
AssessmentConfig() - Constructor for class org.sagebionetworks.bridge.rest.model.AssessmentConfig
 
assessmentIds(List<String>) - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
 
AssessmentInfo - Class in org.sagebionetworks.bridge.rest.model
Information about an assessment in order to render it in a UI prior to execution.
AssessmentInfo() - Constructor for class org.sagebionetworks.bridge.rest.model.AssessmentInfo
 
AssessmentList - Class in org.sagebionetworks.bridge.rest.model
AssessmentList
AssessmentList() - Constructor for class org.sagebionetworks.bridge.rest.model.AssessmentList
 
AssessmentReference - Class in org.sagebionetworks.bridge.rest.model
A pointer to an assessment revision.
AssessmentReference() - Constructor for class org.sagebionetworks.bridge.rest.model.AssessmentReference
 
AssessmentReference2 - Class in org.sagebionetworks.bridge.rest.model
A pointer to an assessment revision.
AssessmentReference2() - Constructor for class org.sagebionetworks.bridge.rest.model.AssessmentReference2
 
assessmentReferences(List<AssessmentReference>) - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
 
assessments(List<AssessmentReference2>) - Method in class org.sagebionetworks.bridge.rest.model.Session
 
AssessmentsApi - Interface in org.sagebionetworks.bridge.rest.api
 
assignDataGroup(String) - Method in class org.sagebionetworks.bridge.rest.model.SurveyRule
 
attributeKey(String) - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
 
attributes(Map<String, String>) - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
 
attributes(Map<String, String>) - Method in class org.sagebionetworks.bridge.rest.model.Account
 
attributes(Map<String, String>) - Method in class org.sagebionetworks.bridge.rest.model.AccountSummary
 
attributes(Map<String, String>) - Method in class org.sagebionetworks.bridge.rest.model.SignUp
 
attributes(Map<String, String>) - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
 
attributeValueFilter(String) - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
 
AuthenticationApi - Interface in org.sagebionetworks.bridge.rest.api
 
AuthenticationFailedException - Exception in org.sagebionetworks.bridge.rest.exceptions
 
AuthenticationFailedException(String, String) - Constructor for exception org.sagebionetworks.bridge.rest.exceptions.AuthenticationFailedException
 
authToken(String) - Method in class org.sagebionetworks.bridge.rest.model.OAuthAuthorizationToken
 
automaticCustomEvents(Map<String, String>) - Method in class org.sagebionetworks.bridge.rest.model.App
 
autoSendConsentSuppressed(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.Subpopulation
 
autoVerificationEmailSuppressed(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.App
 
autoVerificationPhoneSuppressed(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.App
 

B

background(String) - Method in class org.sagebionetworks.bridge.rest.model.ColorScheme
 
BadRequestException - Exception in org.sagebionetworks.bridge.rest.exceptions
 
BadRequestException(String, String) - Constructor for exception org.sagebionetworks.bridge.rest.exceptions.BadRequestException
 
BadRequestException(Throwable, String) - Constructor for exception org.sagebionetworks.bridge.rest.exceptions.BadRequestException
 
beforeRules(List<SurveyRule>) - Method in class org.sagebionetworks.bridge.rest.model.SurveyElement
 
birthdate(LocalDate) - Method in class org.sagebionetworks.bridge.rest.model.ConsentSignature
 
BloodPressureConstraints - Class in org.sagebionetworks.bridge.rest.model
Systolic and diastolic systemic arterial pressure.
BloodPressureConstraints() - Constructor for class org.sagebionetworks.bridge.rest.model.BloodPressureConstraints
 
BooleanConstraints - Class in org.sagebionetworks.bridge.rest.model
**UI hints:** checkbox, toggle.
BooleanConstraints() - Constructor for class org.sagebionetworks.bridge.rest.model.BooleanConstraints
 
BridgeSDKException - Exception in org.sagebionetworks.bridge.rest.exceptions
 
BridgeSDKException(String, Throwable, String) - Constructor for exception org.sagebionetworks.bridge.rest.exceptions.BridgeSDKException
 
BridgeSDKException(String, int, String) - Constructor for exception org.sagebionetworks.bridge.rest.exceptions.BridgeSDKException
 
BridgeSDKException(Throwable, int, String) - Constructor for exception org.sagebionetworks.bridge.rest.exceptions.BridgeSDKException
 
BridgeSDKException(String, Throwable) - Constructor for exception org.sagebionetworks.bridge.rest.exceptions.BridgeSDKException
 
BridgeSDKException(String, int) - Constructor for exception org.sagebionetworks.bridge.rest.exceptions.BridgeSDKException
 
BridgeServiceException - Exception in org.sagebionetworks.bridge.rest.exceptions
 
BridgeServiceException(String, String) - Constructor for exception org.sagebionetworks.bridge.rest.exceptions.BridgeServiceException
 
build() - Method in class org.sagebionetworks.bridge.rest.ApiClientProvider.AuthenticatedClientProviderBuilder
Builds an AuthenticatedClientProvider.
build() - Method in class org.sagebionetworks.bridge.rest.ClientManager.Builder
 
Builder() - Constructor for class org.sagebionetworks.bridge.rest.ClientManager.Builder
 

C

callbackUrl(String) - Method in class org.sagebionetworks.bridge.rest.model.OAuthAuthorizationToken
 
callbackUrl(String) - Method in class org.sagebionetworks.bridge.rest.model.OAuthProvider
 
category(ResourceCategory) - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
 
changeApp(SignIn) - Method in interface org.sagebionetworks.bridge.rest.api.AppsApi
Change the app currently associate with the signed in caller's session.
changeApp(SignIn) - Method in interface org.sagebionetworks.bridge.rest.api.AuthenticationApi
Change the app currently associate with the signed in caller's session.
checkForConsent(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.SignUp
 
city(String) - Method in class org.sagebionetworks.bridge.rest.model.Address
 
clientData(Object) - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
 
clientData(Object) - Method in class org.sagebionetworks.bridge.rest.model.Account
 
clientData(Object) - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecord
 
clientData(Object) - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
 
clientData(Object) - Method in class org.sagebionetworks.bridge.rest.model.Schedule2
 
clientData(Object) - Method in class org.sagebionetworks.bridge.rest.model.ScheduledActivity
 
clientData(Object) - Method in class org.sagebionetworks.bridge.rest.model.SignUp
 
clientData(Object) - Method in class org.sagebionetworks.bridge.rest.model.Study
 
clientData(Object) - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
 
clientId(String) - Method in class org.sagebionetworks.bridge.rest.model.OAuthProvider
 
ClientInfo - Class in org.sagebionetworks.bridge.rest.model
Describes the content of the `User-Agent` field in the format that is accepted and understandable to the Bridge server (see [REST API getting started](/articles/rest.html)).
ClientInfo() - Constructor for class org.sagebionetworks.bridge.rest.model.ClientInfo
 
clientInfo(String) - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordEx3
 
ClientManager - Class in org.sagebionetworks.bridge.rest
ClientManager provides support for configuring API classes using values set via a properties file (~/bridge-sdk.properties), from environment variables, or from Java system variables.
ClientManager.Builder - Class in org.sagebionetworks.bridge.rest
 
clientTimeZone(String) - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
 
clientTimeZone(String) - Method in class org.sagebionetworks.bridge.rest.model.Account
 
clientTimeZone(String) - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecord
 
clientTimeZone(String) - Method in class org.sagebionetworks.bridge.rest.model.SignUp
 
clientTimeZone(String) - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEvent
 
clientTimeZone(String) - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEventRequest
 
clientTimeZone(String) - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
 
CmsPublicKey - Class in org.sagebionetworks.bridge.rest.model
A JSON payload that includes the base 64 encoded, public key for CMS encryption of uploads for this app.
CmsPublicKey() - Constructor for class org.sagebionetworks.bridge.rest.model.CmsPublicKey
 
colorScheme(ColorScheme) - Method in class org.sagebionetworks.bridge.rest.model.Assessment
 
colorScheme(ColorScheme) - Method in class org.sagebionetworks.bridge.rest.model.AssessmentReference2
 
ColorScheme - Class in org.sagebionetworks.bridge.rest.model
Colors to differentiate this assessment in a UI.
ColorScheme() - Constructor for class org.sagebionetworks.bridge.rest.model.ColorScheme
 
colorScheme(ColorScheme) - Method in class org.sagebionetworks.bridge.rest.model.Study
 
completeUploadSession(String, Boolean, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Notify Bridge an upload is complete Notify Bridge an upload is complete.
completeUploadSession(String, Boolean, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Notify Bridge an upload is complete Notify Bridge an upload is complete.
completeUploadSession(String, Boolean, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.UploadsApi
Notify Bridge an upload is complete Notify Bridge an upload is complete.
compoundActivity(CompoundActivity) - Method in class org.sagebionetworks.bridge.rest.model.Activity
 
CompoundActivity - Class in org.sagebionetworks.bridge.rest.model
A pointer to a compound activity, which represents multiple schemas or survey's worth of tasks for a user to perform.
CompoundActivity() - Constructor for class org.sagebionetworks.bridge.rest.model.CompoundActivity
 
CompoundActivityDefinition - Class in org.sagebionetworks.bridge.rest.model
A compound activity definition, which lives outside of but parallel to a schedule plan.
CompoundActivityDefinition() - Constructor for class org.sagebionetworks.bridge.rest.model.CompoundActivityDefinition
 
CompoundActivityDefinitionList - Class in org.sagebionetworks.bridge.rest.model
CompoundActivityDefinitionList
CompoundActivityDefinitionList() - Constructor for class org.sagebionetworks.bridge.rest.model.CompoundActivityDefinitionList
 
CompoundActivityDefinitionsApi - Interface in org.sagebionetworks.bridge.rest.api
 
ConcurrentModificationException - Exception in org.sagebionetworks.bridge.rest.exceptions
 
ConcurrentModificationException(String, String) - Constructor for exception org.sagebionetworks.bridge.rest.exceptions.ConcurrentModificationException
 
Config - Class in org.sagebionetworks.bridge.rest
The Config class provides the implementation for loading configuration for the ClientManager.
Config() - Constructor for class org.sagebionetworks.bridge.rest.Config
 
config(Object) - Method in class org.sagebionetworks.bridge.rest.model.AssessmentConfig
 
Config.Props - Enum in org.sagebionetworks.bridge.rest
 
configElements(Map<String, Object>) - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
 
ConfigReference - Class in org.sagebionetworks.bridge.rest.model
A pointer to a configuration element.
ConfigReference() - Constructor for class org.sagebionetworks.bridge.rest.model.ConfigReference
 
configReferences(List<ConfigReference>) - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
 
consent(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.SignUp
 
consented(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
 
consentHTML(String) - Method in class org.sagebionetworks.bridge.rest.model.Subpopulation
 
consentNotificationEmail(String) - Method in class org.sagebionetworks.bridge.rest.model.App
 
consentNotificationEmailVerified(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.App
 
consentPDF(String) - Method in class org.sagebionetworks.bridge.rest.model.Subpopulation
 
consentRequired(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.Enrollment
 
ConsentRequiredException - Exception in org.sagebionetworks.bridge.rest.exceptions
 
ConsentRequiredException(String, String, UserSessionInfo) - Constructor for exception org.sagebionetworks.bridge.rest.exceptions.ConsentRequiredException
 
ConsentsApi - Interface in org.sagebionetworks.bridge.rest.api
 
ConsentSignature - Class in org.sagebionetworks.bridge.rest.model
To consent to participation in a subpopulation (also known as a consent group), participants submit their electronic signature.
ConsentSignature() - Constructor for class org.sagebionetworks.bridge.rest.model.ConsentSignature
 
consentSignature(ConsentSignature) - Method in class org.sagebionetworks.bridge.rest.model.IntentToParticipate
 
ConsentStatus - Class in org.sagebionetworks.bridge.rest.model
A description of the participant's consent status in a particular subpopulation (consent group).
ConsentStatus() - Constructor for class org.sagebionetworks.bridge.rest.model.ConsentStatus
 
Constraints - Class in org.sagebionetworks.bridge.rest.model
Constraints
Constraints() - Constructor for class org.sagebionetworks.bridge.rest.model.Constraints
 
constraints(Constraints) - Method in class org.sagebionetworks.bridge.rest.model.SurveyQuestion
 
ConstraintViolationException - Exception in org.sagebionetworks.bridge.rest.exceptions
 
ConstraintViolationException(String, String) - Constructor for exception org.sagebionetworks.bridge.rest.exceptions.ConstraintViolationException
 
Contact - Class in org.sagebionetworks.bridge.rest.model
A contact for the study.
Contact() - Constructor for class org.sagebionetworks.bridge.rest.model.Contact
 
ContactRole - Enum in org.sagebionetworks.bridge.rest.model
The purpose of this contact.
ContactRole.Adapter - Class in org.sagebionetworks.bridge.rest.model
 
contacts(List<Contact>) - Method in class org.sagebionetworks.bridge.rest.model.Study
 
contentLength(Long) - Method in class org.sagebionetworks.bridge.rest.model.UploadRequest
 
contentMd5(String) - Method in class org.sagebionetworks.bridge.rest.model.UploadRequest
 
contentType(String) - Method in class org.sagebionetworks.bridge.rest.model.UploadRequest
 
contributors(List<String>) - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
 
copyrightNotice(String) - Method in class org.sagebionetworks.bridge.rest.model.Survey
 
country(String) - Method in class org.sagebionetworks.bridge.rest.model.Address
 
CountryCode - Enum in org.sagebionetworks.bridge.rest.model
The country code of origin of a postal code (ISO 3166-1 alpha-2 format).
countryCode(CountryCode) - Method in class org.sagebionetworks.bridge.rest.model.PostalCodeConstraints
 
CountryCode.Adapter - Class in org.sagebionetworks.bridge.rest.model
 
createAccount(Account) - Method in interface org.sagebionetworks.bridge.rest.api.AccountsApi
Create an administrative account
createAccount(Account) - Method in interface org.sagebionetworks.bridge.rest.api.ForOrgAdminsApi
Create an administrative account
createActivityEventForParticipant(String, CustomActivityEventRequest) - Method in interface org.sagebionetworks.bridge.rest.api.ActivityEventsApi
Create a custom event for a participant This endpoint can be called by researchers in order to create an activity event for a participant.
createActivityEventForParticipant(String, CustomActivityEventRequest) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Create a custom event for a participant This endpoint can be called by researchers in order to create an activity event for a participant.
createApp(App) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Create a new app
createAppAndUsers(AppAndUsers) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Create a new app with administrators and users Create a new app along with the access team and project in Synapse to receive data collected through Bridge.
createAppConfig(AppConfig) - Method in interface org.sagebionetworks.bridge.rest.api.AppConfigsApi
Create a new app config Create a new app configuration object.
createAppConfig(AppConfig) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Create a new app config Create a new app configuration object.
createAppConfigElement(AppConfigElement) - Method in interface org.sagebionetworks.bridge.rest.api.AppConfigsApi
Create a new app config element Create a new app configuration element.
createAppConfigElement(AppConfigElement) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Create a new app config element Create a new app configuration element.
createAssessment(Assessment) - Method in interface org.sagebionetworks.bridge.rest.api.AssessmentsApi
Create a new assessment.
createAssessment(Assessment) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Create a new assessment.
createAssessment(Assessment) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Create a new assessment.
createAssessmentResource(String, ExternalResource) - Method in interface org.sagebionetworks.bridge.rest.api.AssessmentsApi
Create a new external resource link documenting an assessment
createAssessmentResource(String, ExternalResource) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Create a new external resource link documenting an assessment
createAssessmentResource(String, ExternalResource) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Create a new external resource link documenting an assessment
createAssessmentRevision(String, Assessment) - Method in interface org.sagebionetworks.bridge.rest.api.AssessmentsApi
Create a new revision of an assessment.
createAssessmentRevision(String, Assessment) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Create a new revision of an assessment.
createAssessmentRevision(String, Assessment) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Create a new revision of an assessment.
createCompoundActivityDefinition(CompoundActivityDefinition) - Method in interface org.sagebionetworks.bridge.rest.api.CompoundActivityDefinitionsApi
Create a compound activity definition
createCompoundActivityDefinition(CompoundActivityDefinition) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Create a compound activity definition
createConsent(String, StudyConsent) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Add a new study consent version to this subpopulation
createConsent(String, StudyConsent) - Method in interface org.sagebionetworks.bridge.rest.api.StudyConsentsApi
Add a new study consent version to this subpopulation
createConsentSignature(String, ConsentSignature) - Method in interface org.sagebionetworks.bridge.rest.api.ConsentsApi
Consent to this subpopulation by submitting a signature Agree to the terms of participant represented by this subpopulation, by submitting a signature to the Bridge server.
createConsentSignature(String, ConsentSignature) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Consent to this subpopulation by submitting a signature Agree to the terms of participant represented by this subpopulation, by submitting a signature to the Bridge server.
createCustomActivityEvent(CustomActivityEventRequest) - Method in interface org.sagebionetworks.bridge.rest.api.ActivityEventsApi
Create an app-scoped activity event for the current user Create an app-scoped activity event for the current user.
createCustomActivityEvent(CustomActivityEventRequest) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Create an app-scoped activity event for the current user Create an app-scoped activity event for the current user.
createdAtRevision(Integer) - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
 
createdOn(DateTime) - Method in class org.sagebionetworks.bridge.rest.model.FileReference
 
createdOn(DateTime) - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordEx3
 
createdOn(DateTime) - Method in class org.sagebionetworks.bridge.rest.model.HealthDataSubmission
 
createdOn(DateTime) - Method in class org.sagebionetworks.bridge.rest.model.ParticipantFile
 
createdOn(DateTime) - Method in class org.sagebionetworks.bridge.rest.model.StudyConsent
 
createdOn(DateTime) - Method in class org.sagebionetworks.bridge.rest.model.Survey
 
createdOn(DateTime) - Method in class org.sagebionetworks.bridge.rest.model.SurveyReference
 
CreatedOnHolder - Class in org.sagebionetworks.bridge.rest.model
An object that provides the creation timestamp for a newly created entity.
CreatedOnHolder() - Constructor for class org.sagebionetworks.bridge.rest.model.CreatedOnHolder
 
createFile(FileMetadata) - Method in interface org.sagebionetworks.bridge.rest.api.FilesApi
Create a new file resource Create a new file resource (this is just the metadata, and will need to be followed by the creation and upload of a FileRevision object).
createFile(FileMetadata) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Create a new file resource Create a new file resource (this is just the metadata, and will need to be followed by the creation and upload of a FileRevision object).
createFileRevision(String, FileRevision) - Method in interface org.sagebionetworks.bridge.rest.api.FilesApi
Create a new file resource revision.
createFileRevision(String, FileRevision) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Create a new file resource revision.
createMetadata(SharedModuleMetadata) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Creates the specified module metadata.
createMetadata(SharedModuleMetadata) - Method in interface org.sagebionetworks.bridge.rest.api.SharedModulesApi
Creates the specified module metadata.
createNotificationRegistration(NotificationRegistration) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Register a client to receive push notifications Create a new registration.
createNotificationTopic(NotificationTopic) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Create a notification topic Create a notification topic.
createNotificationTopic(NotificationTopic) - Method in interface org.sagebionetworks.bridge.rest.api.NotificationsApi
Create a notification topic Create a notification topic.
createOrganization(Organization) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Create a new organization Create a new organization.
createOrganization(Organization) - Method in interface org.sagebionetworks.bridge.rest.api.OrganizationsApi
Create a new organization Create a new organization.
createOrUpdateRecordEx3(HealthDataRecordEx3) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Create or update health data record using the Exporter 3 implementation.
createOrUpdateRecordEx3(HealthDataRecordEx3) - Method in interface org.sagebionetworks.bridge.rest.api.InternalApi
Create or update health data record using the Exporter 3 implementation.
createOrUpdateUploadSchema(UploadSchema) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Deprecated. 
createOrUpdateUploadSchema(UploadSchema) - Method in interface org.sagebionetworks.bridge.rest.api.UploadSchemasApi
Deprecated. 
createParticipant(SignUp) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Create a new study participant (user)
createParticipant(SignUp) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
Create a new study participant (user)
createParticipantFile(String, ParticipantFile) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Create a new participant file
createParticipantFile(String, ParticipantFile) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantFilesApi
Create a new participant file
createSchedulePlan(SchedulePlan) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Create a schedule plan
createSchedulePlan(SchedulePlan) - Method in interface org.sagebionetworks.bridge.rest.api.SchedulesV1Api
Create a schedule plan
createSchedulerConfig(MasterSchedulerConfig) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Create a scheduler config
createSmsRegistration(String) - Method in interface org.sagebionetworks.bridge.rest.api.InternalApi
Create an SMS notification registration for the given user.
createStudy(Study) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Create a new study
createStudy(Study) - Method in interface org.sagebionetworks.bridge.rest.api.ForOrgAdminsApi
Create a new study
createStudy(Study) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Create a new study
createStudy(Study) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Create a new study
createStudy(Study) - Method in interface org.sagebionetworks.bridge.rest.api.StudiesApi
Create a new study
createStudyActivityEvent(String, StudyActivityEventRequest) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Create a new activity event for the caller in this study.
createStudyActivityEvent(String, StudyActivityEventRequest) - Method in interface org.sagebionetworks.bridge.rest.api.StudiesApi
Create a new activity event for the caller in this study.
createStudyActivityEvent(String, StudyActivityEventRequest) - Method in interface org.sagebionetworks.bridge.rest.api.StudyActivityEventsApi
Create a new activity event for the caller in this study.
createStudyLogo(String, FileRevision) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Create a new study logo handle for uploading a study logo.
createStudyLogo(String, FileRevision) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Create a new study logo handle for uploading a study logo.
createStudyLogo(String, FileRevision) - Method in interface org.sagebionetworks.bridge.rest.api.StudiesApi
Create a new study logo handle for uploading a study logo.
createStudyParticipant(String, SignUp) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Create a new study participant who will be enrolled (but not consented) in this study.
createStudyParticipant(String, SignUp) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Create a new study participant who will be enrolled (but not consented) in this study.
createStudyParticipant(String, SignUp) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
Create a new study participant who will be enrolled (but not consented) in this study.
createStudyParticipantStudyActivityEvent(String, String, StudyActivityEventRequest) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Create a new activity event for a participant in this study.
createStudyParticipantStudyActivityEvent(String, String, StudyActivityEventRequest) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Create a new activity event for a participant in this study.
createStudyParticipantStudyActivityEvent(String, String, StudyActivityEventRequest) - Method in interface org.sagebionetworks.bridge.rest.api.StudyActivityEventsApi
Create a new activity event for a participant in this study.
createStudyParticipantStudyActivityEvent(String, String, StudyActivityEventRequest) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
Create a new activity event for a participant in this study.
createSubpopulation(Subpopulation) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Create a new subpopulation
createSubpopulation(Subpopulation) - Method in interface org.sagebionetworks.bridge.rest.api.SubpopulationsApi
Create a new subpopulation
createSurvey(Survey) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Create a new survey
createSurvey(Survey) - Method in interface org.sagebionetworks.bridge.rest.api.SurveysApi
Create a new survey
createSynapseProjectTeam(List<String>) - Method in interface org.sagebionetworks.bridge.rest.api.AppsApi
Create new Synapse project and team Create a new Synapse project and team for the provided Synapse user, and grant permissions to the Bridge exporter to export Bridge data into that app.
createSynapseProjectTeam(List<String>) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Create new Synapse project and team Create a new Synapse project and team for the provided Synapse user, and grant permissions to the Bridge exporter to export Bridge data into that app.
createTemplate(Template) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Create a new template Create a new template.
createTemplate(Template) - Method in interface org.sagebionetworks.bridge.rest.api.TemplatesApi
Create a new template Create a new template.
createTemplateRevision(String, TemplateRevision) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Create a new revision of a template
createTemplateRevision(String, TemplateRevision) - Method in interface org.sagebionetworks.bridge.rest.api.TemplatesApi
Create a new revision of a template
createUploadSchema(UploadSchema) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Create an upload schema
createUploadSchema(UploadSchema) - Method in interface org.sagebionetworks.bridge.rest.api.UploadSchemasApi
Create an upload schema
createUser(SignUp) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Create a new user
createUserInApp(String, SignUp) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Create a new user in a given app
creators(List<String>) - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
 
criteria(Criteria) - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
 
Criteria - Class in org.sagebionetworks.bridge.rest.model
Some objects, like Subpopulations and the schedules in a CriteriaScheduleStrategy, are matched against user criteria in order to return the correct object.
Criteria() - Constructor for class org.sagebionetworks.bridge.rest.model.Criteria
 
criteria(Criteria) - Method in class org.sagebionetworks.bridge.rest.model.NotificationTopic
 
criteria(Criteria) - Method in class org.sagebionetworks.bridge.rest.model.ScheduleCriteria
 
criteria(Criteria) - Method in class org.sagebionetworks.bridge.rest.model.Subpopulation
 
criteria(Criteria) - Method in class org.sagebionetworks.bridge.rest.model.Template
 
CriteriaScheduleStrategy - Class in org.sagebionetworks.bridge.rest.model
Contains a list of schedules, each of which is associated to a specific [Criteria](/#Criteria) object.
CriteriaScheduleStrategy() - Constructor for class org.sagebionetworks.bridge.rest.model.CriteriaScheduleStrategy
 
cronSchedule(String) - Method in class org.sagebionetworks.bridge.rest.model.MasterSchedulerConfig
 
cronTrigger(String) - Method in class org.sagebionetworks.bridge.rest.model.Schedule
 
currentTimestampsOnly(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
 
CustomActivityEventRequest - Class in org.sagebionetworks.bridge.rest.model
Request object for creating a Custom Activity Event.
CustomActivityEventRequest() - Constructor for class org.sagebionetworks.bridge.rest.model.CustomActivityEventRequest
 
CustomEvent - Class in org.sagebionetworks.bridge.rest.model
A study can define one or more unique event identifiers against which a schedule can be designed.
CustomEvent() - Constructor for class org.sagebionetworks.bridge.rest.model.CustomEvent
 
customEvents(Map<String, ActivityEventUpdateType>) - Method in class org.sagebionetworks.bridge.rest.model.App
 
customEvents(List<CustomEvent>) - Method in class org.sagebionetworks.bridge.rest.model.Study
 
customizationFields(Map<String, List<PropertyInfo>>) - Method in class org.sagebionetworks.bridge.rest.model.Assessment
 
customizeAssessmentConfig(String, Object) - Method in interface org.sagebionetworks.bridge.rest.api.AssessmentsApi
Submit updates to the config that conform to the allowed customizations for the assessment.
customizeAssessmentConfig(String, Object) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Submit updates to the config that conform to the allowed customizations for the assessment.
customizeAssessmentConfig(String, Object) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Submit updates to the config that conform to the allowed customizations for the assessment.

D

data(Object) - Method in class org.sagebionetworks.bridge.rest.model.AppConfigElement
 
data(Object) - Method in class org.sagebionetworks.bridge.rest.model.HealthDataSubmission
 
data(Object) - Method in class org.sagebionetworks.bridge.rest.model.ParticipantData
 
data(Object) - Method in class org.sagebionetworks.bridge.rest.model.ReportData
 
data(Object) - Method in class org.sagebionetworks.bridge.rest.model.ReportDataForWorker
 
dataGroups(List<String>) - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
 
dataGroups(List<String>) - Method in class org.sagebionetworks.bridge.rest.model.Account
 
dataGroups(List<String>) - Method in class org.sagebionetworks.bridge.rest.model.App
 
DataGroups - Class in org.sagebionetworks.bridge.rest.model
A payload that contains a string array of data groups.
DataGroups() - Constructor for class org.sagebionetworks.bridge.rest.model.DataGroups
 
dataGroups(List<String>) - Method in class org.sagebionetworks.bridge.rest.model.DataGroups
 
dataGroups(List<String>) - Method in class org.sagebionetworks.bridge.rest.model.SignUp
 
dataGroups(List<String>) - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
 
dataGroups(List<String>) - Method in class org.sagebionetworks.bridge.rest.model.SurveyRule
 
dataGroupsAssignedWhileConsented(List<String>) - Method in class org.sagebionetworks.bridge.rest.model.Subpopulation
 
dataType(DataType) - Method in class org.sagebionetworks.bridge.rest.model.Constraints
 
DataType - Enum in org.sagebionetworks.bridge.rest.model
The data type of the answer to a question.
DataType.Adapter - Class in org.sagebionetworks.bridge.rest.model
 
date(String) - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
 
date(String) - Method in class org.sagebionetworks.bridge.rest.model.ReportData
 
date(LocalDate) - Method in class org.sagebionetworks.bridge.rest.model.ReportDataForWorker
 
DateConstraints - Class in org.sagebionetworks.bridge.rest.model
A date without a time value (e.g.
DateConstraints() - Constructor for class org.sagebionetworks.bridge.rest.model.DateConstraints
 
DateRange - Class in org.sagebionetworks.bridge.rest.model
Model object representing a date range, which includes start date and end date as calendar dates (YYYY-MM-DD).
DateRange() - Constructor for class org.sagebionetworks.bridge.rest.model.DateRange
 
dateTime(DateTime) - Method in class org.sagebionetworks.bridge.rest.model.ReportData
 
dateTime(DateTime) - Method in class org.sagebionetworks.bridge.rest.model.ReportDataForWorker
 
DateTimeConstraints - Class in org.sagebionetworks.bridge.rest.model
**UI hints:** datetimepicker.
DateTimeConstraints() - Constructor for class org.sagebionetworks.bridge.rest.model.DateTimeConstraints
 
DateTimeHolder - Class in org.sagebionetworks.bridge.rest.model
An object that provides a timestamp.
DateTimeHolder() - Constructor for class org.sagebionetworks.bridge.rest.model.DateTimeHolder
 
DecimalConstraints - Class in org.sagebionetworks.bridge.rest.model
A floating point value.
DecimalConstraints() - Constructor for class org.sagebionetworks.bridge.rest.model.DecimalConstraints
 
declined(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecord
 
defaultGroup(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.Subpopulation
 
defaultTemplates(Map<String, String>) - Method in class org.sagebionetworks.bridge.rest.model.App
 
delay(String) - Method in class org.sagebionetworks.bridge.rest.model.Schedule
 
delay(String) - Method in class org.sagebionetworks.bridge.rest.model.Session
 
deleteAccount(String) - Method in interface org.sagebionetworks.bridge.rest.api.AccountsApi
Delete an administrative account
deleteAccount(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForOrgAdminsApi
Delete an administrative account
deleteAdherenceRecord(String, String, String, DateTime, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.AdherenceRecordsApi
Delete an adherence record Delete an existing adherence record
deleteAdherenceRecord(String, String, String, DateTime, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Delete an adherence record Delete an existing adherence record
deleteAdherenceRecord(String, String, String, DateTime, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Delete an adherence record Delete an existing adherence record
deleteAllAppConfigElementRevisions(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.AppConfigsApi
Delete all revisions of an app config element Delete all revisions of an app config element.
deleteAllAppConfigElementRevisions(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete all revisions of an app config element Delete all revisions of an app config element.
deleteAllAppConfigElementRevisions(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Delete all revisions of an app config element Delete all revisions of an app config element.
deleteAllParticipantDataForAdmin(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete all participant data Endpoint for admin to delete all participant data for the given participant.
deleteAllParticipantDataForAdmin(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantDataApi
Delete all participant data Endpoint for admin to delete all participant data for the given participant.
deleteAllParticipantReportRecords(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Delete a participant report (all records)
deleteAllParticipantReportRecords(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Delete a participant report (all records)
deleteAllParticipantReportRecords(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantReportsApi
Delete a participant report (all records)
deleteAllRevisionsOfUploadSchema(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete all revisions of an upload schema
deleteAllRevisionsOfUploadSchema(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Delete all revisions of an upload schema
deleteAllRevisionsOfUploadSchema(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.UploadSchemasApi
Delete all revisions of an upload schema
deleteAllStudyReportRecords(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Delete a study report (all records)
deleteAllStudyReportRecords(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Delete a study report (all records)
deleteAllStudyReportRecords(String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyReportsApi
Delete a study report (all records)
deleteApp(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Delete a app
deleteAppConfig(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.AppConfigsApi
Delete an app config Delete an existing configuration object.
deleteAppConfig(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete an app config Delete an existing configuration object.
deleteAppConfig(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Delete an app config Delete an existing configuration object.
deleteAppConfigElement(String, Long, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.AppConfigsApi
Delete an app config element Delete an existing configuration element.
deleteAppConfigElement(String, Long, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete an app config element Delete an existing configuration element.
deleteAppConfigElement(String, Long, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Delete an app config element Delete an existing configuration element.
deleteAssessment(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.AssessmentsApi
Delete an assessment revision.
deleteAssessment(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete an assessment revision.
deleteAssessment(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Delete an assessment revision.
deleteAssessment(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Delete an assessment revision.
deleteAssessmentResource(String, String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.AssessmentsApi
Delete an external resource link documenting an assessment
deleteAssessmentResource(String, String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete an external resource link documenting an assessment
deleteAssessmentResource(String, String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Delete an external resource link documenting an assessment
deleteAssessmentResource(String, String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Delete an external resource link documenting an assessment
deleteCacheKeys(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Get all the non-session Redis keys
deleteCompoundActivityDefinition(String) - Method in interface org.sagebionetworks.bridge.rest.api.CompoundActivityDefinitionsApi
Delete a compound activity definition
deleteCompoundActivityDefinition(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Delete a compound activity definition
deleteCustomActivityEvent(String) - Method in interface org.sagebionetworks.bridge.rest.api.ActivityEventsApi
Delete a custom activity event.
deleteCustomActivityEvent(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Delete a custom activity event.
deleted(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
 
deleted(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.AppConfigElement
 
deleted(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.Assessment
 
deleted(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
 
deleted(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.FileMetadata
 
deleted(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.NotificationTopic
 
deleted(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.Schedule2
 
deleted(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.SchedulePlan
 
deleted(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleMetadata
 
deleted(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.Study
 
deleted(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.Survey
 
deleted(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.Template
 
deleted(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.UploadSchema
 
deleteDataByIdentifier(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
delete a participant data record
deleteDataByIdentifier(String) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantDataApi
delete a participant data record
deleteDataByIdentifier(String) - Method in interface org.sagebionetworks.bridge.rest.api.UsersApi
delete a participant data record
deleteDataForAdmin(String, String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete a participant data Endpoint for admin to delete a participnt data.
deleteDataForAdmin(String, String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantDataApi
Delete a participant data Endpoint for admin to delete a participnt data.
deleteExternalId(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete an external ID
deleteExternalId(String) - Method in interface org.sagebionetworks.bridge.rest.api.StudiesApi
Delete an external ID
deleteFile(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.FilesApi
Delete file resource (and all revisions) Delete an existing file resource (and all its revisions, if the delete is physical).
deleteFile(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete file resource (and all revisions) Delete an existing file resource (and all its revisions, if the delete is physical).
deleteFile(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Delete file resource (and all revisions) Delete an existing file resource (and all its revisions, if the delete is physical).
deleteMetadataByIdAllVersions(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Deletes all metadata for module versions with the given ID.
deleteMetadataByIdAllVersions(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Deletes all metadata for module versions with the given ID.
deleteMetadataByIdAllVersions(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.SharedModulesApi
Deletes all metadata for module versions with the given ID.
deleteMetadataByIdAndVersion(String, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Deletes metadata for the specified module ID and version.
deleteMetadataByIdAndVersion(String, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Deletes metadata for the specified module ID and version.
deleteMetadataByIdAndVersion(String, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.SharedModulesApi
Deletes metadata for the specified module ID and version.
deleteNotificationRegistration(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Delete a push notification registration Delete a registration record.
deleteNotificationTopic(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete a notification topic
deleteNotificationTopic(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Delete a notification topic
deleteNotificationTopic(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.NotificationsApi
Delete a notification topic
deleteOrganization(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete an organization.
deleteOrganization(String) - Method in interface org.sagebionetworks.bridge.rest.api.OrganizationsApi
Delete an organization.
deleteParticipantActivities(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Delete all activities for a participant Intended for use in development.
deleteParticipantActivities(String) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
Delete all activities for a participant Intended for use in development.
deleteParticipantFile(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Delete a participant file Delete a participant file
deleteParticipantFile(String) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantFilesApi
Delete a participant file Delete a participant file
deleteParticipantReportIndex(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete a participant report index Delete a participant report index.
deleteParticipantReportRecord(String, String, LocalDate) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Delete a record for a specific day of a participant report
deleteParticipantReportRecord(String, String, LocalDate) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Delete a record for a specific day of a participant report
deleteParticipantReportRecord(String, String, LocalDate) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantReportsApi
Delete a record for a specific day of a participant report
deleteRecordsEx3ForUser(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Deletes all health data records from the Exporter 3 implementation for the given user.
deleteRecordsEx3ForUser(String) - Method in interface org.sagebionetworks.bridge.rest.api.InternalApi
Deletes all health data records from the Exporter 3 implementation for the given user.
deleteSchedule(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete a schedule.
deleteSchedule(String) - Method in interface org.sagebionetworks.bridge.rest.api.SchedulesV2Api
Delete a schedule.
deleteSchedulePlan(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Get a schedule plan
deleteSchedulePlan(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a schedule plan
deleteSchedulePlan(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.SchedulesV1Api
Get a schedule plan
deleteSchedulerConfig(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Delete a scheduler config
deleteSharedAssessment(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Delete an assessment revision.
deleteSharedAssessment(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.SharedAssessmentsApi
Delete an assessment revision.
deleteSharedAssessmentResource(String, String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Delete an external resource link documenting a shared assessment
deleteSharedAssessmentResource(String, String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.SharedAssessmentsApi
Delete an external resource link documenting a shared assessment
deleteStudy(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete a study.
deleteStudy(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Delete a study.
deleteStudy(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Delete a study.
deleteStudy(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.StudiesApi
Delete a study.
deleteStudyActivityEvent(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Delete a custom activity event (for the caller).
deleteStudyActivityEvent(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.StudiesApi
Delete a custom activity event (for the caller).
deleteStudyActivityEvent(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyActivityEventsApi
Delete a custom activity event (for the caller).
deleteStudyParticipantStudyActivityEvent(String, String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Delete custom activity event for a study participant
deleteStudyParticipantStudyActivityEvent(String, String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Delete custom activity event for a study participant
deleteStudyParticipantStudyActivityEvent(String, String, String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyActivityEventsApi
Delete custom activity event for a study participant
deleteStudyParticipantStudyActivityEvent(String, String, String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
Delete custom activity event for a study participant
deleteStudyReportRecord(String, LocalDate) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Delete a record for a specific day of a study report
deleteStudyReportRecord(String, LocalDate) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Delete a record for a specific day of a study report
deleteStudyReportRecord(String, LocalDate) - Method in interface org.sagebionetworks.bridge.rest.api.StudyReportsApi
Delete a record for a specific day of a study report
deleteSubpopulation(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete a subpopulation Delete a subpopulation unless it is a default subpopulation, which cannot be deleted.
deleteSubpopulation(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Delete a subpopulation Delete a subpopulation unless it is a default subpopulation, which cannot be deleted.
deleteSubpopulation(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.SubpopulationsApi
Delete a subpopulation Delete a subpopulation unless it is a default subpopulation, which cannot be deleted.
deleteSurvey(String, DateTime, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete a survey version
deleteSurvey(String, DateTime, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Delete a survey version
deleteSurvey(String, DateTime, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.SurveysApi
Delete a survey version
deleteTag(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Delete a tag
deleteTag(String) - Method in interface org.sagebionetworks.bridge.rest.api.TagsApi
Delete a tag
deleteTemplate(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete template (and all revisions) Delete an existing template (and all its revisions).
deleteTemplate(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Delete template (and all revisions) Delete an existing template (and all its revisions).
deleteTemplate(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.TemplatesApi
Delete template (and all revisions) Delete an existing template (and all its revisions).
deleteTestParticipant(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Delete an account with a `test_user` data group.
deleteTestParticipant(String) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
Delete an account with a `test_user` data group.
deleteTestStudyParticipant(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Delete a study participant with a `test_user` data group.
deleteTestStudyParticipant(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Delete a study participant with a `test_user` data group.
deleteTestStudyParticipant(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
Delete a study participant with a `test_user` data group.
deleteUploadSchema(String, Long, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete the specific revision of an upload schema
deleteUploadSchema(String, Long, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Delete the specific revision of an upload schema
deleteUploadSchema(String, Long, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.UploadSchemasApi
Delete the specific revision of an upload schema
deleteUser(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Delete a user This is a heavyweight operation; it is better to disable a user account when possible.
description(String) - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
 
description(String) - Method in class org.sagebionetworks.bridge.rest.model.FileMetadata
 
description(String) - Method in class org.sagebionetworks.bridge.rest.model.FileRevision
 
description(String) - Method in class org.sagebionetworks.bridge.rest.model.NotificationTopic
 
description(String) - Method in class org.sagebionetworks.bridge.rest.model.Organization
 
description(String) - Method in class org.sagebionetworks.bridge.rest.model.PropertyInfo
 
description(String) - Method in class org.sagebionetworks.bridge.rest.model.Subpopulation
 
description(String) - Method in class org.sagebionetworks.bridge.rest.model.Template
 
detail(String) - Method in class org.sagebionetworks.bridge.rest.model.SurveyQuestionOption
 
details(String) - Method in class org.sagebionetworks.bridge.rest.model.Study
 
deviceId(String) - Method in class org.sagebionetworks.bridge.rest.model.NotificationRegistration
 
deviceName(String) - Method in class org.sagebionetworks.bridge.rest.model.ClientInfo
 
disableExport(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.App
 
diseases(List<String>) - Method in class org.sagebionetworks.bridge.rest.model.Study
 
displayIf(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.SurveyRule
 
displayUnless(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.SurveyRule
 
disposition(FileDisposition) - Method in class org.sagebionetworks.bridge.rest.model.FileMetadata
 
division(String) - Method in class org.sagebionetworks.bridge.rest.model.Address
 
documentContent(String) - Method in class org.sagebionetworks.bridge.rest.model.StudyConsent
 
documentContent(String) - Method in class org.sagebionetworks.bridge.rest.model.TemplateRevision
 
downloadUrl(String) - Method in class org.sagebionetworks.bridge.rest.model.ParticipantFile
 
duration(String) - Method in class org.sagebionetworks.bridge.rest.model.Schedule2
 
DurationConstraints - Class in org.sagebionetworks.bridge.rest.model
Deprecated.
DurationConstraints() - Constructor for class org.sagebionetworks.bridge.rest.model.DurationConstraints
 

E

earliestValue(LocalDate) - Method in class org.sagebionetworks.bridge.rest.model.DateConstraints
 
earliestValue(DateTime) - Method in class org.sagebionetworks.bridge.rest.model.DateTimeConstraints
 
earliestValue(String) - Method in class org.sagebionetworks.bridge.rest.model.YearConstraints
 
earliestValue(String) - Method in class org.sagebionetworks.bridge.rest.model.YearMonthConstraints
 
elements(List<SurveyElement>) - Method in class org.sagebionetworks.bridge.rest.model.Survey
 
email(String) - Method in class org.sagebionetworks.bridge.rest.model.Account
 
email(String) - Method in class org.sagebionetworks.bridge.rest.model.Contact
 
email(String) - Method in class org.sagebionetworks.bridge.rest.model.EmailSignIn
 
email(String) - Method in class org.sagebionetworks.bridge.rest.model.EmailSignInRequest
 
email(String) - Method in class org.sagebionetworks.bridge.rest.model.Identifier
 
email(String) - Method in class org.sagebionetworks.bridge.rest.model.IntentToParticipate
 
email(String) - Method in class org.sagebionetworks.bridge.rest.model.SignIn
 
email(String) - Method in class org.sagebionetworks.bridge.rest.model.SignUp
 
email(String) - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
 
emailFilter(String) - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
 
EmailSignIn - Class in org.sagebionetworks.bridge.rest.model
Using a token supplied in an email to the participant, authenticate with the server.
EmailSignIn() - Constructor for class org.sagebionetworks.bridge.rest.model.EmailSignIn
 
emailSignInEnabled(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.App
 
EmailSignInRequest - Class in org.sagebionetworks.bridge.rest.model
Make a request to sign in through an email.
EmailSignInRequest() - Constructor for class org.sagebionetworks.bridge.rest.model.EmailSignInRequest
 
emailUpdate(String) - Method in class org.sagebionetworks.bridge.rest.model.IdentifierUpdate
 
emailVerificationEnabled(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.App
 
EmailVerificationStatus - Class in org.sagebionetworks.bridge.rest.model
The status of the email address that will be used to send consents to users.
EmailVerificationStatus() - Constructor for class org.sagebionetworks.bridge.rest.model.EmailVerificationStatus
 
emailVerified(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
 
emailVerified(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.Account
 
emailVerified(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.SignUp
 
emailVerified(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
 
encrypted(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.Upload
 
encrypted(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.UploadRequest
 
endDate(LocalDate) - Method in class org.sagebionetworks.bridge.rest.model.DateRange
 
endpoint(String) - Method in class org.sagebionetworks.bridge.rest.model.NotificationRegistration
 
endpoint(String) - Method in class org.sagebionetworks.bridge.rest.model.OAuthProvider
 
EndpointNotFoundException - Exception in org.sagebionetworks.bridge.rest.exceptions
 
EndpointNotFoundException(String, String) - Constructor for exception org.sagebionetworks.bridge.rest.exceptions.EndpointNotFoundException
 
endsOn(DateTime) - Method in class org.sagebionetworks.bridge.rest.model.Schedule
 
endSurvey(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.SurveyRule
 
endTime(DateTime) - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
 
endTime(DateTime) - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
 
enrolledBy(String) - Method in class org.sagebionetworks.bridge.rest.model.Enrollment
 
enrolledInStudyId(String) - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
 
enrolledOn(DateTime) - Method in class org.sagebionetworks.bridge.rest.model.Enrollment
 
enrollment(EnrollmentFilter) - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
 
Enrollment - Class in org.sagebionetworks.bridge.rest.model
An enrollment of a user in a study
Enrollment() - Constructor for class org.sagebionetworks.bridge.rest.model.Enrollment
 
EnrollmentDetail - Class in org.sagebionetworks.bridge.rest.model
Details about the enrollment of a user in a study
EnrollmentDetail() - Constructor for class org.sagebionetworks.bridge.rest.model.EnrollmentDetail
 
EnrollmentDetailList - Class in org.sagebionetworks.bridge.rest.model
EnrollmentDetailList
EnrollmentDetailList() - Constructor for class org.sagebionetworks.bridge.rest.model.EnrollmentDetailList
 
EnrollmentFilter - Enum in org.sagebionetworks.bridge.rest.model
Filter information about the enrollees in a study (these are people who consented to participate in the research, whether through Bridge or external to the system).
EnrollmentFilter.Adapter - Class in org.sagebionetworks.bridge.rest.model
 
enrollParticipant(String, Enrollment) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Enroll an account in a study as a participant.
enrollParticipant(String, Enrollment) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Enroll an account in a study as a participant.
enrollParticipant(String, Enrollment) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Enroll an account in a study as a participant.
enrollParticipant(String, Enrollment) - Method in interface org.sagebionetworks.bridge.rest.api.StudiesApi
Enroll an account in a study as a participant.
enrollParticipant(String, Enrollment) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
Enroll an account in a study as a participant.
EntityAlreadyExistsException - Exception in org.sagebionetworks.bridge.rest.exceptions
 
EntityAlreadyExistsException(String, String) - Constructor for exception org.sagebionetworks.bridge.rest.exceptions.EntityAlreadyExistsException
 
EntityNotFoundException - Exception in org.sagebionetworks.bridge.rest.exceptions
 
EntityNotFoundException(String, String) - Constructor for exception org.sagebionetworks.bridge.rest.exceptions.EntityNotFoundException
 
enumeration(List<SurveyQuestionOption>) - Method in class org.sagebionetworks.bridge.rest.model.MultiValueConstraints
 
Environment - Enum in org.sagebionetworks.bridge.rest.model
This value should always be set to production.
Environment.Adapter - Class in org.sagebionetworks.bridge.rest.model
 
equals(Object) - Method in exception org.sagebionetworks.bridge.rest.exceptions.BridgeSDKException
 
equals(Object) - Method in exception org.sagebionetworks.bridge.rest.exceptions.InvalidEntityException
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ABTestGroup
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ABTestScheduleStrategy
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Account
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AccountRef
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AccountSummary
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AccountSummaryList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Activity
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ActivityEvent
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ActivityEventList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ActivityList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Address
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecord
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordUpdates
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AndroidAppLink
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.App
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AppAndUsers
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AppConfigElement
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AppConfigElementList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AppConfigList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AppleAppLink
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AppList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Assessment
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AssessmentConfig
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AssessmentInfo
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AssessmentList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AssessmentReference
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.AssessmentReference2
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.BloodPressureConstraints
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.BooleanConstraints
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ClientInfo
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.CmsPublicKey
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ColorScheme
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.CompoundActivity
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.CompoundActivityDefinition
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.CompoundActivityDefinitionList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ConfigReference
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ConsentSignature
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ConsentStatus
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Constraints
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Contact
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.CreatedOnHolder
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Criteria
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.CriteriaScheduleStrategy
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.CustomActivityEventRequest
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.CustomEvent
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.DataGroups
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.DateConstraints
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.DateRange
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.DateTimeConstraints
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.DateTimeHolder
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.DecimalConstraints
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.DurationConstraints
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.EmailSignIn
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.EmailSignInRequest
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.EmailVerificationStatus
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Enrollment
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.EnrollmentDetail
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.EnrollmentDetailList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ExternalIdentifier
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ExternalIdentifierList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ExternalResourceList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.FileMetadata
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.FileMetadataList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.FileReference
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.FileRevision
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.FileRevisionList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ForwardCursorPagedResourceList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ForwardCursorReportDataList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ForwardCursorScheduledActivityList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ForwardCursorStringList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.GeneratedPassword
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.GuidCreatedOnVersionHolder
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.GuidHolder
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.GuidVersionHolder
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecord
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordEx3
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordEx3List
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.HealthDataSubmission
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.HeightConstraints
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Identifier
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.IdentifierHolder
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.IdentifierUpdate
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Image
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.IntegerConstraints
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.IntentToParticipate
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.InvalidEntity
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Label
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.MasterSchedulerConfig
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.MasterSchedulerConfigList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Message
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.MultiValueConstraints
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Notification
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.NotificationInfo
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.NotificationMessage
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.NotificationRegistration
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.NotificationRegistrationList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.NotificationTopic
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.NotificationTopicList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.OAuthAccessToken
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.OAuthAuthorizationToken
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.OAuthProvider
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Organization
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.OrganizationList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.PagedExternalResourceList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.PagedResourceList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ParticipantData
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ParticipantDataList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ParticipantFile
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ParticipantFileList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ParticipantRosterRequest
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.PasswordPolicy
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.PasswordReset
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Phone
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.PhoneSignIn
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.PhoneSignInRequest
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.PostalCodeConstraints
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.PropertyInfo
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.RecordExportStatusRequest
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ReportData
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ReportDataForWorker
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ReportDataList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ReportIndex
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ReportIndexList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.RequestInfo
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ResourceList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Schedule
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Schedule2
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ScheduleCriteria
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ScheduledActivity
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ScheduledActivityList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ScheduledActivityListV4
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ScheduledAssessment
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ScheduledSession
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ScheduleList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SchedulePlan
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SchedulePlanList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.ScheduleStrategy
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SchemaReference
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Session
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SessionInfo
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleImportStatus
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleMetadata
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleMetadataList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SharingScopeForm
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SignIn
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SignUp
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SimpleScheduleStrategy
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SmsMessage
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SmsTemplate
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.StringConstraints
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.StringList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Study
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEvent
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEventList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEventPagedList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEventRequest
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.StudyConsent
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.StudyConsentList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.StudyInfo
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.StudyList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Subpopulation
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SubpopulationList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SubscriptionRequest
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SubscriptionStatus
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SubscriptionStatusList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Survey
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SurveyElement
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SurveyInfoScreen
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SurveyList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SurveyQuestion
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SurveyQuestionOption
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SurveyReference
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.SurveyRule
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Tag
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.TaskReference
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Template
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.TemplateList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.TemplateRevision
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.TemplateRevisionList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.TimeConstraints
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Timeline
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.TimeWindow
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Upload
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.UploadFieldDefinition
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.UploadList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.UploadRequest
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.UploadSchema
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.UploadSchemaList
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.UploadSession
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.UploadValidationStatus
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.UserConsentHistory
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Verification
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.VersionHolder
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.WeightConstraints
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.Withdrawal
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.YearConstraints
 
equals(Object) - Method in class org.sagebionetworks.bridge.rest.model.YearMonthConstraints
 
eventId(String) - Method in class org.sagebionetworks.bridge.rest.model.ActivityEvent
 
eventId(String) - Method in class org.sagebionetworks.bridge.rest.model.CustomActivityEventRequest
 
eventId(String) - Method in class org.sagebionetworks.bridge.rest.model.CustomEvent
 
eventId(String) - Method in class org.sagebionetworks.bridge.rest.model.Schedule
 
eventId(String) - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEvent
 
eventId(String) - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEventRequest
 
eventTimestamp(DateTime) - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecord
 
eventTimestamps(Map<String, DateTime>) - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
 
exclusive(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.SurveyQuestionOption
 
expiration(String) - Method in class org.sagebionetworks.bridge.rest.model.TimeWindow
 
expires(String) - Method in class org.sagebionetworks.bridge.rest.model.Schedule
 
exported(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordEx3
 
externalId(String) - Method in class org.sagebionetworks.bridge.rest.model.Enrollment
 
externalId(String) - Method in class org.sagebionetworks.bridge.rest.model.SignIn
 
externalId(String) - Method in class org.sagebionetworks.bridge.rest.model.SignUp
 
ExternalIdentifier - Class in org.sagebionetworks.bridge.rest.model
An external identifier assigned to a participant's account to allow external re-identification of the user by the study sponsor.
ExternalIdentifier() - Constructor for class org.sagebionetworks.bridge.rest.model.ExternalIdentifier
 
ExternalIdentifierList - Class in org.sagebionetworks.bridge.rest.model
ExternalIdentifierList
ExternalIdentifierList() - Constructor for class org.sagebionetworks.bridge.rest.model.ExternalIdentifierList
 
externalIdFilter(String) - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
 
externalIdRequiredOnSignup(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.App
 
externalIds(Map<String, String>) - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
 
externalIds(Map<String, String>) - Method in class org.sagebionetworks.bridge.rest.model.SignUp
 
externalIds(Map<String, String>) - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
 
ExternalResource - Class in org.sagebionetworks.bridge.rest.model
An external identifier assigned to a participant's account to allow external re-identification of the user by the study sponsor.
ExternalResource() - Constructor for class org.sagebionetworks.bridge.rest.model.ExternalResource
 
ExternalResourceList - Class in org.sagebionetworks.bridge.rest.model
ExternalResourceList
ExternalResourceList() - Constructor for class org.sagebionetworks.bridge.rest.model.ExternalResourceList
 

F

fieldDefinitions(List<UploadFieldDefinition>) - Method in class org.sagebionetworks.bridge.rest.model.UploadSchema
 
FileDisposition - Enum in org.sagebionetworks.bridge.rest.model
When served by the host server, files can be sent with a `Content-Disposition` header that indicates to web clients how the file should be displayed.
FileDisposition.Adapter - Class in org.sagebionetworks.bridge.rest.model
 
fileExtension(String) - Method in class org.sagebionetworks.bridge.rest.model.UploadFieldDefinition
 
fileGuid(String) - Method in class org.sagebionetworks.bridge.rest.model.FileRevision
 
fileId(String) - Method in class org.sagebionetworks.bridge.rest.model.ParticipantFile
 
FileMetadata - Class in org.sagebionetworks.bridge.rest.model
A descriptor of a static file resource (image, XML file, video file, etc.) that is hosted via the Bridge server
FileMetadata() - Constructor for class org.sagebionetworks.bridge.rest.model.FileMetadata
 
FileMetadataList - Class in org.sagebionetworks.bridge.rest.model
FileMetadataList
FileMetadataList() - Constructor for class org.sagebionetworks.bridge.rest.model.FileMetadataList
 
FileReference - Class in org.sagebionetworks.bridge.rest.model
A pointer to a file revision hosted for this app.
FileReference() - Constructor for class org.sagebionetworks.bridge.rest.model.FileReference
 
fileReferences(List<FileReference>) - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
 
FileRevision - Class in org.sagebionetworks.bridge.rest.model
An object that tracks the existence of an individual revision of a file resource in S3.
FileRevision() - Constructor for class org.sagebionetworks.bridge.rest.model.FileRevision
 
FileRevisionList - Class in org.sagebionetworks.bridge.rest.model
FileRevisionList
FileRevisionList() - Constructor for class org.sagebionetworks.bridge.rest.model.FileRevisionList
 
FileRevisionStatus - Enum in org.sagebionetworks.bridge.rest.model
|State|Description| |---|---| |pending|The client has requested and created a `FileRevision` object, and must now PUT the actual file resource to S3, using the `uploadURL` in the `FileRevision` object.| |available|The client has called the `finishFileRevision` endpoint and the server confirmed that the file is available.|
FileRevisionStatus.Adapter - Class in org.sagebionetworks.bridge.rest.model
 
FilesApi - Interface in org.sagebionetworks.bridge.rest.api
 
finishedOn(DateTime) - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecord
 
finishedOn(DateTime) - Method in class org.sagebionetworks.bridge.rest.model.ScheduledActivity
 
finishFileRevision(String, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.FilesApi
Indicate to the server that a file revision upload has been completed.
finishFileRevision(String, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Indicate to the server that a file revision upload has been completed.
finishStudyLogoUpload(String, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Confirm with the Bridge server that the logo has been uploaded to S3.
finishStudyLogoUpload(String, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Confirm with the Bridge server that the logo has been uploaded to S3.
finishStudyLogoUpload(String, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.StudiesApi
Confirm with the Bridge server that the logo has been uploaded to S3.
firstName(String) - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
 
firstName(String) - Method in class org.sagebionetworks.bridge.rest.model.Account
 
firstName(String) - Method in class org.sagebionetworks.bridge.rest.model.SignUp
 
firstName(String) - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
 
fitBitScopes(List<String>) - Method in class org.sagebionetworks.bridge.rest.model.App
 
ForAdminsApi - Interface in org.sagebionetworks.bridge.rest.api
 
ForConsentedUsersApi - Interface in org.sagebionetworks.bridge.rest.api
 
ForDevelopersApi - Interface in org.sagebionetworks.bridge.rest.api
 
foreground(String) - Method in class org.sagebionetworks.bridge.rest.model.ColorScheme
 
forInfant(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.HeightConstraints
 
forInfant(Boolean) - Method in class org.sagebionetworks.bridge.rest.model.WeightConstraints
 
format(String) - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
 
ForOrgAdminsApi - Interface in org.sagebionetworks.bridge.rest.api
 
ForResearchersApi - Interface in org.sagebionetworks.bridge.rest.api
 
ForStudyCoordinatorsApi - Interface in org.sagebionetworks.bridge.rest.api
 
ForStudyDesignersApi - Interface in org.sagebionetworks.bridge.rest.api
 
ForSuperadminsApi - Interface in org.sagebionetworks.bridge.rest.api
 
ForwardCursorPagedResourceList - Class in org.sagebionetworks.bridge.rest.model
One page of records from a source that only allows you to fetch the next page of resources (no random access via an index to anywhere in the set of records).
ForwardCursorPagedResourceList() - Constructor for class org.sagebionetworks.bridge.rest.model.ForwardCursorPagedResourceList
 
ForwardCursorReportDataList - Class in org.sagebionetworks.bridge.rest.model
ForwardCursorReportDataList
ForwardCursorReportDataList() - Constructor for class org.sagebionetworks.bridge.rest.model.ForwardCursorReportDataList
 
ForwardCursorScheduledActivityList - Class in org.sagebionetworks.bridge.rest.model
ForwardCursorScheduledActivityList
ForwardCursorScheduledActivityList() - Constructor for class org.sagebionetworks.bridge.rest.model.ForwardCursorScheduledActivityList
 
ForwardCursorStringList - Class in org.sagebionetworks.bridge.rest.model
ForwardCursorStringList
ForwardCursorStringList() - Constructor for class org.sagebionetworks.bridge.rest.model.ForwardCursorStringList
 
ForWorkersApi - Interface in org.sagebionetworks.bridge.rest.api
 
fromProperty(Config.Props) - Method in class org.sagebionetworks.bridge.rest.Config
Method to get any of the values that are defined in the bridge-sdk.properties configuration file.
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.AccountStatus
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.ActivityEventUpdateType
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.ActivityType
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.AdherenceRecordType
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.ContactRole
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.CountryCode
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.DataType
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.EnrollmentFilter
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.Environment
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.FileDisposition
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.FileRevisionStatus
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.IrbDecisionType
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.MimeType
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.NotificationProtocol
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.NotificationType
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.Operator
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.PerformanceOrder
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.ReportType
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.ResourceCategory
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.Role
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.ScheduleStatus
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.ScheduleType
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.SearchTermPredicate
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.SharedModuleType
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.SharingScope
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.SignInType
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.SmsType
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.SortOrder
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.StringSearchPosition
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.StudyPhase
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.SynapseExporterStatus
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.TemplateType
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.UIHint
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.Unit
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.Upload.CompletedByEnum
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.UploadFieldType
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.UploadSchemaType
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.UploadStatus
 
fromValue(String) - Static method in enum org.sagebionetworks.bridge.rest.model.UploadValidationStrictness
 

G

GeneratedPassword - Class in org.sagebionetworks.bridge.rest.model
GeneratedPassword
GeneratedPassword() - Constructor for class org.sagebionetworks.bridge.rest.model.GeneratedPassword
 
generatePassword(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.AuthenticationApi
Generate a password for a study participant's account Allows a researcher to generate a password for another account, identified by an external ID, when the app is configured to manage (verify) external IDs.
generatePassword(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Generate a password for a study participant's account Allows a researcher to generate a password for another account, identified by an external ID, when the app is configured to manage (verify) external IDs.
get(String) - Method in class org.sagebionetworks.bridge.rest.Config
Arbitrary properties can be added to the bridge-sdk.properties file.
getAcceptedLanguages() - Method in class org.sagebionetworks.bridge.rest.ClientManager
 
getAcceptLanguage(List<String>) - Static method in class org.sagebionetworks.bridge.rest.RestUtils
 
getAccessToken() - Method in class org.sagebionetworks.bridge.rest.model.OAuthAccessToken
The access token.
getAccount(String) - Method in interface org.sagebionetworks.bridge.rest.api.AccountsApi
Get an administrative account
getAccount(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForOrgAdminsApi
Get an administrative account
getAccountEmail() - Method in class org.sagebionetworks.bridge.rest.Config
 
getAccountLimit() - Method in class org.sagebionetworks.bridge.rest.model.App
**Can only be set by an administrator.** If not zero, sets an upper-bound limit on the number of accounts that can be created for this app.
getAccountPassword() - Method in class org.sagebionetworks.bridge.rest.Config
 
getAccountRequestInfo(String) - Method in interface org.sagebionetworks.bridge.rest.api.AccountsApi
Get information about the last request made by this organization member
getAccountRequestInfo(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForOrgAdminsApi
Get information about the last request made by this organization member
getAccountSignIn() - Method in class org.sagebionetworks.bridge.rest.Config
 
getActivated() - Method in class org.sagebionetworks.bridge.rest.model.ColorScheme
A color value (in hex color triplet or
getActivities() - Method in class org.sagebionetworks.bridge.rest.model.Schedule
One or more activities that should be done by a participant on this schedule.
getActivitiesAccessedOn() - Method in class org.sagebionetworks.bridge.rest.model.RequestInfo
The last recorded time the participant's application requested scheduled activities from the server.
getActivity() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledActivity
Get activity
getActivityEvents() - Method in interface org.sagebionetworks.bridge.rest.api.ActivityEventsApi
Get activity events for current user Gets all activity events for the current user.
getActivityEvents() - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get activity events for current user Gets all activity events for the current user.
getActivityEventsForParticipant(String) - Method in interface org.sagebionetworks.bridge.rest.api.ActivityEventsApi
Get activity events mapping for a participant This endpoint can be called by researchers, and by other administrators for their own account.
getActivityEventsForParticipant(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get activity events mapping for a participant This endpoint can be called by researchers, and by other administrators for their own account.
getActivityEventsForParticipantAndApp(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get activity event records for participant
getActivityHistory(String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ActivitiesApi
Get a history of activities
getActivityHistory(String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get a history of activities
getActivityType() - Method in class org.sagebionetworks.bridge.rest.model.Activity
Get activityType
getAddress() - Method in class org.sagebionetworks.bridge.rest.model.Contact
Get address
getAdherenceRecordType() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
Get adherenceRecordType
getAdminEmail() - Method in class org.sagebionetworks.bridge.rest.Config
 
getAdminIds() - Method in class org.sagebionetworks.bridge.rest.model.AppAndUsers
A list of Synapse admin user IDs.
getAdminPassword() - Method in class org.sagebionetworks.bridge.rest.Config
 
getAdminSignIn() - Method in class org.sagebionetworks.bridge.rest.Config
 
getAffiliation() - Method in class org.sagebionetworks.bridge.rest.model.Contact
Get affiliation
getAfterRules() - Method in class org.sagebionetworks.bridge.rest.model.SurveyElement
Survey elements can include one or more rules about how to progress through the elements of a survey (e.g.
getAllAppConfigElementRevisions(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.AppConfigsApi
Get all revisions for an app config element Get all revisions for an app config element.
getAllAppConfigElementRevisions(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get all revisions for an app config element Get all revisions for an app config element.
getAllCompoundActivityDefinitions() - Method in interface org.sagebionetworks.bridge.rest.api.CompoundActivityDefinitionsApi
List all compound activity definitions in the app
getAllCompoundActivityDefinitions() - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
List all compound activity definitions in the app
getAllConsents(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a list of all consents for this subpopulation
getAllConsents(String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyConsentsApi
Get a list of all consents for this subpopulation
getAllDataForAdminWorker(String, String, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Get list of identifiers for participant data Endpoint for worker or admin to get a list of participant data identifiers.
getAllDataForAdminWorker(String, String, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get list of identifiers for participant data Endpoint for worker or admin to get a list of participant data identifiers.
getAllDataForAdminWorker(String, String, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantDataApi
Get list of identifiers for participant data Endpoint for worker or admin to get a list of participant data identifiers.
getAllDataForSelf(String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get list of identifiers for participant data
getAllDataForSelf(String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantDataApi
Get list of identifiers for participant data
getAllDataForSelf(String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.UsersApi
Get list of identifiers for participant data
getAllDefaultConsentRevisions() - Method in interface org.sagebionetworks.bridge.rest.api.ConsentsApi
Deprecated. 
getAllDefaultConsentRevisions() - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Deprecated. 
getAllOfGroups() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
Return records that have all of these data groups
getAllOfGroups() - Method in class org.sagebionetworks.bridge.rest.model.Criteria
One or more data groups; the user must have all these data groups to match.
getAllOfGroups() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get allOfGroups
getAllOfStudyIds() - Method in class org.sagebionetworks.bridge.rest.model.Criteria
One or more study IDs; the user must be assigned to all these studies to match.
getAllPublishedSurveys(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get the published surveys in an app
getAllRevisionsOfUploadSchema(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get all revisions of an upload schema
getAllRevisionsOfUploadSchema(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.UploadSchemasApi
Get all revisions of an upload schema
getAllSchedulerConfigs() - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Get list of scheduler configs
getAllVersionsOfSurvey(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get all revisions of a survey
getAllVersionsOfSurvey(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.SurveysApi
Get all revisions of a survey
getAndroidAppLinks() - Method in class org.sagebionetworks.bridge.rest.model.App
The entries this app contributes to the `/.well-known/assetlinks.json` file to enable app links for Android apps that use this app as the data store.
getAnswerValue() - Method in class org.sagebionetworks.bridge.rest.model.ActivityEvent
answer value for a question event
getAnswerValue() - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEvent
answer value for a question event
getAnswerValue() - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEventRequest
Some event types can be scoped to a specific answer from the participant (in particular, survey questions).
getApp(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Get an app
getApp(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get an app
getApp() - Method in class org.sagebionetworks.bridge.rest.model.AppAndUsers
Get app
getAppConfig(String) - Method in interface org.sagebionetworks.bridge.rest.api.AppConfigsApi
Get an app config Get an configuration object for this app.
getAppConfig(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get an app config Get an configuration object for this app.
getAppConfigElement(String, Long) - Method in interface org.sagebionetworks.bridge.rest.api.AppConfigsApi
Get an app config element Get an app configuration element for this app.
getAppConfigElement(String, Long) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get an app config element Get an app configuration element for this app.
getAppConfigs(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.AppConfigsApi
Get a list of the app's configurations Get all the configuration objects for this app.
getAppConfigs(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a list of the app's configurations Get all the configuration objects for this app.
getAppEmailStatus() - Method in interface org.sagebionetworks.bridge.rest.api.AppsApi
SES email verification status Consents will be emailed from the support email address you provide.
getAppEmailStatus() - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
SES email verification status Consents will be emailed from the support email address you provide.
getAppId() - Method in class org.sagebionetworks.bridge.rest.Config
 
getAppId() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummary
Get appId
getAppID() - Method in class org.sagebionetworks.bridge.rest.model.AppleAppLink
Get appID
getAppId() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentInfo
Get appId
getAppId() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentReference2
Schedules can refer to assessments in the shared library (appId = shared) or in their own local assessment library (appId will be the appId of the app in which the study is running).
getAppId() - Method in class org.sagebionetworks.bridge.rest.model.EmailSignIn
The identifier of the participant's app.
getAppId() - Method in class org.sagebionetworks.bridge.rest.model.EmailSignInRequest
The identifier for the participant's app.
getAppId() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecord
App that this record lives in.
getAppId() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordEx3
App that the record belongs to.
getAppId() - Method in class org.sagebionetworks.bridge.rest.model.Identifier
String identifier if the participant's app.
getAppId() - Method in class org.sagebionetworks.bridge.rest.model.IntentToParticipate
The identifier for the app in which the user consents to participate.
getAppId() - Method in class org.sagebionetworks.bridge.rest.model.OAuthAuthorizationToken
The app the user is authenticating to (optional and used when authenticating with Brige via an OAuth server, currently only Synapse).
getAppId() - Method in class org.sagebionetworks.bridge.rest.model.PhoneSignIn
The identifier of the participant's app.
getAppId() - Method in class org.sagebionetworks.bridge.rest.model.PhoneSignInRequest
The identifier for the participant's app.
getAppId() - Method in class org.sagebionetworks.bridge.rest.model.SignIn
App identifier of the participant's app
getAppId() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
The app ID of the app the participant is joining.
getAppId() - Method in class org.sagebionetworks.bridge.rest.model.SmsMessage
The app whose behalf we sent the message.
getAppId() - Method in class org.sagebionetworks.bridge.rest.model.UploadSchema
**Only available through worker APIs.** The identifier of the app from which this schema was retrieved.
getAppleAppLinks() - Method in class org.sagebionetworks.bridge.rest.model.App
The entries this app contributes to the `/.well-known/apple-app-site-association` file to enable universal links for iOS apps that use this app as the data store.
getAppMemberships() - Method in interface org.sagebionetworks.bridge.rest.api.AppsApi
Get the list of apps that are accessible to the signed in user via a shared Synapse user ID Return a summary of all apps that are accessible to the authenticated caller via a shared Synapse user ID.
getAppMemberships() - Method in interface org.sagebionetworks.bridge.rest.api.AuthenticationApi
Get the list of apps that are accessible to the signed in user via a shared Synapse user ID Return a summary of all apps that are accessible to the authenticated caller via a shared Synapse user ID.
getAppName() - Method in class org.sagebionetworks.bridge.rest.Config
 
getAppName() - Method in class org.sagebionetworks.bridge.rest.model.ClientInfo
The name of the application (e.g.
getAppPublicCsmKey() - Method in interface org.sagebionetworks.bridge.rest.api.AppsApi
Get the public key CMS block for this app
getAppPublicCsmKey() - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get the public key CMS block for this app
getApps(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.AppsApi
Get all apps The summary must be true if this call is made without authentication.
getApps(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Get all apps The summary must be true if this call is made without authentication.
getApps(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.PublicApi
Get all apps The summary must be true if this call is made without authentication.
getAppVersion() - Method in class org.sagebionetworks.bridge.rest.Config
 
getAppVersion() - Method in class org.sagebionetworks.bridge.rest.model.ClientInfo
The version of the application (must be a number, and should increase with every new release of the application).
getAppVersion() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecord
App version, as reported by the app.
getAppVersion() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataSubmission
App version, as reported by the app.
getAssessmentByGUID(String) - Method in interface org.sagebionetworks.bridge.rest.api.AssessmentsApi
Get a specific assessment revision.
getAssessmentByGUID(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a specific assessment revision.
getAssessmentByGUID(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Get a specific assessment revision.
getAssessmentById(String, Long) - Method in interface org.sagebionetworks.bridge.rest.api.AssessmentsApi
Get an assessment revision by identifier and revision number.
getAssessmentById(String, Long) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get an assessment revision by identifier and revision number.
getAssessmentById(String, Long) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Get an assessment revision by identifier and revision number.
getAssessmentConfig(String) - Method in interface org.sagebionetworks.bridge.rest.api.AssessmentsApi
Get the JSON config for this assessment.
getAssessmentConfig(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get the JSON config for this assessment.
getAssessmentConfig(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Get the JSON config for this assessment.
getAssessmentIds() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
Return adherence records for assessments with these IDs (the assessment ID is used to define a type of assessment).
getAssessmentIds() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get assessmentIds
getAssessmentReferences() - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
Get assessmentReferences
getAssessmentResource(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.AssessmentsApi
Get an assessment external resource description
getAssessmentResource(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get an assessment external resource description
getAssessmentResource(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Get an assessment external resource description
getAssessmentResources(String, Integer, Integer, List<String>, Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.AssessmentsApi
Get the external resource links documenting an assessment
getAssessmentResources(String, Integer, Integer, List<String>, Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get the external resource links documenting an assessment
getAssessmentResources(String, Integer, Integer, List<String>, Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Get the external resource links documenting an assessment
getAssessmentRevisionsByGUID(String, Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.AssessmentsApi
Get the revisions of an assessment with a specific identifier.
getAssessmentRevisionsByGUID(String, Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get the revisions of an assessment with a specific identifier.
getAssessmentRevisionsByGUID(String, Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Get the revisions of an assessment with a specific identifier.
getAssessmentRevisionsById(String, Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.AssessmentsApi
Get the revisions for an assessment by its identifier.
getAssessmentRevisionsById(String, Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get the revisions for an assessment by its identifier.
getAssessmentRevisionsById(String, Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Get the revisions for an assessment by its identifier.
getAssessments(Integer, Integer, List<String>, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.AssessmentsApi
Get assessments in the app context.
getAssessments(Integer, Integer, List<String>, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get assessments in the app context.
getAssessments(Integer, Integer, List<String>, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Get assessments in the app context.
getAssessments() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledSession
Get assessments
getAssessments() - Method in class org.sagebionetworks.bridge.rest.model.Session
A collection of assessment references.
getAssessments() - Method in class org.sagebionetworks.bridge.rest.model.Timeline
Get assessments
getAssignDataGroup() - Method in class org.sagebionetworks.bridge.rest.model.SurveyRule
If specified, the value is a data group that should be added to the survey taker if the rule expression is true, or removed if the rule expression is false.
getAttributeKey() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
Return records that have an attribute with this key and a value that matches the substring value specified by `attributeValueFilter`.
getAttributeKey() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get attributeKey
getAttributes() - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
A map of user profile attributes that have been set for this user (the attributes themselves must be specified in the app's configuration, and the values are stored encrypted in case they capture personally-identifying information).
getAttributes() - Method in class org.sagebionetworks.bridge.rest.model.Account
A map of user profile attributes that have been set for this user (the attributes themselves must be specified in the app's configuration, and the values are stored encrypted in case they capture personally-identifying information).
getAttributes() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummary
Get attributes
getAttributes() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
A map of user profile attributes that have been set for this user (the attributes themselves must be specified in the app's configuration, and the values are stored encrypted in case they capture personally-identifying information).
getAttributes() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
A map of user profile attributes that have been set for this user (the attributes themselves must be specified in the app's configuration, and the values are stored encrypted in case they capture personally-identifying information).
getAttributes() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
A map of user profile attributes that have been set for this user (the attributes themselves must be specified in the app's configuration, and the values are stored encrypted in case they capture personally-identifying information).
getAttributeValueFilter() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
Return records that have an attribute key specified by `attributeKey` and a value that matches the substring value of `attributeValueFilter`.
getAttributeValueFilter() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get attributeValueFilter
getAuthenticatedClientProviderBuilder() - Method in class org.sagebionetworks.bridge.rest.ApiClientProvider
Returns a builder for authenticated access to this app.
getAuthenticationApi() - Method in class org.sagebionetworks.bridge.rest.ApiClientProvider
Get an instance of the Authentication API client.
getAuthToken() - Method in class org.sagebionetworks.bridge.rest.model.OAuthAuthorizationToken
The OAuth 2.0 authorization token returned from the provider, which must be submitted to the Bridge server in order to retrieve an access token.
getAutomaticCustomEvents() - Method in class org.sagebionetworks.bridge.rest.model.App
Custom events that should be generated for participant upon enrollment.
getBackground() - Method in class org.sagebionetworks.bridge.rest.model.ColorScheme
A color value (in hex color triplet or
getBeforeRules() - Method in class org.sagebionetworks.bridge.rest.model.SurveyElement
Survey elements can include one or more rules about how to progress through the elements of a survey (e.g.
getBirthdate() - Method in class org.sagebionetworks.bridge.rest.model.ConsentSignature
The participant's date of birth in ISO 8601 format (YYYY-MM-DD).
getBirthdate() - Method in class org.sagebionetworks.bridge.rest.model.UserConsentHistory
ISO 8601 date string (e.g.
getCacheKeys() - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Get all the non-session Redis keys
getCallbackUrl() - Method in class org.sagebionetworks.bridge.rest.model.OAuthAuthorizationToken
The callback URL registered with the OAuth authentication server.
getCallbackUrl() - Method in class org.sagebionetworks.bridge.rest.model.OAuthProvider
The callback URL that the client provides to retrieve the authorization token.
getCategories() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get categories
getCategory() - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
One of an enumerated list of categories of documentation resources.
getCity() - Method in class org.sagebionetworks.bridge.rest.model.Address
Get city
getClient(Class<T>) - Method in class org.sagebionetworks.bridge.rest.ApiClientProvider.AuthenticatedClientProvider
 
getClient(Class<T>) - Method in class org.sagebionetworks.bridge.rest.ApiClientProvider
Create an unauthenticated client (this client cannot authenticate automatically, and is only used for public APIs not requiring a server user to access).
getClient(Class<T>) - Method in class org.sagebionetworks.bridge.rest.ClientManager
 
getClientData() - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
Client data for a user should be in a syntactically valid JSON format.
getClientData() - Method in class org.sagebionetworks.bridge.rest.model.Account
Client data for a user should be in a syntactically valid JSON format.
getClientData() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecord
An arbitrary JSON structure that the client can use to record information about this schedule item (maximum size 65k).
getClientData() - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
An arbitrary object that will be serialized and stored as JSON using the GSON serialization mechanisms.
getClientData() - Method in class org.sagebionetworks.bridge.rest.model.Schedule2
Client data for a schedule should be in a syntactically valid JSON format.
getClientData() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledActivity
An arbitrary object that will be serialized and stored as JSON using the GSON serialization mechanisms.
getClientData() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
Client data for a user should be in a syntactically valid JSON format.
getClientData() - Method in class org.sagebionetworks.bridge.rest.model.Study
Client data for a study should be in a syntactically valid JSON format.
getClientData() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
Client data for a user should be in a syntactically valid JSON format.
getClientData() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
Client data for a user should be in a syntactically valid JSON format.
getClientId() - Method in class org.sagebionetworks.bridge.rest.model.OAuthProvider
The client ID of the app.
getClientInfo() - Method in class org.sagebionetworks.bridge.rest.ClientManager
 
getClientInfo() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordEx3
Client info string of the participant at the time they submitted the record to Bridge.
getClientInfo() - Method in class org.sagebionetworks.bridge.rest.model.RequestInfo
The `User-Agent` string from the last request as parsed for the purpose of applying filtering criteria.
getClientTimeZone() - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
Participant's time zone.
getClientTimeZone() - Method in class org.sagebionetworks.bridge.rest.model.Account
Participant's time zone.
getClientTimeZone() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummary
Participant's time zone.
getClientTimeZone() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecord
An IANA Time Zone Database (TZDB) name for the participant’s time zone at the time the record is submitted.
getClientTimeZone() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
Participant's time zone.
getClientTimeZone() - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEvent
An IANA Time Zone Database (TZDB) name for the participant’s time zone at the time the record is submitted.
getClientTimeZone() - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEventRequest
An IANA Time Zone Database (TZDB) name for the participant’s time zone at the time the record is submitted.
getClientTimeZone() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
Participant's time zone.
getColorScheme() - Method in class org.sagebionetworks.bridge.rest.model.Assessment
Get colorScheme
getColorScheme() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentInfo
Get colorScheme
getColorScheme() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentReference2
Get colorScheme
getColorScheme() - Method in class org.sagebionetworks.bridge.rest.model.Study
Get colorScheme
getColorScheme() - Method in class org.sagebionetworks.bridge.rest.model.StudyInfo
Get colorScheme
getCompletedBy() - Method in class org.sagebionetworks.bridge.rest.model.Upload
Currently the API has an endpoint for the client to call and mark an upload completed.
getCompletedOn() - Method in class org.sagebionetworks.bridge.rest.model.Upload
The date and time (ISO 8601 format) that the upload was completed.
getCompoundActivity() - Method in class org.sagebionetworks.bridge.rest.model.Activity
Get compoundActivity
getCompoundActivityDefinition(String) - Method in interface org.sagebionetworks.bridge.rest.api.CompoundActivityDefinitionsApi
Get a compound activity definition by ID
getCompoundActivityDefinition(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a compound activity definition by ID
getCompoundActivityHistory(String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ActivitiesApi
Get a history of compound activities
getCompoundActivityHistory(String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get a history of compound activities
getConfig() - Method in class org.sagebionetworks.bridge.rest.ClientManager
 
getConfig() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentConfig
The JSON configuration for this assessment.
getConfigElements() - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
A map of app config element IDs to the app config element JSON of a specific app config element revision (the revision given in the configReferences map).
getConfigForApp(String) - Method in interface org.sagebionetworks.bridge.rest.api.AppsApi
Get the config for the current version of the app making the request.
getConfigForApp(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get the config for the current version of the app making the request.
getConfigForApp(String) - Method in interface org.sagebionetworks.bridge.rest.api.PublicApi
Get the config for the current version of the app making the request.
getConfigHref() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentReference
The URL to retrieve the configuration for this assessment
getConfigReferences() - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
Get configReferences
getConfigUrl() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentInfo
The URL to download the configuration associated with this assessment.
getConsent(String, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a specific consent revision Get a specific revision of this subpopulation consent by its creation timestamp.
getConsent(String, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.StudyConsentsApi
Get a specific consent revision Get a specific revision of this subpopulation consent by its creation timestamp.
getConsentCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.UserConsentHistory
ISO 8601 date and time that the consent was created on.
getConsentHistories() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
A complete historical record of all the user's consents and withdrawals of consent for all studies in the app.
getConsentHTML() - Method in class org.sagebionetworks.bridge.rest.model.Subpopulation
The URL to retrieve an HTML version of the published and active version of the consent.
getConsentNotificationEmail() - Method in class org.sagebionetworks.bridge.rest.model.App
Copies of all consent agreements and withdrawals will be emailed to this address.
getConsentPDF() - Method in class org.sagebionetworks.bridge.rest.model.Subpopulation
The URL to retrieve a PDF version of the published and active version of the consent.
getConsentSignature(String) - Method in interface org.sagebionetworks.bridge.rest.api.ConsentsApi
Get the participant's consent signature for the subpopulation
getConsentSignature(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get the participant's consent signature for the subpopulation
getConsentSignature() - Method in class org.sagebionetworks.bridge.rest.model.IntentToParticipate
Get consentSignature
getConsentStatuses() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
A mapping from a subpopulation GUID to information about the participant's consent status in that subpopulation (whether consented or not).
getConstraints() - Method in class org.sagebionetworks.bridge.rest.model.SurveyQuestion
Get constraints
getContacts() - Method in class org.sagebionetworks.bridge.rest.model.Study
Get contacts
getContentLength() - Method in class org.sagebionetworks.bridge.rest.model.Upload
The size of the object in bytes.
getContentLength() - Method in class org.sagebionetworks.bridge.rest.model.UploadRequest
The size of the object in bytes.
getContentMd5() - Method in class org.sagebionetworks.bridge.rest.model.UploadRequest
The base64-encoded, 128-bit MD5 digest of the object body.
getContentType() - Method in class org.sagebionetworks.bridge.rest.model.UploadRequest
A standard MIME type.
getContributors() - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
Non-authorial contributors to the documentation (researchers who participated in the research, grant funders, or the like).
getCopyrightNotice() - Method in class org.sagebionetworks.bridge.rest.model.Survey
A copyright notice identifying the owners of the published work.
getCountry() - Method in class org.sagebionetworks.bridge.rest.model.Address
Get country
getCountryCode() - Method in class org.sagebionetworks.bridge.rest.model.PostalCodeConstraints
Get countryCode
getCreatedAtRevision() - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
The revision of the assessment at the time this resource was created or updated.
getCreatedBy() - Method in class org.sagebionetworks.bridge.rest.model.TemplateRevision
Get createdBy
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
The date and time the account was created.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.Account
The date and time the account was created.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummary
ISO 8601 date and time that the user account was created.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
The date and time the app config was created.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.AppConfigElement
The date and time the app config was created.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.Assessment
The date and time the assessment was created.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentConfig
The date and time the app config was created.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.CreatedOnHolder
The timestamp (created on) of the newly created entity.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
The date and time the app config was created.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.FileMetadata
The date and time the account was created.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.FileReference
The createdOn timestamp of the file revision
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.FileRevision
The date and time the account was created.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.GuidCreatedOnVersionHolder
The createdOn value of the survey (added when survey is created).
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecord
ISO timestamp of when the data record was created, as reported by the submitting app
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordEx3
ISO timestamp of when this record was submitted to Bridge.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataSubmission
ISO timestamp of when the data record was created, as reported by the submitting app
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.NotificationRegistration
Date the client registered for push notifications with Bridge.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.NotificationTopic
The date and time this topic was created.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.Organization
The date and time this organization was created.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.ParticipantFile
Get createdOn
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.Schedule2
The date and time the schedule was created.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
The date and time the account was created.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.Study
The date and time the study was created.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEvent
ISO 8601 date and time that the user account was created.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.StudyConsent
The time the document was created on the server.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
The date and time the account was created.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.Survey
The ISO 8601 date on which this version of this survey was created.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.SurveyReference
The createdOn timestamp of the version of the survey.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.Template
The date and time the template was created.
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.TemplateRevision
Get createdOn
getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
The date and time the account was created.
getCreatedOnTimeZone() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecord
The original timezone of the createdOn timestamp, expressed as a 4-digit string with sign.
getCreators() - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
The authors of the documentation.
getCriteria() - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
Optional selection criteria that can be used to determine if an app should receive this configuration record or not.
getCriteria() - Method in class org.sagebionetworks.bridge.rest.model.NotificationTopic
If a topic has criteria, users can be automatically subscribed and unsubscribed when their criteria context changes.
getCriteria() - Method in class org.sagebionetworks.bridge.rest.model.ScheduleCriteria
Get criteria
getCriteria() - Method in class org.sagebionetworks.bridge.rest.model.Subpopulation
Optional selection criteria that can be used to determine if a user should be assigned to this subpopulation or not.
getCriteria() - Method in class org.sagebionetworks.bridge.rest.model.Template
Selection criteria that can be used to determine if a given template should be used for the target user.
getCronSchedule() - Method in class org.sagebionetworks.bridge.rest.model.MasterSchedulerConfig
Cron expression indicating when the schedule should be run.
getCronTrigger() - Method in class org.sagebionetworks.bridge.rest.model.Schedule
A cron expression will schedule recurring tasks according to this standard syntax for describing event schedules from the Unix operating system.
getCustomEvents() - Method in class org.sagebionetworks.bridge.rest.model.App
Define one or more custom activity events that the client can send to the server, which can be used for scheduling.
getCustomEvents() - Method in class org.sagebionetworks.bridge.rest.model.Study
Get customEvents
getCustomizationFields() - Method in class org.sagebionetworks.bridge.rest.model.Assessment
A map of AssessmentNode GUIDs to a set of field identifiers in that node that can be customized by developers without invalidating an assessment (the assessment will maintain its link to the shared assessment it was derived from, if any, and the authors of the assessment are confident that these changes to the configuration will not invalidate the scientific validity of the assessment).
getData() - Method in class org.sagebionetworks.bridge.rest.model.AppConfigElement
The JSON data of this element.
getData() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecord
JSON map with key value pairs representing the record's data.
getData() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataSubmission
JSON map with key value pairs representing the record's data.
getData() - Method in class org.sagebionetworks.bridge.rest.model.ParticipantData
A string containing the data to be saved for the participant data attribute.
getData() - Method in class org.sagebionetworks.bridge.rest.model.ReportData
An arbitrary JSON object containing whatever data should be saved for a report.
getData() - Method in class org.sagebionetworks.bridge.rest.model.ReportDataForWorker
An arbitrary JSON object containing whatever data should be saved for a report.
getDataByIdentifierForAdminWorker(String, String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Get participant data by identifier Endpoint for worker or admin to get a participant data.
getDataByIdentifierForAdminWorker(String, String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get participant data by identifier Endpoint for worker or admin to get a participant data.
getDataByIdentifierForAdminWorker(String, String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantDataApi
Get participant data by identifier Endpoint for worker or admin to get a participant data.
getDataByIdentifierForSelf(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get user's data based on the given identifier Get the participant data record based on the given identifier.
getDataByIdentifierForSelf(String) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantDataApi
Get user's data based on the given identifier Get the participant data record based on the given identifier.
getDataByIdentifierForSelf(String) - Method in interface org.sagebionetworks.bridge.rest.api.UsersApi
Get user's data based on the given identifier Get the participant data record based on the given identifier.
getDataGroups() - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
The data groups set for this user.
getDataGroups() - Method in class org.sagebionetworks.bridge.rest.model.Account
The data groups set for this user.
getDataGroups() - Method in class org.sagebionetworks.bridge.rest.model.App
An enumerated list of **unique** strings that can be assigned to user accounts.
getDataGroups() - Method in class org.sagebionetworks.bridge.rest.model.DataGroups
Get dataGroups
getDataGroups() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
The data groups set for this user.
getDataGroups() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
The data groups set for this user.
getDataGroups() - Method in class org.sagebionetworks.bridge.rest.model.SurveyRule
Some operators will test a set of data groups against the user's set of data groups.
getDataGroups() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
The data groups set for this user.
getDataGroupsAssignedWhileConsented() - Method in class org.sagebionetworks.bridge.rest.model.Subpopulation
The data groups that will be assigned to a participant who consents to membership in this subpopulation.
getDataType() - Method in class org.sagebionetworks.bridge.rest.model.Constraints
Get dataType
getDate() - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
The date of publication of the resource (a human-readable format is sufficient unless you wish to sort by this field).
getDate() - Method in class org.sagebionetworks.bridge.rest.model.ReportData
The date (whether local or an ISO timestamp) of the report data.
getDate() - Method in class org.sagebionetworks.bridge.rest.model.ReportDataForWorker
The date (YYYY-MM-DD) of the report data.
getDateTime() - Method in class org.sagebionetworks.bridge.rest.model.DateTimeHolder
The datetime of an entity.
getDateTime() - Method in class org.sagebionetworks.bridge.rest.model.ReportData
The date expressed as an ISO 8601 timestamp.
getDateTime() - Method in class org.sagebionetworks.bridge.rest.model.ReportDataForWorker
The date expressed as an ISO 8601 timestamp.
getDayInStudy() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecord
How many calendar days the participant has been in the study.
getDefaultConsentRevision(DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ConsentsApi
Deprecated. 
getDefaultConsentRevision(DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Deprecated. 
getDefaultTemplates() - Method in class org.sagebionetworks.bridge.rest.model.App
A map between a type of template, and the template revision that should be used as a default if matching templates to a user is ambiguous.
getDelay() - Method in class org.sagebionetworks.bridge.rest.model.Schedule
ISO 8601 duration string.
getDelay() - Method in class org.sagebionetworks.bridge.rest.model.Session
A period of time after the start event timestamp before the session should be presented to the participant.
getDelayTime() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledSession
Get delayTime
getDescription() - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
Short description of the resource this link is documenting.
getDescription() - Method in class org.sagebionetworks.bridge.rest.model.FileMetadata
Get description
getDescription() - Method in class org.sagebionetworks.bridge.rest.model.FileRevision
Get description
getDescription() - Method in class org.sagebionetworks.bridge.rest.model.NotificationTopic
Description of the purpose of this topic (visible to developers and researchers in design tools).
getDescription() - Method in class org.sagebionetworks.bridge.rest.model.Organization
A description of the organization.
getDescription() - Method in class org.sagebionetworks.bridge.rest.model.PropertyInfo
A longer description of the property and the allowable values that it can take.
getDescription() - Method in class org.sagebionetworks.bridge.rest.model.Subpopulation
The description of this subpopulation.
getDescription() - Method in class org.sagebionetworks.bridge.rest.model.Template
Get description
getDetail() - Method in class org.sagebionetworks.bridge.rest.model.SurveyQuestionOption
Detail text shown in a de-emphasized way near the label in the UI (must be plain text).
getDetails() - Method in class org.sagebionetworks.bridge.rest.model.Study
An in-depth description of this study for prospective participants, or to show participants after they have joined a study (the “about” screen for the study).
getDetails() - Method in class org.sagebionetworks.bridge.rest.model.StudyInfo
An in-depth description of this study for prospective participants, or to show participants after they have joined a study (the “about” screen for the study).
getDeviceId() - Method in class org.sagebionetworks.bridge.rest.model.NotificationRegistration
This should be either the device token retrieved from the iOS operation system, or the registrationId on Android.
getDeviceName() - Method in class org.sagebionetworks.bridge.rest.Config
 
getDeviceName() - Method in class org.sagebionetworks.bridge.rest.model.ClientInfo
Information about the device (e.g.
getDevName() - Method in class org.sagebionetworks.bridge.rest.Config
 
getDiseases() - Method in class org.sagebionetworks.bridge.rest.model.Study
A list of the diseases that are the subject of this study.
getDisposition() - Method in class org.sagebionetworks.bridge.rest.model.FileMetadata
When served by the host server, files can be sent with a `Content-Disposition` header that indicates to web clients how the file should be displayed.
getDivision() - Method in class org.sagebionetworks.bridge.rest.model.Address
Get division
getDocumentContent() - Method in class org.sagebionetworks.bridge.rest.model.StudyConsent
A valid XHTML document describing the consent.
getDocumentContent() - Method in class org.sagebionetworks.bridge.rest.model.TemplateRevision
Get documentContent
getDownloadURL() - Method in class org.sagebionetworks.bridge.rest.model.FileRevision
Get downloadURL
getDownloadUrl() - Method in class org.sagebionetworks.bridge.rest.model.ParticipantFile
Get downloadUrl
getDuration() - Method in class org.sagebionetworks.bridge.rest.model.Schedule2
The length of time this schedule will run for.
getDuration() - Method in class org.sagebionetworks.bridge.rest.model.Timeline
The length of time of the study’s protocol, after which the participant has completed the study.
getEarliestValue() - Method in class org.sagebionetworks.bridge.rest.model.DateConstraints
ISO 8601 date value that is the earliest value that may be set for this question.
getEarliestValue() - Method in class org.sagebionetworks.bridge.rest.model.DateTimeConstraints
ISO 8601 date and time value that is the earliest value that may be set for this question.
getEarliestValue() - Method in class org.sagebionetworks.bridge.rest.model.YearConstraints
An ISO 8601 compliant, four digit year value.
getEarliestValue() - Method in class org.sagebionetworks.bridge.rest.model.YearMonthConstraints
ISO 8601 year and month value (\"YYYY-MM\") that is the earliest value that may be set for this question.
getElements() - Method in class org.sagebionetworks.bridge.rest.model.Survey
An ordered collection of SurveyElement sub-types (in the order they will appear in the survey).
getEmail() - Method in class org.sagebionetworks.bridge.rest.model.Account
The user's email.
getEmail() - Method in class org.sagebionetworks.bridge.rest.model.AccountRef
Get email
getEmail() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummary
Email address of user.
getEmail() - Method in class org.sagebionetworks.bridge.rest.model.Contact
Get email
getEmail() - Method in class org.sagebionetworks.bridge.rest.model.EmailSignIn
The email address of the participant.
getEmail() - Method in class org.sagebionetworks.bridge.rest.model.EmailSignInRequest
The email address of the participant.
getEmail() - Method in class org.sagebionetworks.bridge.rest.model.Identifier
Participant's email.
getEmail() - Method in class org.sagebionetworks.bridge.rest.model.IntentToParticipate
Get email
getEmail() - Method in class org.sagebionetworks.bridge.rest.model.SignIn
User's email address
getEmail() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
The user's email.
getEmail() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
The user's email.
getEmail() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
The user's email.
getEmailFilter() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
Return records that match this substring in their email address
getEmailFilter() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get emailFilter
getEmailUpdate() - Method in class org.sagebionetworks.bridge.rest.model.IdentifierUpdate
An email address to add to the account.
getEndDate() - Method in class org.sagebionetworks.bridge.rest.model.DateRange
Start date of the date range (YYYY-MM-DD).
getEndDate() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get endDate
getEndDay() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledSession
Get endDay
getEndpoint() - Method in class org.sagebionetworks.bridge.rest.model.NotificationRegistration
The endpoint that should be registered for the notification.
getEndpoint() - Method in class org.sagebionetworks.bridge.rest.model.OAuthProvider
The URL to send an authorization token to to retrieve access and refresh tokens.
getEndsOn() - Method in class org.sagebionetworks.bridge.rest.model.Schedule
The scheduler will not create a task after this date and time.
getEndTime() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
Return record created on or before this day
getEndTime() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
Limit search results to records with `startedOn` values that are equal to or earlier than this end time (no later than January 1st, 2120).
getEndTime() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get endTime
getEnrolledBy() - Method in class org.sagebionetworks.bridge.rest.model.Enrollment
If the user is not enrolled through consenting to participate, this will be the user ID of the API caller who enrolled the user in the study (otherwise it is blank).
getEnrolledBy() - Method in class org.sagebionetworks.bridge.rest.model.EnrollmentDetail
Get enrolledBy
getEnrolledInStudyId() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
Return records that are enrolled in a study (specified by the study’s ID).
getEnrolledOn() - Method in class org.sagebionetworks.bridge.rest.model.Enrollment
The timestamp of enrollment (either the timestamp of the consent signature if self-enrolled, or the time the enrollment record was created).
getEnrolledOn() - Method in class org.sagebionetworks.bridge.rest.model.EnrollmentDetail
Get enrolledOn
getEnrollment() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
Return records that match this enrollment state.
getEnrollment() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get enrollment
getEnrollments(String, String, Boolean, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get the enrollments in this study.
getEnrollments(String, String, Boolean, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Get the enrollments in this study.
getEnrollments(String, String, Boolean, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.StudiesApi
Get the enrollments in this study.
getEnrollments(String, String, Boolean, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
Get the enrollments in this study.
getEnrollmentsForUser(String) - Method in interface org.sagebionetworks.bridge.rest.api.ConsentsApi
Get enrollment records for this user
getEnrollmentsForUser(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get enrollment records for this user
getEnumeration() - Method in class org.sagebionetworks.bridge.rest.model.MultiValueConstraints
The options presented for selection to the user.
getEnvironment() - Method in class org.sagebionetworks.bridge.rest.Config
 
getEnvironment() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
Get environment
getErrors() - Method in exception org.sagebionetworks.bridge.rest.exceptions.InvalidEntityException
 
getErrors() - Method in class org.sagebionetworks.bridge.rest.model.InvalidEntity
Errors broken down by the part of the JSON payload that generated them.
getEventId() - Method in class org.sagebionetworks.bridge.rest.model.ActivityEvent
event identifier
getEventId() - Method in class org.sagebionetworks.bridge.rest.model.CustomActivityEventRequest
identifier for the custom event
getEventId() - Method in class org.sagebionetworks.bridge.rest.model.CustomEvent
To ensure portability across information systems, the eventId must only contain upper- and lower-case letters, numbers, underscores, and/or dashes.
getEventId() - Method in class org.sagebionetworks.bridge.rest.model.Schedule
A comma-separated list of event IDs against which will be used for scheduling.
getEventId() - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEvent
event identifier
getEventId() - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEventRequest
identifier for the custom event
getEventTimestamp() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecord
The event timestamp (at the time of recording this record) that triggered the sequence of sessions and assessments which includes the scheduling item for this record.
getEventTimestamps() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
A mapping of event IDs to timestamp values to use when retrieving adherence records that are from sessions triggered by that ID.
getEventTimestamps() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get eventTimestamps
getExpiration() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledSession
Get expiration
getExpiration() - Method in class org.sagebionetworks.bridge.rest.model.TimeWindow
After the start time, how long until this assessment should no longer be available to the participant to peform? This value can be longer than a day, but only minute, hour, day, and week values are allowed (although these can be mixed).
getExpires() - Method in class org.sagebionetworks.bridge.rest.model.Schedule
ISO 8601 duration string.
getExpires() - Method in class org.sagebionetworks.bridge.rest.model.UploadSession
The ISO 8601 date and time stamp at which this session will expire.
getExpiresOn() - Method in class org.sagebionetworks.bridge.rest.model.OAuthAccessToken
The ISO 8601 timestamp of when this access token will expire.
getExpiresOn() - Method in class org.sagebionetworks.bridge.rest.model.ParticipantFile
The time when the downloadUrl or uploadUrl expires.
getExpiresOn() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledActivity
The time after which this task should no longer be made available to the participant.
getExternalId() - Method in class org.sagebionetworks.bridge.rest.model.Enrollment
An optional, arbitrary string identifier that identifies this user in an external system (as a member of this study; one external ID can be tracked per study).
getExternalId() - Method in class org.sagebionetworks.bridge.rest.model.EnrollmentDetail
Get externalId
getExternalId() - Method in class org.sagebionetworks.bridge.rest.model.GeneratedPassword
The external ID for which a password is being generated.
getExternalId() - Method in class org.sagebionetworks.bridge.rest.model.SignIn
The external ID associated with this app participant
getExternalId() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
An externally-assignable identifier a research partner can use to re-identify a user's data in the exported data set (this must be provided by the application, it is not created by Bridge).
getExternalId() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
An externally-assignable identifier a research partner can use to re-identify a user's data in the exported data set (this must be provided by the application, it is not created by Bridge).
getExternalIdFilter() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
Return records that match this value as a substring of an external ID.
getExternalIdFilter() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get externalIdFilter
getExternalIds() - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
The exernal IDs this participant is associated to, mapped to the study that issued the external ID.
getExternalIds() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummary
A map of study ID to external ID for all the external IDs that have been assigned to this participant.
getExternalIds() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
The exernal IDs this participant is associated to, mapped to the study that issued the external ID.
getExternalIds() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
The exernal IDs this participant is associated to, mapped to the study that issued the external ID.
getExternalIds() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
The exernal IDs this participant is associated to, mapped to the study that issued the external ID.
getExternalIdsForStudy(String, Integer, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get external IDs for a study
getExternalIdsForStudy(String, Integer, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Get external IDs for a study
getExternalIdsForStudy(String, Integer, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Get external IDs for a study
getExternalIdsForStudy(String, Integer, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
Get external IDs for a study
getFieldDefinitions() - Method in class org.sagebionetworks.bridge.rest.model.UploadSchema
Get fieldDefinitions
getFile(String) - Method in interface org.sagebionetworks.bridge.rest.api.FilesApi
Get a file resource Get a file resource for this app.
getFile(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a file resource Get a file resource for this app.
getFileExtension() - Method in class org.sagebionetworks.bridge.rest.model.UploadFieldDefinition
Used for ATTACHMENT_V2 types.
getFileGuid() - Method in class org.sagebionetworks.bridge.rest.model.FileRevision
Get fileGuid
getFileId() - Method in class org.sagebionetworks.bridge.rest.model.ParticipantFile
Get fileId
getFileReferences() - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
Get fileReferences
getFileRevision(String, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.FilesApi
Get a single file revision of a file.
getFileRevision(String, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a single file revision of a file.
getFileRevisions(String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.FilesApi
Get the revision history of a file resource Get the paginated revision history of a file resource.
getFileRevisions(String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get the revision history of a file resource Get the paginated revision history of a file resource.
getFiles(Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.FilesApi
Get a list of static files Get all the files of a specific type for this app.
getFiles(Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a list of static files Get all the files of a specific type for this app.
getFinishedOn() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecord
The client-supplied time when the activity was recorded as finished (this time comes from the client and is not validated by the server).
getFinishedOn() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledActivity
This field is filled out by the client to persist the fact that a task has been finished.
getFirstName() - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
First name (given name) of the user.
getFirstName() - Method in class org.sagebionetworks.bridge.rest.model.Account
First name (given name) of the user.
getFirstName() - Method in class org.sagebionetworks.bridge.rest.model.AccountRef
Get firstName
getFirstName() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummary
First (given) name of user.
getFirstName() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
First name (given name) of the user.
getFirstName() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
First name (given name) of the user.
getFirstName() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
First name (given name) of the user.
getFitBitScopes() - Method in class org.sagebionetworks.bridge.rest.model.App
List of FitBit scopes that are configured for this app.
getForeground() - Method in class org.sagebionetworks.bridge.rest.model.ColorScheme
A color value (in hex color triplet or
getFormat() - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
The format of the resource being described, expressed as a MIME type (e.g.
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.Activity
Get guid
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
Get guid
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.Assessment
Each assessment revision is assigned a unique GUID which can be used to retrieve it through the API.
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentInfo
Each assessment revision is assigned a unique GUID which can be used to retrieve it through the API.
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentReference
The assessment revision guid
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentReference2
The assessment revision guid.
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
Get guid
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.FileMetadata
Get guid
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.FileReference
The file guid
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.GuidCreatedOnVersionHolder
The guid of the survey (added when the survey is created).
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.GuidHolder
The guid of the newly created entity.
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.GuidVersionHolder
The guid of the entity (added when the entity is created).
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.NotificationRegistration
Get guid
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.NotificationTopic
A unique GUID for this topic
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.Schedule2
The unique identifier for this model.
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledActivity
Get guid
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.SchedulePlan
Get guid
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.Session
The unique identifier for this model.
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.SessionInfo
The unique identifier for this model.
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.Subpopulation
A unique auto-generated identifier for the subpopulation.
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.Survey
Get guid
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.SurveyElement
A unique GUID for this element of the survey
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.SurveyReference
The survey guid
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.Template
Get guid
getGuid() - Method in class org.sagebionetworks.bridge.rest.model.TimeWindow
The unique identifier for this model.
getHealthCode() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordEx3
Health code of the participant that submitted the record.
getHealthCode() - Method in class org.sagebionetworks.bridge.rest.model.ReportDataForWorker
The health code of the person for whom this data is being created.
getHealthCode() - Method in class org.sagebionetworks.bridge.rest.model.SmsMessage
Health code of the participant that received the message, if the participant had an account at the time the message was sent.
getHealthCode() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
Only included in studies that have been configured to return the health code, and only to researchers through the researcher APIs.
getHealthCodesGrantingOAuthAccess(String, String, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get the health codes of the accounts that have granted OAuth access through a particular vendor.
getHealthData() - Method in class org.sagebionetworks.bridge.rest.model.Upload
Get healthData
getHealthDataByCreatedOn(DateTime, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.InternalApi
Get health data records by createdOn date range.
getHealthRecordExporterStatus() - Method in class org.sagebionetworks.bridge.rest.model.Upload
Get healthRecordExporterStatus
getHeight() - Method in class org.sagebionetworks.bridge.rest.model.Image
The height of the image in pixels.
getHost() - Method in class org.sagebionetworks.bridge.rest.Config
 
getHostUrl() - Method in class org.sagebionetworks.bridge.rest.ClientManager
 
getHref() - Method in class org.sagebionetworks.bridge.rest.model.FileReference
An URL to retrieve the file revision
getHref() - Method in class org.sagebionetworks.bridge.rest.model.SurveyReference
An URL to retrieve the survey.
getId() - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
An ID assigned to this account by Bridge system.
getId() - Method in class org.sagebionetworks.bridge.rest.model.Account
An ID assigned to this account by Bridge system.
getId() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummary
An identifier assigned to this user, used to retrieve a study participant record.
getId() - Method in class org.sagebionetworks.bridge.rest.model.AppConfigElement
The identifier for this app config element.
getId() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentReference
The identifier of the assessment (should be unique in the set of references)
getId() - Method in class org.sagebionetworks.bridge.rest.model.ConfigReference
Schema ID
getId() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecord
A unique GUID for this record.
getId() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordEx3
Record ID, uniquely identifies this record.
getId() - Method in class org.sagebionetworks.bridge.rest.model.SchemaReference
Schema ID
getId() - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleMetadata
Unique ID of the module.
getId() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
An ID assigned to this account by Bridge system.
getId() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
An ID assigned to this account by Bridge system.
getId() - Method in class org.sagebionetworks.bridge.rest.model.UploadSession
The upload ID.
getId() - Method in class org.sagebionetworks.bridge.rest.model.UploadValidationStatus
The identifier for this upload.
getId() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
An ID assigned to this account by Bridge system.
getIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.AccountRef
Get identifier
getIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.App
A user selected identifier that is unique relative to all other Bridge studies (lower-case letters and dashes only).
getIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.Assessment
A human-readable identifier for an assessment, which can have one or more revisions.
getIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentInfo
A human-readable identifier for an assessment, which can have one or more revisions.
getIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentReference2
The identifier of the assessment (which stays the same regardless of the revision or GUID of the assessment).
getIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.ExternalIdentifier
The external identifier.
getIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.IdentifierHolder
The identifier of the entity (added when the entity is created).
getIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.Organization
An identifier for this organization (supplied by the user and unique in the scope of this app).
getIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.ParticipantData
The identifier of the participant data.
getIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.ReportIndex
The report identifier.
getIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.Study
The identifier for this study.
getIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.StudyInfo
The identifier for this study.
getIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.Survey
A private name for the survey, only visible to researchers, used to identify the survey on export.
getIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.SurveyElement
A unique and easy-to-remember identifier, assigned by a researcher, that is maintained through later versions of the survey.
getIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.SurveyReference
The survey identifier.
getIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.TaskReference
The identifier that defines a task on the client.
getIdFilter() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get idFilter
getImage() - Method in class org.sagebionetworks.bridge.rest.model.SurveyInfoScreen
An optional Image element describing an image to show for this screen.
getImage() - Method in class org.sagebionetworks.bridge.rest.model.SurveyQuestionOption
An optional Image element describing an image to show for this option.
getImageData() - Method in class org.sagebionetworks.bridge.rest.model.ConsentSignature
Base 64 encoded image of the participant's signature.
getImageData() - Method in class org.sagebionetworks.bridge.rest.model.UserConsentHistory
The signature image in a base 64 encoding.
getImageMimeType() - Method in class org.sagebionetworks.bridge.rest.model.ConsentSignature
Mime type of this image (e.g.
getImageMimeType() - Method in class org.sagebionetworks.bridge.rest.model.UserConsentHistory
The IANA mime type indicator for the image (e.g.
getInactivated() - Method in class org.sagebionetworks.bridge.rest.model.ColorScheme
A color value (in hex color triplet or
getInstallLinks() - Method in class org.sagebionetworks.bridge.rest.model.App
This can be either to an app store (URLs mapped to the keys \"iOS\" or \"Android\"), or an intermediate web page that will route to a final app or appstore (URLs mapped to the key \"Universal\").
getInstanceGuid() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecord
The session or assessment instance GUID from the timeline that led to the generation of this record.
getInstanceGuid() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledAssessment
Get instanceGuid
getInstanceGuid() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledSession
Get instanceGuid
getInstanceGuids() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
Session or assessment instance GUIDs.
getInstanceGuids() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get instanceGuids
getInstitutionId() - Method in class org.sagebionetworks.bridge.rest.model.Study
An identification number for the study that has been assigned by the sponsor or institution running the study.
getInterval() - Method in class org.sagebionetworks.bridge.rest.model.Notification
If a window lasts for more than twenty-four hours, a notification can be repeated on a daily repeat value.
getInterval() - Method in class org.sagebionetworks.bridge.rest.model.NotificationInfo
If a window lasts for more than twenty-four hours, a notification can be repeated on a daily repeat value.
getInterval() - Method in class org.sagebionetworks.bridge.rest.model.Schedule
An ISO 8601 duration, describing the period in days between tasks (it can be days, weeks, months or even years, but should not be smaller than a day).
getInterval() - Method in class org.sagebionetworks.bridge.rest.model.Session
After the start time of the first session (which is measured from an event timestamp plus the delay period), a period of time before the session should be presented to the participant again.
getIntrospectEndpoint() - Method in class org.sagebionetworks.bridge.rest.model.OAuthProvider
OAuth introspect URL, as defined by RFC7662.
getIrbDecisionOn() - Method in class org.sagebionetworks.bridge.rest.model.Study
Before the study can launch, it must be reviewed by your IRB and either be approved, or considered exempt from human subjects research guidelines.
getIrbDecisionType() - Method in class org.sagebionetworks.bridge.rest.model.Study
Get irbDecisionType
getIrbExpiresOn() - Method in class org.sagebionetworks.bridge.rest.model.Study
The last date that the IRB’s review is considered up-to-date for this study.
getIrbName() - Method in class org.sagebionetworks.bridge.rest.model.Study
The name of the IRB that approved the study or decided it was exempt from human subjects research guidelines.
getIrbProtocolId() - Method in class org.sagebionetworks.bridge.rest.model.Study
An identification number for the study that has been assigned by the IRB.
getIrbProtocolName() - Method in class org.sagebionetworks.bridge.rest.model.Study
The name of the protocol as it was submitted to the IRB for approval.
getItems() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummaryList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.ActivityEventList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.ActivityList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.AppConfigElementList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.AppConfigList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.AppList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.CompoundActivityDefinitionList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.EnrollmentDetailList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.ExternalIdentifierList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.ExternalResourceList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.FileMetadataList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.FileRevisionList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.ForwardCursorReportDataList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.ForwardCursorScheduledActivityList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.ForwardCursorStringList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordEx3List
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.MasterSchedulerConfigList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.NotificationRegistrationList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.NotificationTopicList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.OrganizationList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.PagedExternalResourceList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.ParticipantDataList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.ParticipantFileList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.ReportDataList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.ReportIndexList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledActivityList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledActivityListV4
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.ScheduleList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.SchedulePlanList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleMetadataList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.StringList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEventList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEventPagedList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.StudyConsentList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.StudyList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.SubpopulationList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.SubscriptionStatusList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.SurveyList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.TemplateList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.TemplateRevisionList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.UploadList
Get items
getItems() - Method in class org.sagebionetworks.bridge.rest.model.UploadSchemaList
Get items
getJurisdiction() - Method in class org.sagebionetworks.bridge.rest.model.Contact
Get jurisdiction
getKey() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentInfo
Because assessments can be configured with different display information, they are not referenced in the schedule portion of a timeline by their GUIDs.
getKeywords() - Method in class org.sagebionetworks.bridge.rest.model.Study
Free text that can be used in searches to locate studies.
getLabel() - Method in class org.sagebionetworks.bridge.rest.model.Activity
A label to show the user for this activity.
getLabel() - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
Get label
getLabel() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentInfo
Get label
getLabel() - Method in class org.sagebionetworks.bridge.rest.model.PropertyInfo
A short label for the property.
getLabel() - Method in class org.sagebionetworks.bridge.rest.model.Schedule
A label to describe this schedule.
getLabel() - Method in class org.sagebionetworks.bridge.rest.model.SchedulePlan
The name of this schedule plan (not shown to users).
getLabel() - Method in class org.sagebionetworks.bridge.rest.model.SessionInfo
A required name for this session that will be shown to schedule authors, and can be used as a label for participants if no label can be found.
getLabel() - Method in class org.sagebionetworks.bridge.rest.model.SurveyQuestionOption
The text to show in the UI (must be plain text).
getLabelDetail() - Method in class org.sagebionetworks.bridge.rest.model.Activity
Detail information for the activity (common uses have included indicating the number of questions, or the average time it takes to complete the activity).
getLabels() - Method in class org.sagebionetworks.bridge.rest.model.Assessment
A collection of labels for this assessment.
getLabels() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentReference2
A collection of labels for this assessment.
getLabels() - Method in class org.sagebionetworks.bridge.rest.model.Session
A collection of labels for this schedule.
getLang() - Method in class org.sagebionetworks.bridge.rest.model.Label
A valid ISO 639 alpha-2 or alpha-3 language code specifying the language of the label.
getLang() - Method in class org.sagebionetworks.bridge.rest.model.NotificationMessage
A valid ISO 639 alpha-2 or alpha-3 language code specifying the language of the notification.
getLanguage() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
Return records that declare this language as a language preference
getLanguage() - Method in class org.sagebionetworks.bridge.rest.model.Criteria
A two-letter language code.
getLanguage() - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
The language *of the resource being described by this link.* It is probably not necessary to use something structured like ISO 639-1 language codes, the name of the language in English will do.
getLanguage() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get language
getLanguages() - Method in class org.sagebionetworks.bridge.rest.Config
 
getLanguages() - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
Two letter language codes to assign to this user (these are initially retrieved from the user's `Accept-Language` header and then persisted as part of account configuration).
getLanguages() - Method in class org.sagebionetworks.bridge.rest.model.Account
Two letter language codes to assign to this user (these are initially retrieved from the user's `Accept-Language` header and then persisted as part of account configuration).
getLanguages() - Method in class org.sagebionetworks.bridge.rest.model.RequestInfo
The language or languages sent in the user's `Accept-Language` header and persisted as part of the participant's account configuration, as they were set at the time of the last request.
getLanguages() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
Two letter language codes to assign to this user (these are initially retrieved from the user's `Accept-Language` header and then persisted as part of account configuration).
getLanguages() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
Two letter language codes to assign to this user (these are initially retrieved from the user's `Accept-Language` header and then persisted as part of account configuration).
getLanguages() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
Two letter language codes to assign to this user (these are initially retrieved from the user's `Accept-Language` header and then persisted as part of account configuration).
getLastName() - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
Last name (family name) of the user.
getLastName() - Method in class org.sagebionetworks.bridge.rest.model.Account
Last name (family name) of the user.
getLastName() - Method in class org.sagebionetworks.bridge.rest.model.AccountRef
Get lastName
getLastName() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummary
Last (family) name of user.
getLastName() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
Last name (family name) of the user.
getLastName() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
Last name (family name) of the user.
getLastName() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
Last name (family name) of the user.
getLatestAssessmentRevision(String) - Method in interface org.sagebionetworks.bridge.rest.api.AssessmentsApi
Get the latest version of an assessment.
getLatestAssessmentRevision(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get the latest version of an assessment.
getLatestAssessmentRevision(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Get the latest version of an assessment.
getLatestSharedAssessmentRevision(String) - Method in interface org.sagebionetworks.bridge.rest.api.PublicApi
Get an assessment revision with the greatest revision number, using the assessment's identifier.
getLatestSharedAssessmentRevision(String) - Method in interface org.sagebionetworks.bridge.rest.api.SharedAssessmentsApi
Get an assessment revision with the greatest revision number, using the assessment's identifier.
getLatestValue() - Method in class org.sagebionetworks.bridge.rest.model.DateConstraints
ISO 8601 date value that is the earliest value that may be set for this question.
getLatestValue() - Method in class org.sagebionetworks.bridge.rest.model.DateTimeConstraints
ISO 8601 date and time value that is the earliest value that may be set for this question.
getLatestValue() - Method in class org.sagebionetworks.bridge.rest.model.YearConstraints
An ISO 8601 compliant, four digit year value.
getLatestValue() - Method in class org.sagebionetworks.bridge.rest.model.YearMonthConstraints
ISO 8601 year and month value (\"YYYY-MM\") that is the earliest value that may be set for this question.
getLocalDate() - Method in class org.sagebionetworks.bridge.rest.model.ReportData
The date expressed as a LocalDate (YYYY-MM-DD)
getLogLevel() - Method in class org.sagebionetworks.bridge.rest.Config
 
getMailRouting() - Method in class org.sagebionetworks.bridge.rest.model.Address
Get mailRouting
getMaxAppVersions() - Method in class org.sagebionetworks.bridge.rest.model.Criteria
A map of operating system names to minimum app versions.
getMaxAppVersions() - Method in class org.sagebionetworks.bridge.rest.model.UploadSchema
A map of operating system names to minimum app versions.
getMaxLength() - Method in class org.sagebionetworks.bridge.rest.model.StringConstraints
The maximum number of characters that should be allowed.
getMaxLength() - Method in class org.sagebionetworks.bridge.rest.model.UploadFieldDefinition
Used for STRING, SINGLE_CHOICE, and INLINE_JSON_BLOB types.
getMaxRevision() - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
The least (highest) revision of an assessment that this resource applies to.
getMaxRevision() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get maxRevision
getMaxValue() - Method in class org.sagebionetworks.bridge.rest.model.DecimalConstraints
Maximum valid value.
getMaxValue() - Method in class org.sagebionetworks.bridge.rest.model.DurationConstraints
Minimum valid value.
getMaxValue() - Method in class org.sagebionetworks.bridge.rest.model.IntegerConstraints
Maximum valid value.
getMembers(String, AccountSummarySearch) - Method in interface org.sagebionetworks.bridge.rest.api.OrganizationsApi
Get members of organization (using search terms).
getMessage() - Method in class org.sagebionetworks.bridge.rest.model.InvalidEntity
A message that will include all validation error messages for this object.
getMessage() - Method in class org.sagebionetworks.bridge.rest.model.Message
Get message
getMessage() - Method in class org.sagebionetworks.bridge.rest.model.NotificationInfo
The message to use for a notification and reminder, if these have been specified.
getMessage() - Method in class org.sagebionetworks.bridge.rest.model.NotificationMessage
Full notification message.
getMessage() - Method in class org.sagebionetworks.bridge.rest.model.SmsTemplate
The message to send (only text and template variables allowed).
getMessageBody() - Method in class org.sagebionetworks.bridge.rest.model.SmsMessage
The message content we sent.
getMessageId() - Method in class org.sagebionetworks.bridge.rest.model.SmsMessage
Message ID, as determined by the SMS provider.
getMessageList() - Method in class org.sagebionetworks.bridge.rest.model.UploadValidationStatus
An array of error messages if failures occurred during validation.
getMessages() - Method in class org.sagebionetworks.bridge.rest.model.Notification
The message to use for a notification.
getMetadata() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecord
Arbitrary JSON blob of record metadata, as submitted by the app.
getMetadata() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordEx3
Client-submitted metadata, as a map of key-value pairs.
getMetadata() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataSubmission
JSON map with key value pairs representing metadata for this health data record, as submitted by the app.
getMetadata() - Method in class org.sagebionetworks.bridge.rest.model.UploadRequest
JSON map with key value pairs representing metadata for this upload, as submitted by the app.
getMetadataByIdAndVersion(String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Gets metadata for the specified version of the specified module.
getMetadataByIdAndVersion(String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.PublicApi
Gets metadata for the specified version of the specified module.
getMetadataByIdAndVersion(String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.SharedModulesApi
Gets metadata for the specified version of the specified module.
getMetadataByIdLatestVersion(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Gets metadata for the latest version of the specified module.
getMetadataByIdLatestVersion(String) - Method in interface org.sagebionetworks.bridge.rest.api.PublicApi
Gets metadata for the latest version of the specified module.
getMetadataByIdLatestVersion(String) - Method in interface org.sagebionetworks.bridge.rest.api.SharedModulesApi
Gets metadata for the latest version of the specified module.
getMimeType() - Method in class org.sagebionetworks.bridge.rest.model.FileRevision
The MIME type of this file.
getMimeType() - Method in class org.sagebionetworks.bridge.rest.model.ParticipantFile
Get mimeType
getMimeType() - Method in class org.sagebionetworks.bridge.rest.model.TemplateRevision
Get mimeType
getMimeType() - Method in class org.sagebionetworks.bridge.rest.model.UploadFieldDefinition
Used for ATTACHMENT_V2 types.
getMinAgeOfConsent() - Method in class org.sagebionetworks.bridge.rest.model.App
The minimum required age for participants in the app.
getMinAppVersions() - Method in class org.sagebionetworks.bridge.rest.model.Criteria
A map of operating system names to minimum app versions.
getMinAppVersions() - Method in class org.sagebionetworks.bridge.rest.model.UploadSchema
A map of operating system names to minimum app versions.
getMinLength() - Method in class org.sagebionetworks.bridge.rest.model.PasswordPolicy
The minimum number of characters that's required in the password.
getMinLength() - Method in class org.sagebionetworks.bridge.rest.model.StringConstraints
The minimum number of characters that should be allowed.
getMinRevision() - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
The earlist (lowest) revision of an assessment that this resource applies to.
getMinRevision() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get minRevision
getMinSupportedAppVersions() - Method in class org.sagebionetworks.bridge.rest.model.App
Minimum supported app versions (older versions will be blocked), keyed by the name of the operating system (we expect either \"Android\" or \"iPhone OS\" in the User-Agent header of all requests sent to the server).
getMinutesToComplete() - Method in class org.sagebionetworks.bridge.rest.model.Assessment
The number of minutes it takes for a participant to complete this assessment.
getMinutesToComplete() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentInfo
The number of minutes it takes for a participant to complete this assessment.
getMinutesToComplete() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentReference2
The number of minutes it takes for a participant to complete this assessment.
getMinutesToComplete() - Method in class org.sagebionetworks.bridge.rest.model.SessionInfo
Get minutesToComplete
getMinValue() - Method in class org.sagebionetworks.bridge.rest.model.DecimalConstraints
Minimum valid value.
getMinValue() - Method in class org.sagebionetworks.bridge.rest.model.DurationConstraints
Maximum valid value.
getMinValue() - Method in class org.sagebionetworks.bridge.rest.model.IntegerConstraints
Minimum valid value.
getModifiedOn() - Method in class org.sagebionetworks.bridge.rest.model.Account
The date and time the account was last modified.
getModifiedOn() - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
The date and time the app config was last modified.
getModifiedOn() - Method in class org.sagebionetworks.bridge.rest.model.AppConfigElement
The date and time the app config was last modified.
getModifiedOn() - Method in class org.sagebionetworks.bridge.rest.model.Assessment
The date and time the assessment was last modified.
getModifiedOn() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentConfig
The date and time the app config was last modified.
getModifiedOn() - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
The date and time the app config was last modified.
getModifiedOn() - Method in class org.sagebionetworks.bridge.rest.model.FileMetadata
The date and time the account was last modified.
getModifiedOn() - Method in class org.sagebionetworks.bridge.rest.model.NotificationRegistration
The last time the registration was updated based on a new device identifier being issued by the client operating system (iOS or Android).
getModifiedOn() - Method in class org.sagebionetworks.bridge.rest.model.NotificationTopic
The date and time this topic was last modified.
getModifiedOn() - Method in class org.sagebionetworks.bridge.rest.model.Organization
The date and time this organization was last modified.
getModifiedOn() - Method in class org.sagebionetworks.bridge.rest.model.Schedule2
The date and time the schedule was last modified.
getModifiedOn() - Method in class org.sagebionetworks.bridge.rest.model.SchedulePlan
Get modifiedOn
getModifiedOn() - Method in class org.sagebionetworks.bridge.rest.model.Study
The date and time the study was last modified.
getModifiedOn() - Method in class org.sagebionetworks.bridge.rest.model.Survey
The date and time when this version of the survey was last modified.
getModifiedOn() - Method in class org.sagebionetworks.bridge.rest.model.Template
The date and time the template was last modified.
getModuleId() - Method in class org.sagebionetworks.bridge.rest.model.Survey
Module ID, if this survey was imported from a shared module.
getModuleId() - Method in class org.sagebionetworks.bridge.rest.model.UploadSchema
Module ID, if this schema was imported from a shared module.
getModuleType() - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleImportStatus
Get moduleType
getModuleType() - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleMetadata
Get moduleType
getModuleVersion() - Method in class org.sagebionetworks.bridge.rest.model.Survey
Module version, if this survey was imported from a shared module.
getModuleVersion() - Method in class org.sagebionetworks.bridge.rest.model.UploadSchema
Module version, if this schema was imported from a shared module.
getMostRecentAppConfigElement(String) - Method in interface org.sagebionetworks.bridge.rest.api.AppConfigsApi
Get most recent app config element Get most recently app config element.
getMostRecentAppConfigElement(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get most recent app config element Get most recently app config element.
getMostRecentAppConfigElements(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.AppConfigsApi
Get a list of the most recent revision of each configuration element in the app Get a list of the app configuration elements in the app, returning the highest revision number for each element in the app.
getMostRecentAppConfigElements(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a list of the most recent revision of each configuration element in the app Get a list of the app configuration elements in the app, returning the highest revision number for each element in the app.
getMostRecentConsent(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get the most recently created consent revision Get the most recently created revision of this subpopulation consent.
getMostRecentConsent(String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyConsentsApi
Get the most recently created consent revision Get the most recently created revision of this subpopulation consent.
getMostRecentDefaultConsentRevision() - Method in interface org.sagebionetworks.bridge.rest.api.ConsentsApi
Deprecated. 
getMostRecentDefaultConsentRevision() - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Deprecated. 
getMostRecentSmsMessage(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Returns the most recent message sent to the phone number of the given user.
getMostRecentSmsMessage(String) - Method in interface org.sagebionetworks.bridge.rest.api.InternalApi
Returns the most recent message sent to the phone number of the given user.
getMostRecentSurveys(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get most recent version of each survey
getMostRecentSurveys(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get most recent version of each survey
getMostRecentSurveys(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.SurveysApi
Get most recent version of each survey
getMostRecentSurveyVersion(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get most recent revision of a survey
getMostRecentSurveyVersion(String) - Method in interface org.sagebionetworks.bridge.rest.api.SurveysApi
Get most recent revision of a survey
getMostRecentUploadSchema(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get the most recent revision of an upload schema
getMostRecentUploadSchema(String) - Method in interface org.sagebionetworks.bridge.rest.api.UploadSchemasApi
Get the most recent revision of an upload schema
getMostRecentUploadSchemas(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get most recent revision of all upload schemas
getMostRecentUploadSchemas(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get most recent revision of all upload schemas
getMostRecentUploadSchemas(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.UploadSchemasApi
Get most recent revision of all upload schemas
getMultiChoiceAnswerList() - Method in class org.sagebionetworks.bridge.rest.model.UploadFieldDefinition
Used for MULTI_CHOICE types.
getName() - Method in class org.sagebionetworks.bridge.rest.model.App
A label for the app.
getName() - Method in class org.sagebionetworks.bridge.rest.model.ConsentSignature
The participant's name.
getName() - Method in class org.sagebionetworks.bridge.rest.model.ConsentStatus
The name of the subpopulation.
getName() - Method in class org.sagebionetworks.bridge.rest.model.Contact
Get name
getName() - Method in class org.sagebionetworks.bridge.rest.model.FileMetadata
Get name
getName() - Method in class org.sagebionetworks.bridge.rest.model.FileRevision
Get name
getName() - Method in class org.sagebionetworks.bridge.rest.model.NotificationTopic
The name of this topic (visible to developers and researchers in design tools).
getName() - Method in class org.sagebionetworks.bridge.rest.model.Organization
The name of the organization.
getName() - Method in class org.sagebionetworks.bridge.rest.model.Schedule2
The name of the schedule as shown to a study designer.
getName() - Method in class org.sagebionetworks.bridge.rest.model.Session
A required name for this session that will be shown to schedule authors, and can be used as a label for participants if no label can be found.
getName() - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleMetadata
User-friendly module name.
getName() - Method in class org.sagebionetworks.bridge.rest.model.Study
The name of the study.
getName() - Method in class org.sagebionetworks.bridge.rest.model.StudyInfo
The name of the study.
getName() - Method in class org.sagebionetworks.bridge.rest.model.Subpopulation
The name of this subpopulation.
getName() - Method in class org.sagebionetworks.bridge.rest.model.Survey
The name of this survey.
getName() - Method in class org.sagebionetworks.bridge.rest.model.Template
Get name
getName() - Method in class org.sagebionetworks.bridge.rest.model.UploadFieldDefinition
Field name.
getName() - Method in class org.sagebionetworks.bridge.rest.model.UploadRequest
File name
getName() - Method in class org.sagebionetworks.bridge.rest.model.UploadSchema
User-friendly schema name.
getName() - Method in class org.sagebionetworks.bridge.rest.model.UserConsentHistory
Full name as entered by the participant.
getNamespace() - Method in class org.sagebionetworks.bridge.rest.model.AndroidAppLink
Get namespace
getNationalFormat() - Method in class org.sagebionetworks.bridge.rest.model.Phone
The phone number formatted in the commonly accepted national format of the region code.
getNextPageOffsetKey() - Method in class org.sagebionetworks.bridge.rest.model.ForwardCursorPagedResourceList
The offsetKey to be provided in the next request to get the next page of resources.
getNoneOfGroups() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
Return records that have none of these data groups
getNoneOfGroups() - Method in class org.sagebionetworks.bridge.rest.model.Criteria
One or more data groups; the user must have none of these data groups to match.
getNoneOfGroups() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get noneOfGroups
getNoneOfStudyIds() - Method in class org.sagebionetworks.bridge.rest.model.Criteria
One or more study IDs; the user cannot be assigned to any of these studies for the associated object to match.
getNormingStatus() - Method in class org.sagebionetworks.bridge.rest.model.Assessment
Get normingStatus
getNote() - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
Optional note related to user account.
getNote() - Method in class org.sagebionetworks.bridge.rest.model.Account
Optional note related to user account.
getNote() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummary
Optional note related to user account.
getNote() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
Optional note related to user account.
getNote() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
Optional note related to user account.
getNotes() - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleMetadata
User-friendly descriptive notes for the module.
getNotificationRegistration(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get a push notification registration Get a single push notification registration by its GUID.
getNotificationRegistrations() - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get all of a user's notification registrations Return all the registrations for this user.
getNotifications() - Method in class org.sagebionetworks.bridge.rest.model.Session
A collection of notifications to show around the execution of a session window.
getNotifications() - Method in class org.sagebionetworks.bridge.rest.model.SessionInfo
Get notifications
getNotificationTopic(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a notification topic
getNotificationTopic(String) - Method in interface org.sagebionetworks.bridge.rest.api.NotificationsApi
Get a notification topic
getNotificationTopics(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get all the notification topics in this app Return all the topics defined for this app.
getNotificationTopics(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.NotificationsApi
Get all the notification topics in this app Return all the topics defined for this app.
getNotifyAt() - Method in class org.sagebionetworks.bridge.rest.model.Notification
Get notifyAt
getNotifyAt() - Method in class org.sagebionetworks.bridge.rest.model.NotificationInfo
Get notifyAt
getNumber() - Method in class org.sagebionetworks.bridge.rest.model.Phone
The phone number (can be formatted in any way that's useful for end users).
getOAuthAccessToken(String, String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get the access grant for a given account as specified by a health code.
getOAuthProviders() - Method in class org.sagebionetworks.bridge.rest.model.App
The metadata to contact OAuth providers for the Authorization Code Grant Flow.
getOccurrences() - Method in class org.sagebionetworks.bridge.rest.model.Session
If the session has an interval, the user should perform the session until the end of the schedule’s duration, *unless* a smaller number of repetitions is specified via `occurrences`.
getOffset() - Method in class org.sagebionetworks.bridge.rest.model.Notification
The time after a window starts or before it ends (based on the `notifyAt` property) when a notification should be shown to the user.
getOffset() - Method in class org.sagebionetworks.bridge.rest.model.NotificationInfo
The time after a window starts or before it ends (based on the `notifyAt` property) when a notification should be shown to the user.
getOffsetBy() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
Next page start offset for pagination
getOffsetBy() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
The next page start offset for pagination.
getOffsetBy() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get offsetBy
getOffsetKey() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get offsetKey
getOperator() - Method in class org.sagebionetworks.bridge.rest.model.SurveyRule
Get operator
getOrganization(String) - Method in interface org.sagebionetworks.bridge.rest.api.OrganizationsApi
Get an organization Get a single organization record.
getOrganizations(Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.OrganizationsApi
Get all of the organizations in an app Return all the organizations that have been defined for the app context of the caller.
getOrgMembership() - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
The identifier of the organization this account is a member of (this will be an administrative account and not a study participant).
getOrgMembership() - Method in class org.sagebionetworks.bridge.rest.model.Account
The identifier of the organization this account is a member of (this will be an administrative account and not a study participant).
getOrgMembership() - Method in class org.sagebionetworks.bridge.rest.model.AccountRef
Get orgMembership
getOrgMembership() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummary
The identifier of the organization this account is a member of (this will be an administrative account and not a study participant).
getOrgMembership() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
Return records that are members of this organization (specified by the organization’s ID).
getOrgMembership() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get orgMembership
getOrgMembership() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
The identifier of the organization this account is a member of (this will be an administrative account and not a study participant).
getOrgMembership() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
The identifier of the organization this account is a member of (this will be an administrative account and not a study participant).
getOrgMembership() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
The identifier of the organization this account is a member of (this will be an administrative account and not a study participant).
getOriginGuid() - Method in class org.sagebionetworks.bridge.rest.model.Assessment
If this assessment was copied from a shared assessment, this will be the GUID of the shared assessment revision that was used to make this copy.
getOs() - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleMetadata
Which OS (iOS, Android, etc) this module applies to, if the module is OS-specific.
getOsName() - Method in class org.sagebionetworks.bridge.rest.Config
 
getOsName() - Method in class org.sagebionetworks.bridge.rest.model.Assessment
The name of the operating system (conventional names are \"Android,\" \"iPhone OS,\" and \"Both\").
getOsName() - Method in class org.sagebionetworks.bridge.rest.model.ClientInfo
The name of the operating system (conventional names are \"Android\" and \"iPhone OS\").
getOsName() - Method in class org.sagebionetworks.bridge.rest.model.IntentToParticipate
The operating system name under which the install link can be retrieved.
getOsName() - Method in class org.sagebionetworks.bridge.rest.model.NotificationRegistration
Information used to track which type of deviceId is being submitted.
getOsVersion() - Method in class org.sagebionetworks.bridge.rest.Config
 
getOsVersion() - Method in class org.sagebionetworks.bridge.rest.model.ClientInfo
The version of the operating system (e.g.
getOwnerId() - Method in class org.sagebionetworks.bridge.rest.model.Assessment
The ID of the organization that owns this assessment.
getOwnerId() - Method in class org.sagebionetworks.bridge.rest.model.Schedule2
The identifier of the organization that owns this schedule.
getPackageName() - Method in class org.sagebionetworks.bridge.rest.model.AndroidAppLink
Get packageName
getPageSize() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
Maximum number of records in each returned page maximum: 100
getPageSize() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
The maximum number of records in each returned page.
getPageSize() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get pageSize
getParticipant() - Method in class org.sagebionetworks.bridge.rest.model.EnrollmentDetail
Get participant
getParticipantActivityHistory(String, String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get a study participant's history of activities This endpoint can be called by researchers, and by other administrators for their own account.
getParticipantActivityHistory(String, String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
Get a study participant's history of activities This endpoint can be called by researchers, and by other administrators for their own account.
getParticipantActivityHistoryForApp(String, String, String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get a study participant's history of activities
getParticipantByExternalId(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get a study participant (user) record using the external ID of the account
getParticipantByExternalId(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
Get a study participant (user) record using the external ID of the account
getParticipantByExternalIdForApp(String, String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get a study participant (user) record in an app using the account's external ID.
getParticipantByHealthCode(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get a study participant (user) record using the health code of the account
getParticipantByHealthCode(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
Get a study participant (user) record using the health code of the account
getParticipantByHealthCodeForApp(String, String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get a study participant (user) record in an app using the account's health code.
getParticipantById(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get a study participant (user) record This endpoint can be called by researchers (all authenticated users can retrieve their own StudyParticipant record by using the `getUsersParticipantRecord` method, which should be used by administrative accounts as well, such as developers).
getParticipantById(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
Get a study participant (user) record This endpoint can be called by researchers (all authenticated users can retrieve their own StudyParticipant record by using the `getUsersParticipantRecord` method, which should be used by administrative accounts as well, such as developers).
getParticipantByIdForApp(String, String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get a study participant (user) record in an app
getParticipantBySynapseUserId(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get a study participant (user) record using the Synapse user ID of the account
getParticipantBySynapseUserId(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
Get a study participant (user) record using the Synapse user ID of the account
getParticipantBySynapseUserIdForApp(String, String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get a study participant (user) record in an app using the account's Synapse user ID.
getParticipantCompoundActivityHistory(String, String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get a study participant's history of a compound activity This endpoint can be called by researchers, and by other administrators for their own account.
getParticipantCompoundActivityHistory(String, String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
Get a study participant's history of a compound activity This endpoint can be called by researchers, and by other administrators for their own account.
getParticipantCompoundActivityHistoryForApp(String, String, String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get a study participant's history of a compound activity
getParticipantFile(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get a participant file
getParticipantFile(String) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantFilesApi
Get a participant file
getParticipantFiles(String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get a list of participant files from the user
getParticipantFiles(String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantFilesApi
Get a list of participant files from the user
getParticipantPushNotificationRegistrations(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get a study participant's push notification registrations Get all of a study participant's registrations for push notifications.
getParticipantPushNotificationRegistrations(String) - Method in interface org.sagebionetworks.bridge.rest.api.NotificationsApi
Get a study participant's push notification registrations Get all of a study participant's registrations for push notifications.
getParticipantPushNotificationRegistrations(String) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
Get a study participant's push notification registrations Get all of a study participant's registrations for push notifications.
getParticipantReportForWorker(String, String, String, LocalDate, LocalDate) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get participant report records by date
getParticipantReportForWorkerV4(String, String, String, DateTime, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get participant report records by date
getParticipantReportForWorkerV4(String, String, String, DateTime, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantReportsApi
Get participant report records by date
getParticipantReportIndex(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get a single report index for participant reports
getParticipantReportIndex(String) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantReportsApi
Get a single report index for participant reports
getParticipantReportIndices() - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get list of report indices for participants
getParticipantReportIndices() - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantReportsApi
Get list of report indices for participants
getParticipantReportRecords(String, LocalDate, LocalDate) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get a participant report Get the records for a specific participant report.
getParticipantReportRecords(String, LocalDate, LocalDate) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantReportsApi
Get a participant report Get the records for a specific participant report.
getParticipantReportRecords(String, LocalDate, LocalDate) - Method in interface org.sagebionetworks.bridge.rest.api.UsersApi
Get a participant report Get the records for a specific participant report.
getParticipantReportRecordsV4(String, DateTime, DateTime, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get a participant report Get the records for a specific participant report.
getParticipantReportRecordsV4(String, DateTime, DateTime, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantReportsApi
Get a participant report Get the records for a specific participant report.
getParticipantReportRecordsV4(String, DateTime, DateTime, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.UsersApi
Get a participant report Get the records for a specific participant report.
getParticipantReportsForParticipant(String, String, String, LocalDate, LocalDate) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get participant report records by date.
getParticipantReportsForParticipantV2(String, String, String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get participant report records by date-time
getParticipantRequestInfo(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get information about the last request made by this participant Retrieves information about the user agent headers and participant settings that were in effect the last time this participant contacted the Bridge server.
getParticipantRequestInfo(String) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
Get information about the last request made by this participant Retrieves information about the user agent headers and participant settings that were in effect the last time this participant contacted the Bridge server.
getParticipantRoster(ParticipantRosterRequest) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get a roster of participants within an app, and optionally within a studyId.
getParticipantRoster(ParticipantRosterRequest) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Get a roster of participants within an app, and optionally within a studyId.
getParticipantRoster(ParticipantRosterRequest) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
Get a roster of participants within an app, and optionally within a studyId.
getParticipants(Integer, Integer, String, String, DateTime, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Deprecated. 
getParticipants(Integer, Integer, String, String, DateTime, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
Deprecated. 
getParticipantsForApp(String, Integer, Integer, String, String, DateTime, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get a paged list of study participants for an app
getParticipantSurveyHistory(String, String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get a study participant's history of a survey This endpoint can be called by researchers, and by other administrators for their own account.
getParticipantSurveyHistory(String, String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
Get a study participant's history of a survey This endpoint can be called by researchers, and by other administrators for their own account.
getParticipantSurveyHistoryForApp(String, String, String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get a study participant's history of a survey
getParticipantTaskHistory(String, String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get a study participant's history of a task This endpoint can be called by researchers, and by other administrators for their own account.
getParticipantTaskHistory(String, String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
Get a study participant's history of a task This endpoint can be called by researchers, and by other administrators for their own account.
getParticipantTaskHistoryForApp(String, String, String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get a study participant's history of a task
getParticipantUploads(String, DateTime, DateTime, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get a study participant's upload history Retrieve information about the uploads from a user.
getParticipantUploads(String, DateTime, DateTime, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
Get a study participant's upload history Retrieve information about the uploads from a user.
getPassword() - Method in class org.sagebionetworks.bridge.rest.model.Account
Account password.
getPassword() - Method in class org.sagebionetworks.bridge.rest.model.GeneratedPassword
A randomly generated password.
getPassword() - Method in class org.sagebionetworks.bridge.rest.model.ParticipantRosterRequest
User defined password.
getPassword() - Method in class org.sagebionetworks.bridge.rest.model.PasswordReset
New password to use.
getPassword() - Method in class org.sagebionetworks.bridge.rest.model.SignIn
User's password
getPassword() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
User's password.
getPasswordPolicy() - Method in class org.sagebionetworks.bridge.rest.model.App
Settings that will govern what is accepted as a valid password when users sign up for the app.
getPaths() - Method in class org.sagebionetworks.bridge.rest.model.AppleAppLink
Get paths
getPattern() - Method in class org.sagebionetworks.bridge.rest.model.StringConstraints
A regular expression pattern (omitting slashes) against with the input should be validated.
getPatternErrorMessage() - Method in class org.sagebionetworks.bridge.rest.model.StringConstraints
If a pattern is provided, an error message is required, explaining the desired format if the data does not fit the pattern.
getPatternPlaceholder() - Method in class org.sagebionetworks.bridge.rest.model.StringConstraints
An example of the data to be entered, usually shown in or next to the input control (e.g.
getPercentage() - Method in class org.sagebionetworks.bridge.rest.model.ABTestGroup
The percentage of users to assign to this schedule.
getPerformanceOrder() - Method in class org.sagebionetworks.bridge.rest.model.Session
Get performanceOrder
getPerformanceOrder() - Method in class org.sagebionetworks.bridge.rest.model.SessionInfo
Get performanceOrder
getPhase() - Method in class org.sagebionetworks.bridge.rest.model.Study
The lifecycle phase this study is in.
getPhase() - Method in class org.sagebionetworks.bridge.rest.model.StudyInfo
The lifecycle phase this study is in.
getPhone() - Method in class org.sagebionetworks.bridge.rest.model.Account
Get phone
getPhone() - Method in class org.sagebionetworks.bridge.rest.model.AccountRef
Get phone
getPhone() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummary
Get phone
getPhone() - Method in class org.sagebionetworks.bridge.rest.model.Contact
Get phone
getPhone() - Method in class org.sagebionetworks.bridge.rest.model.Identifier
Get phone
getPhone() - Method in class org.sagebionetworks.bridge.rest.model.IntentToParticipate
Get phone
getPhone() - Method in class org.sagebionetworks.bridge.rest.model.PhoneSignIn
Get phone
getPhone() - Method in class org.sagebionetworks.bridge.rest.model.PhoneSignInRequest
Get phone
getPhone() - Method in class org.sagebionetworks.bridge.rest.model.SignIn
Get phone
getPhone() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
Get phone
getPhone() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
Get phone
getPhone() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
Get phone
getPhoneFilter() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
Return records that match this substring in their phone number
getPhoneFilter() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get phoneFilter
getPhoneInfo() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecord
Phone info, for example \"iPhone9,3\" or \"iPhone 5c (GSM)\".
getPhoneInfo() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataSubmission
Phone info, for example \"iPhone9,3\" or \"iPhone 5c (GSM)\".
getPhoneNumber() - Method in class org.sagebionetworks.bridge.rest.model.SmsMessage
The phone number receiving this message, formatted in E.164 international format.
getPhoneUpdate() - Method in class org.sagebionetworks.bridge.rest.model.IdentifierUpdate
A phone number to add to the account.
getPlaceName() - Method in class org.sagebionetworks.bridge.rest.model.Address
Get placeName
getPosition() - Method in class org.sagebionetworks.bridge.rest.model.Contact
Get position
getPostalCode() - Method in class org.sagebionetworks.bridge.rest.model.Address
Get postalCode
getPredicate() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
How search criteria should be evaluated in a search (whether any criteria or all criteria must match).
getPredicate() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
How search criteria should be evaluated in a search (whether any criteria or all criteria must match).
getPredicate() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get predicate
getPrompt() - Method in class org.sagebionetworks.bridge.rest.model.SurveyInfoScreen
The main instructions or information text for the user
getPrompt() - Method in class org.sagebionetworks.bridge.rest.model.SurveyQuestion
The question proper.
getPromptDetail() - Method in class org.sagebionetworks.bridge.rest.model.SurveyInfoScreen
Further information on the instructions, displayed in a secondary manner to the prompt (smaller text, more button, etc.).
getPromptDetail() - Method in class org.sagebionetworks.bridge.rest.model.SurveyQuestion
Sub-question text that provides further instructions or clarifications on how to answer.
getPropertyName() - Method in enum org.sagebionetworks.bridge.rest.Config.Props
 
getPropName() - Method in class org.sagebionetworks.bridge.rest.model.PropertyInfo
The property name of the property on the JSON object that can be edited.
getPropType() - Method in class org.sagebionetworks.bridge.rest.model.PropertyInfo
A type hint to a UI editor for this property.
getProtocol() - Method in class org.sagebionetworks.bridge.rest.model.NotificationRegistration
Get protocol
getProviderUserId() - Method in class org.sagebionetworks.bridge.rest.model.OAuthAccessToken
The provider's ID for this user.
getPublicKey() - Method in class org.sagebionetworks.bridge.rest.model.CmsPublicKey
Base 64 encoded version of the public key for CMS encryption of upload data.
getPublicStudyReportRecords(String, String, LocalDate, LocalDate) - Method in interface org.sagebionetworks.bridge.rest.api.PublicApi
Get public study report records Get public study report records (no authentication is needed, but index for the report must be marked as public or the server will return 404 for the report).
getPublicStudyReportRecords(String, String, LocalDate, LocalDate) - Method in interface org.sagebionetworks.bridge.rest.api.StudyReportsApi
Get public study report records Get public study report records (no authentication is needed, but index for the report must be marked as public or the server will return 404 for the report).
getPublishedConsent(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get the published consent revision Get the published revision of this subpopulation consent.
getPublishedConsent(String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyConsentsApi
Get the published consent revision Get the published revision of this subpopulation consent.
getPublishedConsentCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.Subpopulation
The creation date (ISO 8601 timestamp) of the version of the consent agreement for this subpopulation that is published, ie.
getPublishedCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.Template
The date and time of the template revision that is the published revision to use.
getPublishedDefaultConsentRevision() - Method in interface org.sagebionetworks.bridge.rest.api.ConsentsApi
Deprecated. 
getPublishedDefaultConsentRevision() - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Deprecated. 
getPublishedSurveys(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get the most recently published version of each survey
getPublishedSurveys(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.SurveysApi
Get the most recently published version of each survey
getPublishedSurveyVersion(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get most recently published revision of a survey
getPublishedSurveyVersion(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get most recently published revision of a survey
getPublishedSurveyVersion(String) - Method in interface org.sagebionetworks.bridge.rest.api.SurveysApi
Get most recently published revision of a survey
getPublishers() - Method in class org.sagebionetworks.bridge.rest.model.ExternalResource
A list of the publishers (or institutions, or even hosting sites) supporting publication of the documentation.
getPushNotificationARNs() - Method in class org.sagebionetworks.bridge.rest.model.App
A map between operating system names, and the platform ARN necessary to register a device to receive mobile push notifications.
getRawDataAttachmentId() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecord
Attachment ID (S3 key) that contains the raw data.
getReason() - Method in class org.sagebionetworks.bridge.rest.model.Withdrawal
An optional, free text description from the participant about why they are no longer participating in the study.
getReauthToken() - Method in class org.sagebionetworks.bridge.rest.model.SignIn
The token sent with a new session to reauthenticate with the server.
getReauthToken() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
A token, supplied when a new session is returned, that can be used to refresh the session at a later time.
getRecord() - Method in class org.sagebionetworks.bridge.rest.model.UploadValidationStatus
Get record
getRecordCount() - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEvent
The number of unique timestamp values that have been recorded for this events.
getRecordEx3(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Retrieves the record for the given ID from the Exporter 3 implemention.
getRecordEx3(String) - Method in interface org.sagebionetworks.bridge.rest.api.InternalApi
Retrieves the record for the given ID from the Exporter 3 implemention.
getRecordId() - Method in class org.sagebionetworks.bridge.rest.model.Upload
The record ID of the upload in Synapse.
getRecordIds() - Method in class org.sagebionetworks.bridge.rest.model.RecordExportStatusRequest
One or more [HealthDataRecord](#HealthDataRecord) IDS.
getRecords() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordUpdates
Get records
getRecordsEx3ForCurrentApp(DateTime, DateTime, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Retrieves all records from the Exporter 3 implemention in the current app for the given time range.
getRecordsEx3ForCurrentApp(DateTime, DateTime, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.InternalApi
Retrieves all records from the Exporter 3 implemention in the current app for the given time range.
getRecordsEx3ForStudy(String, DateTime, DateTime, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Retrieves all records from the Exporter 3 implementation in the current app for the given study and time range.
getRecordsEx3ForStudy(String, DateTime, DateTime, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.InternalApi
Retrieves all records from the Exporter 3 implementation in the current app for the given study and time range.
getRecordsEx3ForUser(String, DateTime, DateTime, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Retrieves all records from the Exporter 3 implementation for the given user and time range.
getRecordsEx3ForUser(String, DateTime, DateTime, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.InternalApi
Retrieves all records from the Exporter 3 implementation for the given user and time range.
getRecordType() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get recordType
getRefGuid() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledSession
Get refGuid
getRefKey() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledAssessment
Get refKey
getRegionCode() - Method in class org.sagebionetworks.bridge.rest.model.Phone
CLDR two-letter region code describing the region in which the phone number was issued.
getReportType() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get reportType
getRequestedOn() - Method in class org.sagebionetworks.bridge.rest.model.Upload
The date and time (ISO 8601 format) that the client requested an URL to make an upload to the server.
getRequestInfoForWorker(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get information about the last request made by this participant Retrieves information about the user agent headers and participant settings that were in effect the last time this participant contacted the Bridge server.
getRequestInfoForWorker(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantReportsApi
Get information about the last request made by this participant Retrieves information about the user agent headers and participant settings that were in effect the last time this participant contacted the Bridge server.
getRequestParams() - Method in class org.sagebionetworks.bridge.rest.model.ResourceList
Get requestParams
getRequestTemplate() - Method in class org.sagebionetworks.bridge.rest.model.MasterSchedulerConfig
An arbitrary JSON object containing template for the request to be sent to the configured SQS queue.
getRestEndpoint() - Method in exception org.sagebionetworks.bridge.rest.exceptions.BridgeSDKException
 
getRevision() - Method in class org.sagebionetworks.bridge.rest.model.AppConfigElement
Revision number of the app config element, used to distinguish revisions of the element.
getRevision() - Method in class org.sagebionetworks.bridge.rest.model.Assessment
Get revision
getRevision() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentInfo
The revision of the assessment under the given identifier (the identifier and the revision together are mapped to a single GUID which can be used to reference the assessment; only the GUID is required in this object).
getRevision() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentReference2
The revision of the assessment under the given identifier (the identifier and the revision together are mapped to a single GUID which can be used to reference the assessment; only the GUID is required in this object).
getRevision() - Method in class org.sagebionetworks.bridge.rest.model.ConfigReference
Revision number
getRevision() - Method in class org.sagebionetworks.bridge.rest.model.SchemaReference
Schema revision number.
getRevision() - Method in class org.sagebionetworks.bridge.rest.model.UploadSchema
Revision number of the schema, used to distinguish versions of the same data format.
getRole() - Method in class org.sagebionetworks.bridge.rest.model.Contact
Get role
getRoles() - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
Get roles
getRoles() - Method in class org.sagebionetworks.bridge.rest.model.Account
Get roles
getRoles() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
Get roles
getRoles() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
Get roles
getRoles() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
Get roles
getSchedule() - Method in class org.sagebionetworks.bridge.rest.model.ABTestGroup
The schedule to assign to these users.
getSchedule() - Method in class org.sagebionetworks.bridge.rest.model.ScheduleCriteria
Get schedule
getSchedule() - Method in class org.sagebionetworks.bridge.rest.model.SimpleScheduleStrategy
Get schedule
getSchedule() - Method in class org.sagebionetworks.bridge.rest.model.Timeline
Get schedule
getScheduleCriteria() - Method in class org.sagebionetworks.bridge.rest.model.CriteriaScheduleStrategy
The list of schedules and their criteria.
getScheduledActivities(String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ActivitiesApi
Get a list of the participant's scheduled activities Gets all available, started, or scheduled activities for a user.
getScheduledActivities(String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get a list of the participant's scheduled activities Gets all available, started, or scheduled activities for a user.
getScheduledActivitiesByDateRange(DateTime, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ActivitiesApi
Get a list of the participant's scheduled activities Get all scheduled activities in a given date range (from inclusive `startTime` to excluded `endTime`, must be less than 32 days), in one or more pages of results.
getScheduledActivitiesByDateRange(DateTime, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get a list of the participant's scheduled activities Get all scheduled activities in a given date range (from inclusive `startTime` to excluded `endTime`, must be less than 32 days), in one or more pages of results.
getScheduledOn() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledActivity
The time at which the activity should be made available to the participant.
getScheduledOnEnd() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get scheduledOnEnd
getScheduledOnStart() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get scheduledOnStart
getScheduleForStudy(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get the schedule for this study (returns 404 if a schedule has not been created for the study).
getScheduleForStudy(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Get the schedule for this study (returns 404 if a schedule has not been created for the study).
getScheduleForStudy(String) - Method in interface org.sagebionetworks.bridge.rest.api.SchedulesV2Api
Get the schedule for this study (returns 404 if a schedule has not been created for the study).
getScheduleGroups() - Method in class org.sagebionetworks.bridge.rest.model.ABTestScheduleStrategy
Get scheduleGroups
getScheduleGuid() - Method in class org.sagebionetworks.bridge.rest.model.Study
The GUID of the schedule to use for this study.
getScheduleId() - Method in class org.sagebionetworks.bridge.rest.model.MasterSchedulerConfig
schedule identifier
getSchedulePlan(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Get a schedule plan
getSchedulePlan(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a schedule plan
getSchedulePlan(String) - Method in interface org.sagebionetworks.bridge.rest.api.SchedulesV1Api
Get a schedule plan
getSchedulePlanGuid() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledActivity
Get schedulePlanGuid
getSchedulePlans(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get schedule plans
getSchedulePlans(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get schedule plans
getSchedulePlans(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.SchedulesV1Api
Get schedule plans
getSchedulePlansForApp(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get schedule plans
getSchedulerConfig(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForSuperadminsApi
Get a scheduler config
getSchedulerStatus() - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Get the last time the scheduler ran
getSchedulesV1() - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get schedules for user
getSchedulesV1() - Method in interface org.sagebionetworks.bridge.rest.api.SchedulesV1Api
Get schedules for user
getScheduleType() - Method in class org.sagebionetworks.bridge.rest.model.Schedule
Get scheduleType
getSchema() - Method in class org.sagebionetworks.bridge.rest.model.TaskReference
Get schema
getSchemaId() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecord
[UploadSchema](#UploadSchema) ID for the record.
getSchemaId() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataSubmission
[UploadSchema](#UploadSchema) ID for the record.
getSchemaId() - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleImportStatus
Schema ID, if this module is a schema.
getSchemaId() - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleMetadata
Schema ID, if this module is a schema.
getSchemaId() - Method in class org.sagebionetworks.bridge.rest.model.Upload
The ID of the schema for this upload.
getSchemaId() - Method in class org.sagebionetworks.bridge.rest.model.UploadSchema
Unique identifier for the schema.
getSchemaList() - Method in class org.sagebionetworks.bridge.rest.model.CompoundActivity
Get schemaList
getSchemaList() - Method in class org.sagebionetworks.bridge.rest.model.CompoundActivityDefinition
Get schemaList
getSchemaReferences() - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
Get schemaReferences
getSchemaRevision(String, String, Long) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get a schema revision from an app
getSchemaRevision() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecord
[UploadSchema](#UploadSchema) revision for the record.
getSchemaRevision() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataSubmission
[UploadSchema](#UploadSchema) revision for the record.
getSchemaRevision() - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleImportStatus
Schema revision, if this module is a schema.
getSchemaRevision() - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleMetadata
Schema revision, if this module is a schema.
getSchemaRevision() - Method in class org.sagebionetworks.bridge.rest.model.Survey
The corresponding schema revision that Bridge server uses to export survey answers to Synapse.
getSchemaRevision() - Method in class org.sagebionetworks.bridge.rest.model.Upload
The revision for the schema of this upload.
getSchemaType() - Method in class org.sagebionetworks.bridge.rest.model.UploadSchema
Get schemaType
getScope() - Method in class org.sagebionetworks.bridge.rest.model.ConsentSignature
Get scope
getScope() - Method in class org.sagebionetworks.bridge.rest.model.IntentToParticipate
Get scope
getScope() - Method in class org.sagebionetworks.bridge.rest.model.SharingScopeForm
Get scope
getScopes() - Method in class org.sagebionetworks.bridge.rest.model.OAuthAccessToken
Scopes attached to the OAuth access token.
getSdkName() - Method in class org.sagebionetworks.bridge.rest.model.ClientInfo
The name of the SDK being used (e.g.
getSdkVersion() - Method in class org.sagebionetworks.bridge.rest.Config
 
getSdkVersion() - Method in class org.sagebionetworks.bridge.rest.model.ClientInfo
The version of the SDK being used (e.g.
getSecret() - Method in class org.sagebionetworks.bridge.rest.model.OAuthProvider
The secret token that the server must provide.
getSentOn() - Method in class org.sagebionetworks.bridge.rest.model.SmsMessage
Timestamp in ISO8601 format when we sent the message.
getSequencePeriod() - Method in class org.sagebionetworks.bridge.rest.model.Schedule
A recurring schedule can specify a sequence in a crossover study design.
getSession() - Method in exception org.sagebionetworks.bridge.rest.exceptions.ConsentRequiredException
 
getSession() - Method in class org.sagebionetworks.bridge.rest.UserSessionInfoProvider
 
getSessionGuids() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
Return adherence records for sessions with these GUIDs (this is the session’s GUID in a schedule and not an instance GUID, and is used to define a type of session).
getSessionGuids() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get sessionGuids
getSessionOfClients() - Method in class org.sagebionetworks.bridge.rest.ClientManager
 
getSessions() - Method in class org.sagebionetworks.bridge.rest.model.Schedule2
An ordered collection of sessions.
getSessions() - Method in class org.sagebionetworks.bridge.rest.model.Timeline
Get sessions
getSessionToken() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
The session token that must be returned to the server to access services requiring authentication.
getSha256CertFingerprints() - Method in class org.sagebionetworks.bridge.rest.model.AndroidAppLink
Get sha256CertFingerprints
getSharedAssessmentByGUID(String) - Method in interface org.sagebionetworks.bridge.rest.api.PublicApi
Get an assessment revision.
getSharedAssessmentByGUID(String) - Method in interface org.sagebionetworks.bridge.rest.api.SharedAssessmentsApi
Get an assessment revision.
getSharedAssessmentById(String, Long) - Method in interface org.sagebionetworks.bridge.rest.api.SharedAssessmentsApi
Get an assessment revision by identifier and revision number.
getSharedAssessmentConfig(String) - Method in interface org.sagebionetworks.bridge.rest.api.PublicApi
Get the configuration JSON for a shared assessmentapp context.
getSharedAssessmentConfig(String) - Method in interface org.sagebionetworks.bridge.rest.api.SharedAssessmentsApi
Get the configuration JSON for a shared assessmentapp context.
getSharedAssessmentResource(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.PublicApi
Get a external resource link documenting a shared assessment
getSharedAssessmentResource(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.SharedAssessmentsApi
Get a external resource link documenting a shared assessment
getSharedAssessmentResources(String, Integer, Integer, List<String>, Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.PublicApi
Get the external resource links documenting an assessment
getSharedAssessmentResources(String, Integer, Integer, List<String>, Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.SharedAssessmentsApi
Get the external resource links documenting an assessment
getSharedAssessmentRevisionsByGUID(String, Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.PublicApi
Get all revisions of an assessment using the GUID of one of the revisions.
getSharedAssessmentRevisionsByGUID(String, Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.SharedAssessmentsApi
Get all revisions of an assessment using the GUID of one of the revisions.
getSharedAssessmentRevisionsById(String, Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.PublicApi
Get all revisions of an assessment with a specific identifier.
getSharedAssessmentRevisionsById(String, Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.SharedAssessmentsApi
Get all revisions of an assessment with a specific identifier.
getSharedAssessments(Integer, Integer, List<String>, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.PublicApi
Get assessments in the shared library.
getSharedAssessments(Integer, Integer, List<String>, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.SharedAssessmentsApi
Get assessments in the shared library.
getSharedId() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentReference
If imported from a shared assessment, the identifier of the shard assessment (this may not be unique between two different references in the set of references)
getSharingScope() - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
Get sharingScope
getSharingScope() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
Get sharingScope
getSharingScope() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
Get sharingScope
getSharingScope() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
Get sharingScope
getShortName() - Method in class org.sagebionetworks.bridge.rest.model.App
A very short label (10 characters or less) for SMS messages and any other highly constrainted contexts.
getShortName() - Method in class org.sagebionetworks.bridge.rest.model.NotificationTopic
Short name for the topic, used as the display name for the topic in SNS.
getSignedInOn() - Method in class org.sagebionetworks.bridge.rest.model.RequestInfo
The last recorded time the participant signed in to the server.
getSignedOn() - Method in class org.sagebionetworks.bridge.rest.model.ConsentSignature
The date and time the referenced consent was signed and agreed to by the participant.
getSignedOn() - Method in class org.sagebionetworks.bridge.rest.model.ConsentStatus
The date and time the referenced consent was signed and agreed to by the participant.
getSignedOn() - Method in class org.sagebionetworks.bridge.rest.model.UserConsentHistory
ISO 8601 date and time that the consent was signed by the user.
getSignIn() - Method in class org.sagebionetworks.bridge.rest.model.IdentifierUpdate
Get signIn
getSignInTypes() - Method in class org.sagebionetworks.bridge.rest.model.Study
Get signInTypes
getSignInTypes() - Method in class org.sagebionetworks.bridge.rest.model.StudyInfo
Get signInTypes
getSize() - Method in class org.sagebionetworks.bridge.rest.model.FileRevision
The size of the file in bytes.
getSkipTo() - Method in class org.sagebionetworks.bridge.rest.model.SurveyRule
The property will reference an identifier for a question in the survey.
getSmsType() - Method in class org.sagebionetworks.bridge.rest.model.SmsMessage
Get smsType
getSortOrder() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
Get sortOrder
getSortOrder() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get sortOrder
getSource() - Method in class org.sagebionetworks.bridge.rest.model.Image
An URL to an image.
getSparseZipCodePrefixes() - Method in class org.sagebionetworks.bridge.rest.model.PostalCodeConstraints
Some 3 digit codes describe areas of 20,000 or less people; for these exceptional codes, which can more easily be used to reidentify participants, substitute the value \"000\" instead before submitting the survey answer to the server.
getSponsoredStudies(String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.OrganizationsApi
Get the studies that are sponsored by this organization.
getSponsoredStudiesForApp(String, String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.AppsApi
Get the studies that are sponsored by the organization
getSponsoredStudiesForApp(String, String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get the studies that are sponsored by the organization
getSponsoredStudiesForApp(String, String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.OrganizationsApi
Get the studies that are sponsored by the organization
getSponsorName() - Method in class org.sagebionetworks.bridge.rest.model.App
The name of the institution or organization that is conducting the app.
getSponsors(String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get the sponsors of this study.
getSponsors(String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForOrgAdminsApi
Get the sponsors of this study.
getSponsors(String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get the sponsors of this study.
getSponsors(String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Get the sponsors of this study.
getSponsors(String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get the sponsors of this study.
getSponsors(String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.OrganizationsApi
Get the sponsors of this study.
getSponsors(String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.StudiesApi
Get the sponsors of this study.
getSptoken() - Method in class org.sagebionetworks.bridge.rest.model.PasswordReset
This is a one-time use token issued to the user to change his or her password.
getSptoken() - Method in class org.sagebionetworks.bridge.rest.model.Verification
The token sent via email or SMS message to the user
getSqsQueueUrl() - Method in class org.sagebionetworks.bridge.rest.model.MasterSchedulerConfig
SQS queue URL to send requests to
getStartDate() - Method in class org.sagebionetworks.bridge.rest.model.DateRange
Start date of the date range (YYYY-MM-DD).
getStartDate() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get startDate
getStartDay() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledSession
Get startDay
getStartedOn() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecord
The client-supplied time when the activity was started (this time comes from the client and is not validated by the server).
getStartedOn() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledActivity
This field is filled out by the client to persist the fact that a task has been started.
getStartEventId() - Method in class org.sagebionetworks.bridge.rest.model.Session
An identifier for the event which should be used to schedule this sequence of sessions.
getStartEventId() - Method in class org.sagebionetworks.bridge.rest.model.SessionInfo
An identifier for the event which should be used to schedule this sequence of sessions.
getStartsOn() - Method in class org.sagebionetworks.bridge.rest.model.Schedule
The scheduler will not create a task before this date and time.
getStartTime() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
Return record created on or after this day
getStartTime() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
Limit search results to records with `startedOn` values that are equal to or later than this start time (no earlier than January 1st, 2020).
getStartTime() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get startTime
getStartTime() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledSession
Get startTime
getStartTime() - Method in class org.sagebionetworks.bridge.rest.model.TimeWindow
The start time in a local time format (HH:MM), to be interpreted in the participant’s current time zone.
getStatus() - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
Get status
getStatus() - Method in class org.sagebionetworks.bridge.rest.model.Account
Get status
getStatus() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummary
Get status
getStatus() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
Return records that match this status.
getStatus() - Method in class org.sagebionetworks.bridge.rest.model.EmailVerificationStatus
Get status
getStatus() - Method in class org.sagebionetworks.bridge.rest.model.FileRevision
Get status
getStatus() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get status
getStatus() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledActivity
Get status
getStatus() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
Get status
getStatus() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
Get status
getStatus() - Method in class org.sagebionetworks.bridge.rest.model.Upload
Get status
getStatus() - Method in class org.sagebionetworks.bridge.rest.model.UploadValidationStatus
Get status
getStatus() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
Get status
getStatusCode() - Method in exception org.sagebionetworks.bridge.rest.exceptions.BridgeSDKException
 
getStep() - Method in class org.sagebionetworks.bridge.rest.model.DecimalConstraints
In increase or decrease in valid values, e.g.
getStep() - Method in class org.sagebionetworks.bridge.rest.model.DurationConstraints
In increase or decrease in valid values, e.g.
getStep() - Method in class org.sagebionetworks.bridge.rest.model.IntegerConstraints
In increase or decrease in valid values, e.g.
getStrategy() - Method in class org.sagebionetworks.bridge.rest.model.SchedulePlan
Get strategy
getStreet() - Method in class org.sagebionetworks.bridge.rest.model.Address
Get street
getStringSearchPosition() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
How string-based search criteria will be compared to values in a record.
getStringSearchPosition() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
How string-based search criteria will be compared to values in a record.
getStringSearchPosition() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get stringSearchPosition
getStudies(Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Get a list of the studies in this app
getStudies(Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a list of the studies in this app
getStudies(Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForOrgAdminsApi
Get a list of the studies in this app
getStudies(Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get a list of the studies in this app
getStudies(Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Get a list of the studies in this app
getStudies(Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.StudiesApi
Get a list of the studies in this app
getStudy(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
Get a study Get a study for this app.
getStudy(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get a study Get a study for this app.
getStudy(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a study Get a study for this app.
getStudy(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForOrgAdminsApi
Get a study Get a study for this app.
getStudy(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get a study Get a study for this app.
getStudy(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Get a study Get a study for this app.
getStudy(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Get a study Get a study for this app.
getStudy(String) - Method in interface org.sagebionetworks.bridge.rest.api.StudiesApi
Get a study Get a study for this app.
getStudyActivityEventHistory(String, String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get the history of past timestamps for this event (for the caller).
getStudyActivityEventHistory(String, String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.StudiesApi
Get the history of past timestamps for this event (for the caller).
getStudyActivityEventHistory(String, String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.StudyActivityEventsApi
Get the history of past timestamps for this event (for the caller).
getStudyActivityEvents(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get the activity events for this study (for the caller).
getStudyActivityEvents(String) - Method in interface org.sagebionetworks.bridge.rest.api.StudiesApi
Get the activity events for this study (for the caller).
getStudyActivityEvents(String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyActivityEventsApi
Get the activity events for this study (for the caller).
getStudyDesignTypes() - Method in class org.sagebionetworks.bridge.rest.model.Study
The type of study (e.g.
getStudyId() - Method in class org.sagebionetworks.bridge.rest.model.ActivityEvent
the study in which this event occurred (if null, the event is global to an entire app; these are deprecated).
getStudyId() - Method in class org.sagebionetworks.bridge.rest.model.EnrollmentDetail
Get studyId
getStudyId() - Method in class org.sagebionetworks.bridge.rest.model.ExternalIdentifier
The study ID of the study in which this external ID is defined
getStudyId() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordEx3
Study that the record belongs to.
getStudyId() - Method in class org.sagebionetworks.bridge.rest.model.ParticipantRosterRequest
The studyId to filter the participant roster by.
getStudyId() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get studyId
getStudyIds() - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
The studies this participant is associated to.
getStudyIds() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummary
The studies this participant is associated to.
getStudyIds() - Method in class org.sagebionetworks.bridge.rest.model.ReportData
The studies this report record is associated to (these are set with the first record that is submitted and that creates a report index, and cannot be changed afterward unless the user is a study-wide user not associated to any specific study.
getStudyIds() - Method in class org.sagebionetworks.bridge.rest.model.ReportDataForWorker
The studies this report record is associated to (these are set with the first record that is submitted and that creates a report index, and cannot be changed afterward unless the user is an app-wide user not associated to any specific study.
getStudyIds() - Method in class org.sagebionetworks.bridge.rest.model.ReportIndex
The studies these report records are associated to.
getStudyIds() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
The studies this participant is associated to.
getStudyIds() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
The studies this participant is associated to.
getStudyIds() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
The studies this participant is associated to.
getStudyIdsAssignedOnConsent() - Method in class org.sagebionetworks.bridge.rest.model.Subpopulation
The studies this participant is associated to when they consent to membership in this subpopulation.
getStudyInfo(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.PublicApi
Get the information on a study that is useful for displaying, selecting, and signing into the study.
getStudyInfo(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.StudiesApi
Get the information on a study that is useful for displaying, selecting, and signing into the study.
getStudyLogoUrl() - Method in class org.sagebionetworks.bridge.rest.model.Study
An URL to a logo for the study.
getStudyLogoUrl() - Method in class org.sagebionetworks.bridge.rest.model.StudyInfo
An URL to a logo for the study.
getStudyParticipantById(String, String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get a study participant.
getStudyParticipantById(String, String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Get a study participant.
getStudyParticipantById(String, String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
Get a study participant.
getStudyParticipantEnrollments(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get enrollment records for this user.
getStudyParticipantEnrollments(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Get enrollment records for this user.
getStudyParticipantEnrollments(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
Get enrollment records for this user.
getStudyParticipantNotificationRegistrations(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get a study participant’s push notification registrations Get all of a study participant’s registrations for push notifications.
getStudyParticipantNotificationRegistrations(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Get a study participant’s push notification registrations Get all of a study participant’s registrations for push notifications.
getStudyParticipantNotificationRegistrations(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
Get a study participant’s push notification registrations Get all of a study participant’s registrations for push notifications.
getStudyParticipantRequestInfo(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get information about the last request made by this participant
getStudyParticipantRequestInfo(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Get information about the last request made by this participant
getStudyParticipantRequestInfo(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
Get information about the last request made by this participant
getStudyParticipants(String, AccountSummarySearch) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Search for account summaries of study participants.
getStudyParticipants(String, AccountSummarySearch) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Search for account summaries of study participants.
getStudyParticipants(String, AccountSummarySearch) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
Search for account summaries of study participants.
getStudyParticipantStudyActivityEventHistory(String, String, String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get the history of past timestamps for this event (for the caller).
getStudyParticipantStudyActivityEventHistory(String, String, String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Get the history of past timestamps for this event (for the caller).
getStudyParticipantStudyActivityEventHistory(String, String, String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.StudyActivityEventsApi
Get the history of past timestamps for this event (for the caller).
getStudyParticipantStudyActivityEventHistory(String, String, String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
Get the history of past timestamps for this event (for the caller).
getStudyParticipantStudyActivityEvents(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get activity events for the participants
getStudyParticipantStudyActivityEvents(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Get activity events for the participants
getStudyParticipantStudyActivityEvents(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyActivityEventsApi
Get activity events for the participants
getStudyParticipantStudyActivityEvents(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
Get activity events for the participants
getStudyParticipantTimeline(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get the timeline that is being assigned to the specific study participant.
getStudyParticipantTimeline(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Get the timeline that is being assigned to the specific study participant.
getStudyParticipantTimeline(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.SchedulesV2Api
Get the timeline that is being assigned to the specific study participant.
getStudyParticipantTimeline(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
Get the timeline that is being assigned to the specific study participant.
getStudyParticipantUploads(String, String, DateTime, DateTime, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get a study participant’s upload history Retrieve information about the uploads from a user.
getStudyParticipantUploads(String, String, DateTime, DateTime, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Get a study participant’s upload history Retrieve information about the uploads from a user.
getStudyParticipantUploads(String, String, DateTime, DateTime, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
Get a study participant’s upload history Retrieve information about the uploads from a user.
getStudyReportIndex(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a report index Get the index (or metadata) for a set of report records.
getStudyReportIndex(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get a report index Get the index (or metadata) for a set of report records.
getStudyReportIndex(String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyReportsApi
Get a report index Get the index (or metadata) for a set of report records.
getStudyReportIndices() - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get list of report indices for studies
getStudyReportIndices() - Method in interface org.sagebionetworks.bridge.rest.api.StudyReportsApi
Get list of report indices for studies
getStudyReportRecords(String, LocalDate, LocalDate) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get study report records Any member of an organization sponsoring a study, or any app-scoped administrative user, can access a study report record.
getStudyReportRecords(String, LocalDate, LocalDate) - Method in interface org.sagebionetworks.bridge.rest.api.StudyReportsApi
Get study report records Any member of an organization sponsoring a study, or any app-scoped administrative user, can access a study report record.
getStudyReportRecordsV4(String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get study report records Any member of an organization sponsoring a study, or any app-scoped administrative user, can access a study report.
getStudyReportRecordsV4(String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.StudyReportsApi
Get study report records Any member of an organization sponsoring a study, or any app-scoped administrative user, can access a study report.
getSubject() - Method in class org.sagebionetworks.bridge.rest.model.NotificationMessage
Very short rendition of the notification.
getSubject() - Method in class org.sagebionetworks.bridge.rest.model.TemplateRevision
Get subject
getSubpopGuid() - Method in class org.sagebionetworks.bridge.rest.model.IntentToParticipate
The specific subpopulation sent in the study to which the user consents to participate.
getSubpopulation(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a subpopulation
getSubpopulation(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
Get a subpopulation
getSubpopulation(String) - Method in interface org.sagebionetworks.bridge.rest.api.SubpopulationsApi
Get a subpopulation
getSubpopulationGuid() - Method in class org.sagebionetworks.bridge.rest.model.ConsentStatus
The GUID for the subpopulation of this consent.
getSubpopulationGuid() - Method in class org.sagebionetworks.bridge.rest.model.StudyConsent
The guid of the subpopulation to which this consent belongs.
getSubpopulationGuid() - Method in class org.sagebionetworks.bridge.rest.model.UserConsentHistory
The consent group that the participant agreed to participate in.
getSubpopulations(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get all subpopulations in this app.
getSubpopulations(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
Get all subpopulations in this app.
getSubpopulations(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.SubpopulationsApi
Get all subpopulations in this app.
getSummary() - Method in class org.sagebionetworks.bridge.rest.model.Assessment
Get summary
getSupportEmail() - Method in class org.sagebionetworks.bridge.rest.model.App
The email address that will be given to study participants and other end users to contact for support requests.
getSurvey(String, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get a survey revision
getSurvey(String, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a survey revision
getSurvey(String, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
Get a survey revision
getSurvey(String, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.SurveysApi
Get a survey revision
getSurvey() - Method in class org.sagebionetworks.bridge.rest.model.Activity
Get survey
getSurveyCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataSubmission
If the health data is a survey response, this is the createdOn timestamp that specifies the survey version.
getSurveyCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleImportStatus
Survey created-on timestamp (as an ISO8601 timestamp), if this module is a survey.
getSurveyCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleMetadata
Survey created-on timestamp (as an ISO8601 timestamp), if this module is a survey.
getSurveyCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.UploadSchema
If this schema is created from a survey, this is the createdOn timestamp (in ISO 8601 format) of the survey it represents.
getSurveyGuid() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataSubmission
If the health data is a survey response, this is the GUID that specifies the survey.
getSurveyGuid() - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleImportStatus
Survey GUID, if this module is a survey.
getSurveyGuid() - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleMetadata
Survey GUID, if this module is a survey.
getSurveyGuid() - Method in class org.sagebionetworks.bridge.rest.model.UploadSchema
If this schema is created from a survey, this is the GUID of the survey it represents.
getSurveyHistory(String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ActivitiesApi
Get a history of surveys
getSurveyHistory(String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get a history of surveys
getSurveyList() - Method in class org.sagebionetworks.bridge.rest.model.CompoundActivity
Get surveyList
getSurveyList() - Method in class org.sagebionetworks.bridge.rest.model.CompoundActivityDefinition
Get surveyList
getSurveyReferences() - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
Get surveyReferences
getSynapseDataAccessTeamId() - Method in class org.sagebionetworks.bridge.rest.model.App
Synapse team ID that is granted read access to exported health data records.
getSynapseExporterStatus() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecord
Get synapseExporterStatus
getSynapseExporterStatus() - Method in class org.sagebionetworks.bridge.rest.model.RecordExportStatusRequest
Get synapseExporterStatus
getSynapseProjectId() - Method in class org.sagebionetworks.bridge.rest.model.App
The Synapse project to export health data records to.
getSynapseUserId() - Method in class org.sagebionetworks.bridge.rest.model.AbstractStudyParticipant
The numerical identifier for a Synapse account.
getSynapseUserId() - Method in class org.sagebionetworks.bridge.rest.model.Account
The numerical identifier for a Synapse account.
getSynapseUserId() - Method in class org.sagebionetworks.bridge.rest.model.AccountRef
Get synapseUserId
getSynapseUserId() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummary
The numerical identifier for a Synapse account.
getSynapseUserId() - Method in class org.sagebionetworks.bridge.rest.model.SignUp
The numerical identifier for a Synapse account.
getSynapseUserId() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
The numerical identifier for a Synapse account.
getSynapseUserId() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
The numerical identifier for a Synapse account.
getSynapseUserIdUpdate() - Method in class org.sagebionetworks.bridge.rest.model.IdentifierUpdate
A synapse user ID (a number expressed as a string) to add to the account.
getTags() - Method in interface org.sagebionetworks.bridge.rest.api.PublicApi
Get all tags, grouped into lists under their namespace prefixes (if a tag is created without a namespace prefix, it will be listed in the \"default\" group here).
getTags() - Method in interface org.sagebionetworks.bridge.rest.api.TagsApi
Get all tags, grouped into lists under their namespace prefixes (if a tag is created without a namespace prefix, it will be listed in the \"default\" group here).
getTags() - Method in class org.sagebionetworks.bridge.rest.model.Assessment
A set of tags that apply to this assessment.
getTags() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
Get tags
getTags() - Method in class org.sagebionetworks.bridge.rest.model.SharedModuleMetadata
An unordered list of tags, used for querying and filtering.
getTask() - Method in class org.sagebionetworks.bridge.rest.model.Activity
Get task
getTaskHistory(String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ActivitiesApi
Get a history of tasks
getTaskHistory(String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get a history of tasks
getTaskId() - Method in class org.sagebionetworks.bridge.rest.model.CompoundActivityDefinition
Task ID, used to uniquely identify the compound activity and to resolve the compound activity reference from the compound activity definition, where applicable.
getTaskIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.CompoundActivity
Task ID, used to uniquely identify the compound activity and to resolve the compound activity reference from the compound activity definition, where applicable.
getTaskIdentifiers() - Method in class org.sagebionetworks.bridge.rest.model.App
An enumerated list of **unique** strings that can be used to identify tasks when creating schedules.
getTechnicalEmail() - Method in class org.sagebionetworks.bridge.rest.model.App
The email address for a technical contact who can coordinate with the Bridge Server team on technical issues (client or server).
getTemplate(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a template Get a template for this app.
getTemplate(String) - Method in interface org.sagebionetworks.bridge.rest.api.TemplatesApi
Get a template Get a template for this app.
getTemplateRevision(String, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a single template document revision
getTemplateRevision(String, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.TemplatesApi
Get a single template document revision
getTemplateRevisions(String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get the template document revisions
getTemplateRevisions(String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.TemplatesApi
Get the template document revisions
getTemplates(String, Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get a list of templates of a specific type Get all the templates of a specific type for this app.
getTemplates(String, Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.TemplatesApi
Get a list of templates of a specific type Get all the templates of a specific type for this app.
getTemplateType() - Method in class org.sagebionetworks.bridge.rest.model.Template
Get templateType
getTimelineAccessedOn() - Method in class org.sagebionetworks.bridge.rest.model.RequestInfo
The last recorded time the participant's application requested timeline information (either the timeline or the recent study activity events) from the server.
getTimelineForSelf(String, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
Get the caller’s timeline of scheduled assessments in this study.
getTimelineForStudy(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
Get the timeline associated to this study through its schedule.
getTimelineForStudy(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
Get the timeline associated to this study through its schedule.
getTimelineForStudy(String) - Method in interface org.sagebionetworks.bridge.rest.api.SchedulesV2Api
Get the timeline associated to this study through its schedule.
getTimes() - Method in class org.sagebionetworks.bridge.rest.model.Schedule
Required if an interval is specified (ignored if a cron expression is specified).
getTimestamp() - Method in class org.sagebionetworks.bridge.rest.model.ActivityEvent
ISO 8601 date and time that the event occurred