- 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
-
Deprecated.
- generatePassword(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
-
Deprecated.
- 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
-
- getAccessLevel() - Method in class org.sagebionetworks.bridge.rest.model.Permission
-
Get accessLevel
- getAccessLevel() - Method in class org.sagebionetworks.bridge.rest.model.PermissionDetail
-
Get accessLevel
- 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
- getAccount() - Method in class org.sagebionetworks.bridge.rest.model.PermissionDetail
-
Get account
- getAccountAppId() - Method in class org.sagebionetworks.bridge.rest.Config
-
- getAccountEmail() - Method in class org.sagebionetworks.bridge.rest.Config
-
- getAccountForSelf() - Method in interface org.sagebionetworks.bridge.rest.api.AccountsApi
-
Get the caller’s account (for admin accounts only).
- 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
-
Deprecated.
- getActivityEvents() - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
-
Deprecated.
- getActivityEventsForParticipant(String) - Method in interface org.sagebionetworks.bridge.rest.api.ActivityEventsApi
-
Deprecated.
- getActivityEventsForParticipant(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
-
Deprecated.
- 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
-
Deprecated.
- getActivityHistory(String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
-
Deprecated.
- getActivityType() - Method in class org.sagebionetworks.bridge.rest.model.Activity
-
Get activityType
- getAddress() - Method in class org.sagebionetworks.bridge.rest.model.Contact
-
Get address
- getAdherenceMax() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceReportSearch
-
Only return records with a weekly adherence at or below this value.
- getAdherenceMax() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
-
Get adherenceMax
- getAdherenceMin() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceReportSearch
-
Only return records with a weekly adherence at or above this value.
- getAdherenceMin() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
-
Get adherenceMin
- getAdherencePercent() - Method in class org.sagebionetworks.bridge.rest.model.EventStreamAdherenceReport
-
The percentage of all actionable sessions for the entire study that have been successfully completed by the participant, not including sessions that are available but not yet finished.
- getAdherencePercent() - Method in class org.sagebionetworks.bridge.rest.model.StudyAdherenceReport
-
The percentage of actionable sessions that have been successfully completed by the participant for the whole study, rounded down to the nearest percent.
- getAdherencePercent() - Method in class org.sagebionetworks.bridge.rest.model.StudyReportWeek
-
The percentage of actionable sessions that have been successfully completed by the participant for the whole study, rounded down to the nearest percent.
- getAdherenceRecordType() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch
-
Get adherenceRecordType
- getAdherenceStatistics(String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
-
Get summary stats of the adherence situation for all participants who are active in the study during the current week of the study.
- getAdherenceStatistics(String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
-
Get summary stats of the adherence situation for all participants who are active in the study during the current week of the study.
- getAdherenceStatistics(String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
-
Get summary stats of the adherence situation for all participants who are active in the study during the current week of the study.
- getAdherenceStatistics(String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyDesignersApi
-
Get summary stats of the adherence situation for all participants who are active in the study during the current week of the study.
- getAdherenceStatistics(String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.StudyAdherenceApi
-
Get summary stats of the adherence situation for all participants who are active in the study during the current week of the study.
- getAdherenceStatistics(String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
-
Get summary stats of the adherence situation for all participants who are active in the study during the current week of the study.
- getAdherenceThresholdPercentage() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceStatistics
-
Get adherenceThresholdPercentage
- getAdherenceThresholdPercentage() - Method in class org.sagebionetworks.bridge.rest.model.Study
-
If a participant’s adherence percentage drops under the adherence threshold percentage, Bridge will take action (for example, send a message to administrators for follow-up).
- getAdminIds() - Method in class org.sagebionetworks.bridge.rest.model.AppAndUsers
-
A list of Synapse admin user IDs.
- 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.ForDevelopersApi
-
Deprecated.
- 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
- getAllDefaultConsentRevisions() - Method in interface org.sagebionetworks.bridge.rest.api.ConsentsApi
-
Deprecated.
- getAllDefaultConsentRevisions() - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
-
Deprecated.
- getAllHealthDataDocumentationForParentId(String, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
-
Get all health data documentation by parentId.
- getAllHealthDataDocumentationForParentId(String, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
-
Get all health data documentation by parentId.
- getAllHealthDataDocumentationForParentId(String, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.HealthDataDocumentationApi
-
Get all health data documentation by parentId.
- 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.
- getAllParticipantVersionsForUser(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
-
Get all participant versions for health code.
- getAllPublishedSurveys(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
-
Get the published surveys in an app
- getAllRecordsEx3ForSelf(DateTime, DateTime, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
-
Retrieves all records from the Exporter 3 implementation for the current user and time range - For developers to validate uploads from the app.
- getAllRecordsEx3ForSelf(DateTime, DateTime, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.HealthDataApi
-
Retrieves all records from the Exporter 3 implementation for the current user and time range - For developers to validate uploads from the app.
- getAllRevisionsOfUploadSchema(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
-
Deprecated.
- getAllRevisionsOfUploadSchema(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.UploadSchemasApi
-
Deprecated.
- 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
-
Deprecated.
- getAllVersionsOfSurvey(String, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.SurveysApi
-
Deprecated.
- 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.
- getAnswerType() - Method in class org.sagebionetworks.bridge.rest.model.DemographicUserAssessmentAnswer
-
Get answerType
- 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, or the iteration value for a study burst 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.
- getAppDemographics() - Method in class org.sagebionetworks.bridge.rest.model.ParticipantVersion
-
Maps demographic category name to demographic information for a specific category of app demographics.
- 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.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.AssessmentReference
-
The identifier of the assessment's app.
- 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.ParticipantVersion
-
App that the participant lives in.
- 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.
- getAppStudies(String, Integer, Integer, Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
-
Get a paginated list of all studies in this app.
- 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.
- getAssessmentGuid() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceRecord
-
The GUID of the assessment for this adherence record (as distinct from the `instanceGuid` for the instance of the performance of the 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.ParticipantSchedule
-
Get assessments
- 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.ExporterSubscriptionRequest
-
SNS subscription 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.
- getByDayEntries() - Method in class org.sagebionetworks.bridge.rest.model.EventStream
-
A map of activities to be performed at specific days since the event occurred.
- getByDayEntries() - Method in class org.sagebionetworks.bridge.rest.model.StudyReportWeek
-
A map of activities to be performed at specific days (in this case, of one week, or 0-6 days of the week).
- getByDayEntries() - Method in class org.sagebionetworks.bridge.rest.model.WeeklyAdherenceReport
-
A map of activities to be performed at specific days since the event occurred.
- 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.
- getChildren() - Method in class org.sagebionetworks.bridge.rest.model.DemographicUserAssessmentAnswerCollection
-
A series of answers to demographics questions in an assessment format.
- 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.EventStreamAdherenceReport
-
The IANA time zone name of the participant’s time zone.
- getClientTimeZone() - Method in class org.sagebionetworks.bridge.rest.model.ParticipantSchedule
-
An IANA time zone name.
- getClientTimeZone() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledAssessment
-
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.StudyAdherenceReport
-
The IANA time zone name of the participant’s time zone.
- getClientTimeZone() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
-
Participant's time zone.
- getClientTimeZone() - Method in class org.sagebionetworks.bridge.rest.model.WeeklyAdherenceReport
-
The IANA time zone name of the 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.
- getCompliant() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceStatistics
-
Get compliant
- getCompoundActivity() - Method in class org.sagebionetworks.bridge.rest.model.Activity
-
Get compoundActivity
- getCompoundActivityDefinition(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
-
Deprecated.
- getCompoundActivityHistory(String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ActivitiesApi
-
Deprecated.
- getCompoundActivityHistory(String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
-
Deprecated.
- 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.Upload
-
The base64-encoded, 128-bit MD5 digest of the upload.
- 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.Upload
-
MIME content type.
- 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.HealthDataDocumentation
-
The userId of the author of the documentation.
- 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.HealthDataDocumentation
-
The date time of creation of the documentation.
- 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.ParticipantSchedule
-
The date and time this schedule was calculated.
- getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.ParticipantVersion
-
ISO timestamp of when any version of this participant was first created.
- getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.Permission
-
The date and time the permission was created.
- getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.PermissionDetail
-
The date and time the permission was created.
- 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.StudyAdherenceReport
-
ISO 8601 date and time that the report was generated.
- 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.
- getCreatedOn() - Method in class org.sagebionetworks.bridge.rest.model.WeeklyAdherenceReport
-
ISO 8601 date and time that the report was generated, indicating the week for which the report was generated.
- 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.
- getCreateStudyNotificationTopicArn() - Method in class org.sagebionetworks.bridge.rest.model.Exporter3Configuration
-
SNS topic to publish to when a study is initialized in this app.
- 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.
- getDataAccessTeamId() - Method in class org.sagebionetworks.bridge.rest.model.Exporter3Configuration
-
Synapse team ID that is granted read access to exported health data records.
- 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.
- 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.AccountSummary
-
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.ParticipantVersion
-
Data groups assigned to this participant.
- 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.
- getDateRange() - Method in class org.sagebionetworks.bridge.rest.model.ParticipantSchedule
-
Get dateRange
- getDateRange() - Method in class org.sagebionetworks.bridge.rest.model.StudyAdherenceReport
-
Get dateRange
- 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.
- getDayRangeOfAllStreams() - Method in class org.sagebionetworks.bridge.rest.model.EventStreamAdherenceReport
-
Get dayRangeOfAllStreams
- getDaysSinceEvent() - Method in class org.sagebionetworks.bridge.rest.model.EventStream
-
Get daysSinceEvent
- 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.
- getDelay() - Method in class org.sagebionetworks.bridge.rest.model.StudyBurst
-
ISO 8601 duration between the origin event timestamp and the first burst in the study burst sequence (days or weeks)
- getDelay() - Method in class org.sagebionetworks.bridge.rest.model.StudyBurstInfo
-
ISO 8601 duration between the origin event timestamp and the first burst in the study burst sequence (days or weeks)
- getDelayTime() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledSession
-
Get delayTime
- getDemographics() - Method in class org.sagebionetworks.bridge.rest.model.DemographicUser
-
Maps demographic category names to Demographic objects.
- getDemographics() - Method in class org.sagebionetworks.bridge.rest.model.DemographicUserResponse
-
Maps demographic category names to Demographic objects.
- getDemographicUser(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.DemographicsApi
-
Fetches all demographics for a user
Fetches all demographics for a user (study-level, done by researcher/study-coordinator)
- getDemographicUser(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
-
Fetches all demographics for a user
Fetches all demographics for a user (study-level, done by researcher/study-coordinator)
- getDemographicUser(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
-
Fetches all demographics for a user
Fetches all demographics for a user (study-level, done by researcher/study-coordinator)
- getDemographicUser(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
-
Fetches all demographics for a user
Fetches all demographics for a user (study-level, done by researcher/study-coordinator)
- getDemographicUserAppLevel(String) - Method in interface org.sagebionetworks.bridge.rest.api.DemographicsApi
-
Fetches all demographics for a user
Fetches all demographics for a user (app-level, done by app admin)
- getDemographicUserAppLevel(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
-
Fetches all demographics for a user
Fetches all demographics for a user (app-level, done by app admin)
- getDemographicUsers(String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.DemographicsApi
-
Fetches all study-level demographics for all users within a study
Fetches all study-level demographics for all users within a study (study-level, done by researcher/study-coordinator)
- getDemographicUsers(String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
-
Fetches all study-level demographics for all users within a study
Fetches all study-level demographics for all users within a study (study-level, done by researcher/study-coordinator)
- getDemographicUsers(String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
-
Fetches all study-level demographics for all users within a study
Fetches all study-level demographics for all users within a study (study-level, done by researcher/study-coordinator)
- getDemographicUsers(String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
-
Fetches all study-level demographics for all users within a study
Fetches all study-level demographics for all users within a study (study-level, done by researcher/study-coordinator)
- getDemographicUsersAppLevel(Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.DemographicsApi
-
Fetches all app-level demographics for all users within an app
Fetches all app-level demographics for all users within an app (app-level, done by app admin)
- getDemographicUsersAppLevel(Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
-
Fetches all app-level demographics for all users within an app
Fetches all app-level demographics for all users within an app (app-level, done by app admin)
- 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.
- 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
- getDocumentation() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataDocumentation
-
The documentation, which is limited to a maximum size of 100 K.
- 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
- getDownloadExpiration() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordEx3
-
Expiration for record download url.
- getDownloadURL() - Method in class org.sagebionetworks.bridge.rest.model.FileRevision
-
Get downloadURL
- getDownloadUrl() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordEx3
-
Download url for record.
- 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.EventStreamWindow
-
Get endDate
- getEndDate() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
-
Get endDate
- getEndDate() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledSession
-
Only set for the participant schedule.
- getEndDay() - Method in class org.sagebionetworks.bridge.rest.model.EventStreamWindow
-
Get endDay
- getEndDay() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledSession
-
The day since the `startEventId` for this session stream when this session should end.
- getEndpoint() - Method in class org.sagebionetworks.bridge.rest.model.ExporterSubscriptionRequest
-
Endpoint to receive notifications.
- 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
-
This field will be absent if the participant enrolled themselves, otherwise it will contain a reference to the account that enrolled the participant.
- 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
- getEnrolledOn() - Method in class org.sagebionetworks.bridge.rest.model.EnrollmentInfo
-
Get enrolledOn
- getEnrollment() - Method in class org.sagebionetworks.bridge.rest.model.AccountSummarySearch
-
Return records that match this enrollment state.
- getEnrollmentFilter() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
-
Get enrollmentFilter
- 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.
- getEnrollments() - Method in class org.sagebionetworks.bridge.rest.model.StudyParticipant
-
Records of every enrollment (whether withdrawn or not) in every study for this participant.
- getEnrollments() - Method in class org.sagebionetworks.bridge.rest.model.UserSessionInfo
-
Records of every enrollment (whether withdrawn or not) in every study for this participant.
- 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.ForDevelopersApi
-
Get enrollment records for this user
- getEnrollmentsForUser(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
-
Get enrollment records for this user
- getEntity() - Method in class org.sagebionetworks.bridge.rest.model.PermissionDetail
-
Get entity
- getEntityId() - Method in class org.sagebionetworks.bridge.rest.model.Permission
-
The ID of the entity which requires permissions to access.
- getEntityId() - Method in class org.sagebionetworks.bridge.rest.model.PermissionDetailEntity
-
The ID of the entity which requires permissions to access.
- getEntityName() - Method in class org.sagebionetworks.bridge.rest.model.PermissionDetailEntity
-
The name or title of the entity.
- getEntityType() - Method in class org.sagebionetworks.bridge.rest.model.Permission
-
Get entityType
- getEntityType() - Method in class org.sagebionetworks.bridge.rest.model.PermissionDetailEntity
-
Get entityType
- getEntries() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceStatistics
-
Get entries
- 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
-
May contain any characters except a colon.
- 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
-
A string identifying this event.
- 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.
- getEventTimestamp() - Method in class org.sagebionetworks.bridge.rest.model.EventStream
-
Get eventTimestamp
- 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.ParticipantSchedule
-
The most recent timestamps that are being used to calculate this schedule.
- getEventTimestamps() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
-
Get eventTimestamps
- getEventTimestamps() - Method in class org.sagebionetworks.bridge.rest.model.StudyAdherenceReport
-
A mapping of event IDs to the most recent timestamp value for that event.
- 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.
- getExportedOn() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordEx3
-
ISO timestamp of when this record was exported to Synapse.
- getExporter3Configuration() - Method in class org.sagebionetworks.bridge.rest.model.App
-
Configuration required for Exporter 3.0.
- getExporter3Configuration() - Method in class org.sagebionetworks.bridge.rest.model.Study
-
Configuration required for Exporter 3.0.
- getExternalId() - Method in class org.sagebionetworks.bridge.rest.model.AccountRef
-
Get externalId
- 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.EnrollmentInfo
-
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.ForDevelopersApi
-
Get a file resource
Get a file resource for this app.
- getFile(String) - Method in interface org.sagebionetworks.bridge.rest.api.HostedFilesApi
-
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
- getFilename() - Method in class org.sagebionetworks.bridge.rest.model.Upload
-
Name of the uploaded file.
- getFileReferences() - Method in class org.sagebionetworks.bridge.rest.model.AppConfig
-
Get fileReferences
- getFileRevision(String, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
-
Get a single file revision of a file.
- getFileRevision(String, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.HostedFilesApi
-
Get a single file revision of a file.
- 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.
- getFileRevisions(String, Integer, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.HostedFilesApi
-
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.ForDevelopersApi
-
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.HostedFilesApi
-
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.
- getFinishedOn() - Method in class org.sagebionetworks.bridge.rest.model.ScheduledAssessment
-
The client-supplied time when the activity was recorded as finished (this time comes from the client and is not validated by the server).
- 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.Permission
-
A unique ID automatically generated on creation of a Permission.
- getGuid() - Method in class org.sagebionetworks.bridge.rest.model.PermissionDetail
-
A unique ID automatically generated on creation of a Permission.
- 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.ParticipantVersion
-
Participant's health code.
- 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.
- getHealthDataDocumentationForId(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
-
Get a health data documentation with the given identifier
This endpoint can be called by researchers and developers to get a specific documentation by identifier.
- getHealthDataDocumentationForId(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
-
Get a health data documentation with the given identifier
This endpoint can be called by researchers and developers to get a specific documentation by identifier.
- getHealthDataDocumentationForId(String) - Method in interface org.sagebionetworks.bridge.rest.api.HealthDataDocumentationApi
-
Get a health data documentation with the given identifier
This endpoint can be called by researchers and developers to get a specific documentation by identifier.
- 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.DemographicResponse
-
Unique id for this demographic
- 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.DemographicUserAssessmentAnswer
-
The identifier for this demographic assessment question (category name).
- getIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.ExternalIdentifier
-
The external identifier.
- getIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataDocumentation
-
The unique identifier of the documentation.
- 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.StudyBurst
-
Identifier for the study burst.
- getIdentifier() - Method in class org.sagebionetworks.bridge.rest.model.StudyBurstInfo
-
Identifier for the study burst
- 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.AdherenceReportSearch
-
Only return records where one of the participant’s identifier fields (externalId, identifier, firstName, lastName, email, or phone number) includes the `idFilter` string.
- 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.
- getImageResource() - Method in class org.sagebionetworks.bridge.rest.model.Assessment
-
Get imageResource
- getImageResource() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentInfo
-
Get imageResource
- getImageResource() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentReference2
-
Get imageResource
- 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.
- getInterval() - Method in class org.sagebionetworks.bridge.rest.model.StudyBurst
-
ISO 8601 duration between the burst event timestamps in days or weeks
- getInterval() - Method in class org.sagebionetworks.bridge.rest.model.StudyBurstInfo
-
ISO 8601 duration between the burst event timestamps in days or weeks
- 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.DemographicUserResponseList
-
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.HealthDataDocumentationList
-
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.ParticipantVersionList
-
Get items
- getItems() - Method in class org.sagebionetworks.bridge.rest.model.PermissionDetailResourceList
-
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
- getItems() - Method in class org.sagebionetworks.bridge.rest.model.WeeklyAdherenceReportList
-
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.AdherenceStatisticsEntry
-
Get label
- 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).
- getLabel() - Method in class org.sagebionetworks.bridge.rest.model.WeeklyAdherenceReportRow
-
Get label
- 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).
- getLabelFilters() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceReportSearch
-
Return records where the labels of the entries includes one or more of the labels in this array.
- getLabelFilters() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
-
Get labelFilters
- 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.ImageResource
-
A collection of labels for this ImageResource.
- 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.ParticipantVersion
-
Languages captured from a request by this user's Accept-Language header.
- 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
- getMax() - Method in class org.sagebionetworks.bridge.rest.model.DayRange
-
The highest `startDay` entry across all stream (the highest `days since event X` value without regard to the specific event).
- 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.TimelineMetadata
-
A map of field values from the timeline (schedule v2) that prompted the user to perform an assessment and upload this data.
- 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
-
Deprecated.
- getMetadataByIdAndVersion(String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.PublicApi
-
Deprecated.
- getMetadataByIdLatestVersion(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
-
Deprecated.
- getMetadataByIdLatestVersion(String) - Method in interface org.sagebionetworks.bridge.rest.api.PublicApi
-
Deprecated.
- 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.
- getMin() - Method in class org.sagebionetworks.bridge.rest.model.DayRange
-
The lowest `startDay` entry across all streams (the lowest `days since event X` value without regard to the specific event).
- 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.
- getModifiedBy() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataDocumentation
-
The userId of the user who modified the documentation.
- 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.HealthDataDocumentation
-
The date time of the modification of the documentation.
- 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.ParticipantVersion
-
ISO timestamp of when this participant was last updated (ie, when this participant version was created).
- getModifiedOn() - Method in class org.sagebionetworks.bridge.rest.model.Permission
-
The date and time the permission was last modified.
- getModifiedOn() - Method in class org.sagebionetworks.bridge.rest.model.PermissionDetail
-
The date and time the permission 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.
- getModule() - Method in class org.sagebionetworks.bridge.rest.model.ImageResource
-
The module of the image to display.
- 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
-
Deprecated.
- getMostRecentSurveys(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
-
Deprecated.
- getMostRecentSurveys(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.SurveysApi
-
Deprecated.
- getMostRecentSurveyVersion(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
-
Deprecated.
- getMostRecentSurveyVersion(String) - Method in interface org.sagebionetworks.bridge.rest.api.SurveysApi
-
Deprecated.
- getMostRecentUploadSchema(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
-
Deprecated.
- getMostRecentUploadSchema(String) - Method in interface org.sagebionetworks.bridge.rest.api.UploadSchemasApi
-
Deprecated.
- getMostRecentUploadSchemas(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
-
Deprecated.
- getMostRecentUploadSchemas(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
-
Deprecated.
- getMostRecentUploadSchemas(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.UploadSchemasApi
-
Deprecated.
- 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.ImageResource
-
The name of the image to display.
- 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.
- getNextActivity() - Method in class org.sagebionetworks.bridge.rest.model.WeeklyAdherenceReport
-
Get nextActivity
- 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.
- getNoncompliant() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceStatistics
-
Get noncompliant
- 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.Enrollment
-
An optional, study-scoped participant note.
- getNote() - Method in class org.sagebionetworks.bridge.rest.model.EnrollmentDetail
-
An optional, study-scoped participant note.
- 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`.
- getOccurrences() - Method in class org.sagebionetworks.bridge.rest.model.StudyBurst
-
The number of timestamps that should be generated with the `originEventId` occurs.
- getOccurrences() - Method in class org.sagebionetworks.bridge.rest.model.StudyBurstInfo
-
The number of timestamps that should be generated with the `originEventId` occurs.
- 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.AdherenceReportSearch
-
Get offsetBy
- 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).
- getOriginEventId() - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEvent
-
If this event is generated from a study burst, the originating event ID that triggers the study burst to occur.
- getOriginEventId() - Method in class org.sagebionetworks.bridge.rest.model.StudyBurst
-
The event ID that will trigger the generation of a set of study burst events
- getOriginEventId() - Method in class org.sagebionetworks.bridge.rest.model.StudyBurstInfo
-
The event ID that triggered the generation of these study burst events
- 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.
- getOriginSharedId() - Method in class org.sagebionetworks.bridge.rest.model.AssessmentReference
-
If imported from a shared assessment, the identifier of the shared assessment (this may not be unique between two different references in the set of references)
- 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.AdherenceReportSearch
-
Get pageSize
- getPageSize() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
-
Get pageSize
- getParentId() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataDocumentation
-
The parentId of the documentation.
- getParticipant() - Method in class org.sagebionetworks.bridge.rest.model.EnrollmentDetail
-
Get participant
- getParticipant() - Method in class org.sagebionetworks.bridge.rest.model.StudyAdherenceReport
-
Get participant
- getParticipant() - Method in class org.sagebionetworks.bridge.rest.model.WeeklyAdherenceReport
-
Get participant
- getParticipantActivityHistory(String, String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
-
Deprecated.
- getParticipantActivityHistory(String, String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
-
Deprecated.
- 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
- getParticipantCompoundActivityHistory(String, String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
-
Deprecated.
- getParticipantCompoundActivityHistory(String, String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
-
Deprecated.
- 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.
- 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.
- 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.
- getParticipants(Integer, Integer, String, String, DateTime, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
-
Get a paged list of study participants (users)
- getParticipants(Integer, Integer, String, String, DateTime, DateTime) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
-
Get a paged list of study participants (users)
- getParticipantSchedule(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForResearchersApi
-
Get the caller’s scheduled activities in this study.
- getParticipantSchedule(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForStudyCoordinatorsApi
-
Get the caller’s scheduled activities in this study.
- getParticipantSchedule(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.SchedulesV2Api
-
Get the caller’s scheduled activities in this study.
- getParticipantSchedule(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.StudyParticipantsApi
-
Get the caller’s scheduled activities in this study.
- getParticipantScheduleForSelf(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
-
Get the caller’s scheduled activities in this study.
- 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
-
Deprecated.
- getParticipantSurveyHistory(String, String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
-
Deprecated.
- 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
-
Deprecated.
- getParticipantTaskHistory(String, String, DateTime, DateTime, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ParticipantsApi
-
Deprecated.
- 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.
- getParticipantVersion(String, String, Integer) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
-
Get all participant versions for health code.
- getParticipantVersion() - Method in class org.sagebionetworks.bridge.rest.model.HealthDataRecordEx3
-
Participant version of the participant at the time the upload was submitted.
- getParticipantVersion() - Method in class org.sagebionetworks.bridge.rest.model.ParticipantVersion
-
Participant version.
- getParticipantVersionDemographicsTableId() - Method in class org.sagebionetworks.bridge.rest.model.Exporter3Configuration
-
The Synapse table to where we exporter Participant Version Demographics.
- getParticipantVersionDemographicsViewId() - Method in class org.sagebionetworks.bridge.rest.model.Exporter3Configuration
-
The Synapse materialized view which joins the Participant Versions table and the Demographics table.
- getParticipantVersionTableId() - Method in class org.sagebionetworks.bridge.rest.model.Exporter3Configuration
-
The Synapse table to where we export Participant Versions.
- 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
- getPeriodFromOrigin() - Method in class org.sagebionetworks.bridge.rest.model.StudyActivityEvent
-
If the event is generated from a study burst, An ISO 8601 duration, describing the period after the originating event’s timestamp when this event has been scheduled to occur.
- getPermissionsForEntity(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
-
Get a set of permission records for an entity.
- getPermissionsForEntity(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.PermissionsApi
-
Get a set of permission records for an entity.
- getPermissionsForUser(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForAdminsApi
-
Get a set of permission records granted to a user.
- getPermissionsForUser(String) - Method in interface org.sagebionetworks.bridge.rest.api.PermissionsApi
-
Get a set of permission records granted to a user.
- 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
- getProgression() - Method in class org.sagebionetworks.bridge.rest.model.EventStreamAdherenceReport
-
Get progression
- getProgression() - Method in class org.sagebionetworks.bridge.rest.model.StudyAdherenceReport
-
Get progression
- getProgression() - Method in class org.sagebionetworks.bridge.rest.model.WeeklyAdherenceReport
-
Get progression
- getProgressionFilters() - Method in class org.sagebionetworks.bridge.rest.model.AdherenceReportSearch
-
Filter records by whether the participant has finished, not yet begun, and/or is currently participating in the study.
- getProgressionFilters() - Method in class org.sagebionetworks.bridge.rest.model.RequestParams
-
Get progressionFilters
- getProjectId() - Method in class org.sagebionetworks.bridge.rest.model.Exporter3Configuration
-
The Synapse project to export health data records to.
- 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.
- 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.ExporterSubscriptionRequest
-
Protocol to receive notifications.
- 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
-
Deprecated.
- getPublishedSurveys(Boolean) - Method in interface org.sagebionetworks.bridge.rest.api.SurveysApi
-
Deprecated.
- getPublishedSurveyVersion(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
-
Deprecated.
- getPublishedSurveyVersion(String) - Method in interface org.sagebionetworks.bridge.rest.api.ForDevelopersApi
-
Deprecated.
- getPublishedSurveyVersion(String) - Method in interface org.sagebionetworks.bridge.rest.api.SurveysApi
-
Deprecated.
- 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.
- getRawDataFolderId() - Method in class org.sagebionetworks.bridge.rest.model.Exporter3Configuration
-
The Synapse folder to export raw health data to.
- 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 event.
- getRecordEx3(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
-
Retrieves the record for the given ID from the Exporter 3 implemention.
- getRecordEx3ById(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForConsentedUsersApi
-
Retrieves the record for the given ID from the Exporter 3 implemention, provides a dowload link for the record if requested - For developers to validate uploads from the app.
- getRecordEx3ById(String, String) - Method in interface org.sagebionetworks.bridge.rest.api.HealthDataApi
-
Retrieves the record for the given ID from the Exporter 3 implemention, provides a dowload link for the record if requested - For developers to validate uploads from the app.
- 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
- getRecordsEx3ForApp(String, DateTime, DateTime, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
-
Retrieves all records from the Exporter 3 implemention in the specified app for the given time range.
- getRecordsEx3ForStudy(String, String, DateTime, DateTime, Integer, String) - Method in interface org.sagebionetworks.bridge.rest.api.ForWorkersApi
-