Class and Description |
---|
ClientInfo
Describes the content of the `User-Agent` field in the format that is accepted and understandable to the Bridge server (see [REST API getting started](/articles/rest.html)).
|
Environment
This value should always be set to production.
|
Phone
The user's phone number.
|
SignIn
Information to sign in to the Bridge server.
|
UploadRequest
**Important: Headers of the same values must be used when doing the upload against the pre-signed URL.**
|
UploadSession
UploadSession
|
UserSessionInfo
UserSessionInfo
|
Class and Description |
---|
Account
Account record for administrative accounts.
|
AccountSummaryList
Payload returning a list of [AccountSummary](/#AccountSummary) records.
|
AccountSummarySearch
Search criteria to retrieve account summaries of study participants.
|
ActivityEventList
ActivityEventList
|
AdherenceRecordList
AdherenceRecordList
|
AdherenceRecordsSearch
AdherenceRecordsSearch
|
AdherenceRecordUpdates
AdherenceRecordUpdates
|
AdherenceReportSearch
AdherenceReportSearch
|
AdherenceStatistics
A report on the current adherence of all active participants in a study during the current week of the study.
|
AlertCategoriesAndCounts
A list of categories of alerts and the number of alerts in those categories for a particular study.
|
AlertFilter
A filter for fetching alerts.
|
AlertIdCollection
A list of alert IDs.
|
AlertList
AlertList
|
App
An app with its many configuration options.
|
AppAndUsers
The holder object for App, a list of User and a list of admin IDs
|
AppConfig
An app configuration object.
|
AppConfigElement
An element of an app configuration object.
|
AppConfigElementList
AppConfigElementList
|
AppConfigList
AppConfigList
|
AppList
AppList
|
Assessment
The assessment object contains the general cataloguing information we have on an assessment, and includes both a set of links to documents that describe the assessment and its use, as well as a configuration object for client applications.
|
AssessmentConfig
AssessmentConfig
|
AssessmentList
AssessmentList
|
CmsPublicKey
A JSON payload that includes the base 64 encoded, public key for CMS encryption of uploads for this app.
|
CompoundActivityDefinition
A compound activity definition, which lives outside of but parallel to a schedule plan.
|
CompoundActivityDefinitionList
CompoundActivityDefinitionList
|
ConsentSignature
To consent to participation in a subpopulation (also known as a consent group), participants submit their electronic signature.
|
CreatedOnHolder
An object that provides the creation timestamp for a newly created entity.
|
CustomActivityEventRequest
Request object for creating a Custom Activity Event.
|
DateRange
Model object representing a date range, which includes start date and end date as calendar dates (YYYY-MM-DD).
|
DateTimeHolder
An object that provides a timestamp.
|
DemographicUser
A collection of demographics associated with a user.
|
DemographicUserAssessment
A collection of demographics associated with a user (assessment format).
|
DemographicUserResponse
A collection of demographics associated with a user.
|
DemographicUserResponseList
DemographicUserResponseList
|
DemographicValuesValidationConfig
Configuration which configures the validation of app-level and study-level demographic values.
|
DetailedAdherenceReport
Adherence report including details from the related schedule, sessions, and assessments for a participant.
|
EmailSignIn
Using a token supplied in an email to the participant, authenticate with the server.
|
EmailSignInRequest
Make a request to sign in through an email.
|
EmailVerificationStatus
The status of the email address that will be used to send consents to users.
|
Enrollment
An enrollment of a user in a study
|
EnrollmentDetailList
EnrollmentDetailList
|
EventStreamAdherenceReport
A report on one participant’s adherence to a study’s entire schedule protocol.
|
Exporter3Configuration
This class holds Exporter 3.0 configuration for a given app.
|
ExporterSubscriptionRequest
Represents a subscription request to be notified when a study is initialized for Exporter 3.0 in an app.
|
ExporterSubscriptionResult
The result of a subscription request to be notified when a study is initialized for Exporter 3.0 in an app.
|
ExportToAppNotification
Notification for when a health data is exported to an app-wide Synapse project for Exporter 3.0.
|
ExternalIdentifierList
ExternalIdentifierList
|
ExternalResource
An external identifier assigned to a participant's account to allow external re-identification of the user by the study sponsor.
|
ExternalResourceList
ExternalResourceList
|
FileMetadata
A descriptor of a static file resource (image, XML file, video file, etc.) that is hosted via the Bridge server
|
FileMetadataList
FileMetadataList
|
FileRevision
An object that tracks the existence of an individual revision of a file resource in S3.
|
FileRevisionList
FileRevisionList
|
ForwardCursorReportDataList
ForwardCursorReportDataList
|
ForwardCursorScheduledActivityList
ForwardCursorScheduledActivityList
|
ForwardCursorStringList
ForwardCursorStringList
|
GeneratedPassword
GeneratedPassword
|
GuidCreatedOnVersionHolder
An object that describes the keys and optimistic lock values of a Survey.
|
GuidHolder
An object that provides the GUID for a newly created entity.
|
GuidVersionHolder
An object that describes the keys and optimistic lock values of an entity (e.g.
|
HealthDataDocumentation
The documentation to be associated with participant health data.
|
HealthDataDocumentationList
List of health data documentation.
|
HealthDataRecord
See [Bridge Upload Data Format](/articles/study_design/upload_data_format.html) for details about this model object.
|
HealthDataRecordEx3
Represents the Health Data Record model for Exporter 3.
|
HealthDataRecordEx3List
List of health data records within a date-time range.
|
HealthDataRecordList
List of health data records within a date-time range.
|
HealthDataSubmission
Used to submit health data to the synchronous health data API.
|
Identifier
Payload object for an email address or phone number.
|
IdentifierHolder
An object that holds an identifier for a created entity.
|
IdentifierUpdate
An update to the key identifier fields of an account (email, phone number, external ID or Synapse user ID).
|
IntentToParticipate
For studies that wish to orchestrate an agreement to participate prior to signing up for a study, this API provides a way to store a consent under a phone number or email address.
|
MasterSchedulerConfig
Configurations to setup a report scheduler.
|
MasterSchedulerConfigList
MasterSchedulerConfigList
|
Message
Message
|
NotificationMessage
NotificationMessage
|
NotificationRegistration
NotificationRegistration
|
NotificationRegistrationList
NotificationRegistrationList
|
NotificationTopic
NotificationTopic
|
NotificationTopicList
NotificationTopicList
|
OAuthAccessToken
OAuthAccessToken
|
OAuthAuthorizationToken
OAuthAuthorizationToken
|
Organization
Organization
|
OrganizationList
OrganizationList
|
PagedExternalResourceList
PagedExternalResourceList
|
ParticipantData
The JSON data for a non-time series participant data attribute.
|
ParticipantFile
A descriptor of a participant blob file
|
ParticipantFileList
ParticipantFileList
|
ParticipantRosterRequest
The JSON data for a participant roster download request.
|
ParticipantSchedule
The ParticipantSchedule is similar to the Timeline in structure, but includes the specific dates when this participant should perform each session, based on this participant’s events.
|
ParticipantVersion
Represents a de-identified snapshot of a study participant at a moment in time.
|
ParticipantVersionList
ParticipantVersionList
|
PasswordReset
Payload to send a new password to the Bridge server.
|
Permission
An object describing an individual user's level of access to an entity or group of items.
|
PermissionDetail
A detailed view of a permission record.
|
PermissionDetailResourceList
PermissionDetailResourceList
|
PhoneSignIn
Using a token supplied in an SMS message authenticate with the server.
|
PhoneSignInRequest
Make a request to sign in using an SMS message.
|
RecordExportStatusRequest
A payload sending back the status of an export of one or more health data records to Synapse.
|
ReportData
The JSON data for one time point of a report (either a local date in the format YYYY-MM-DD, or an ISO 8601 timestamp; report records should all use one or the other format consistently).
|
ReportDataForWorker
The JSON data to submit a report record for a point in time (curently a day expressed in the format YYYY-MM-DD).
|
ReportDataList
ReportDataList
|
ReportIndex
An identifier to retrieve a series of report data (e.g.
|
ReportIndexList
ReportIndexList
|
RequestInfo
Some basic information is captured when a participant makes a request to the Bridge server, mostly for the purpose of troubleshooting user issues with the app.
|
Schedule2
A design-time representation of a schedule for participants to perform (for the v2 of our scheduling API).
|
ScheduledActivity
Description of an activity (such as a task or survey) the study would like the participant to perform.
|
ScheduledActivityList
ScheduledActivityList
|
ScheduledActivityListV4
The endpoint takes a startTime (inclusive) and endTime (exclusive) to form a time range (up to 15 days).
|
ScheduleList
ScheduleList
|
SchedulePlan
A schedule plan relates schedules to some specific strategies for using these schedules to create activities for participants.
|
SchedulePlanList
SchedulePlanList
|
SharedModuleImportStatus
This struct contains the results of importing a shared module into the local app, including what type of module it is, and its key params (schema ID/revision or survey GUID/createdOn) in the local app.
|
SharedModuleMetadata
Metadata for shared modules in the shared module library.
|
SharedModuleMetadataList
SharedModuleMetadataList
|
SharingScopeForm
SharingScopeForm
|
SignIn
Information to sign in to the Bridge server.
|
SignUp
The information necessary to sign up for a Bridge app.
|
SmsMessage
Represents an SMS message that we sent to a phone number.
|
SmsTemplate
A template for one of the system SMS messages sent by Bridge.
|
StringList
StringList
|
Study
A study (an outside organization providing participants for a study).
|
StudyActivityEventList
StudyActivityEventList
|
StudyActivityEventPagedList
StudyActivityEventPagedList
|
StudyActivityEventRequest
Request object for creating a Custom Activity Event.
|
StudyAdherenceReport
A report on one participant’s adherence to a study’s entire schedule protocol.
|
StudyConsent
For historical reasons, a revision of a consent document is known as a \"study consent\" (it would more accurate to call it a \"subpopulation consent\").
|
StudyConsentList
StudyConsentList
|
StudyInfo
An abridged study object with information that is useful for displaying, selecting, and signing into the study.
|
StudyList
StudyList
|
StudyParticipant
StudyParticipant
|
Subpopulation
A subpopulation in the Bridge server is a group of people who, for the purposes of the study, must agree to a specific consent in order to participate in a study.
|
SubpopulationList
SubpopulationList
|
SubscriptionRequest |
SubscriptionStatusList
SubscriptionStatusList
|
Survey
The definition of a survey.
|
SurveyList
SurveyList
|
Tag
A tag.
|
Template
A template for messaging (SMS, email, etc.);
|
TemplateList
TemplateList
|
TemplateRevision
A revision of a template
|
TemplateRevisionList
TemplateRevisionList
|
Timeline
A detailed description of when a participant should perform specific sessions and assessments as part of a study, along with the metadata to show UI to the participant before loading and executing code for the assessments.
|
TimelineMetadata
TimelineMetadata
|
Upload
Upload
|
UploadList
UploadList
|
UploadRequest
**Important: Headers of the same values must be used when doing the upload against the pre-signed URL.**
|
UploadSchema
Represents the expected fields and types for a data upload.
|
UploadSchemaList
UploadSchemaList
|
UploadSession
UploadSession
|
UploadValidationStatus
UploadValidationStatus
|
UploadViewEx3
This helpful data structure includes the upload, health data record, adherence records, and timeline metadata for a given upload/record ID, if they exist.
|
UserSessionInfo
UserSessionInfo
|
Verification
A payload to sent the email or phone verification token back to the bridge server.
|
VersionHolder
An object that holds the version for a created or updated entity.
|
WeeklyAdherenceReport
A report on one participant’s adherence to a study’s schedule protocol for a specific week.
|
WeeklyAdherenceReportList
WeeklyAdherenceReportList
|
Withdrawal
Withdrawal
|
Class and Description |
---|
UserSessionInfo
UserSessionInfo
|
Class and Description |
---|
AbstractStudyParticipant
Common fields for the SignUp and StudyParticipant payloads.
|
ABTestGroup
A list of these groups define the way schedules are allocated in an ABTestScheduleStrategy (each schedule associated to a percentage).
|
ABTestScheduleStrategy
A strategy that divides users into groups according to a percentage scheme, assigning each group a different [Schedule](/#Schedule).
|
AccessLevel
The level of a user's administrative access to a specific entity (eg.
|
Account
Account record for administrative accounts.
|
AccountRef
Identifying fields for an account.
|
AccountStatus
Status of a participant's account, for accounts that must verify an email address.
|
AccountSummary
Summary of a participant, used in APIs to search and retrieve participant accounts.
|
AccountSummarySearch
Search criteria to retrieve account summaries of study participants.
|
Activity
When creating an activity as part of a Schedule, you will need to supply a SurveyReference or a TaskReference in the activity.
|
ActivityEvent
Activity event for a participant, used for scheduling activities.
|
ActivityEventUpdateType
The type of update that is allowed on an activity event.
|
ActivityType
An activity represents either a survey or a task to be performed (not both).
|
Address
Address
|
AdherenceRecord
A record describing the performance state of a scheduled session or assessment, as defined in a `Timeline`.
|
AdherenceRecordsSearch
AdherenceRecordsSearch
|
AdherenceRecordType
The AdherenceRecordType can be used to limit search results for adherence records to either assessment or session records.
|
AdherenceRecordUpdates
AdherenceRecordUpdates
|
AdherenceReportSearch
AdherenceReportSearch
|
AdherenceStatisticsEntry
AdherenceStatisticsEntry
|
Alert
An alert to be displayed.
|
Alert.CategoryEnum
The category of this alert.
|
AlertCategoriesAndCounts
A list of categories of alerts and the number of alerts in those categories for a particular study.
|
AlertCategoryAndCount
A single category of alerts and the number of alerts in that category for a particular study.
|
AlertCategoryAndCount.CategoryEnum
A category of alerts.
|
AlertFilter
A filter for fetching alerts.
|
AlertFilter.AlertCategoriesEnum
An category of alerts to be included in the fetch.
|
AlertIdCollection
A list of alert IDs.
|
AndroidAppLink
AndroidAppLink
|
App
An app with its many configuration options.
|
AppAndUsers
The holder object for App, a list of User and a list of admin IDs
|
AppConfig
An app configuration object.
|
AppConfigElement
An element of an app configuration object.
|
AppleAppLink
AppleAppLink
|
Assessment
The assessment object contains the general cataloguing information we have on an assessment, and includes both a set of links to documents that describe the assessment and its use, as well as a configuration object for client applications.
|
AssessmentCompletionState
The completion state of an assessment.
|
AssessmentConfig
AssessmentConfig
|
AssessmentInfo
Information about an assessment in order to render it in a UI prior to execution.
|
AssessmentReference
A pointer to an assessment revision.
|
AssessmentReference2
A pointer to an assessment revision.
|
BloodPressureConstraints
Systolic and diastolic systemic arterial pressure.
|
ClientInfo
Describes the content of the `User-Agent` field in the format that is accepted and understandable to the Bridge server (see [REST API getting started](/articles/rest.html)).
|
ColorScheme
Colors to differentiate this assessment in a UI.
|
CompoundActivity
A pointer to a compound activity, which represents multiple schemas or survey's worth of tasks for a user to perform.
|
CompoundActivityDefinition
A compound activity definition, which lives outside of but parallel to a schedule plan.
|
ConfigReference
A pointer to a configuration element.
|
ConsentSignature
To consent to participation in a subpopulation (also known as a consent group), participants submit their electronic signature.
|
ConsentStatus
A description of the participant's consent status in a particular subpopulation (consent group).
|
Constraints
Constraints
|
Contact
A contact for the study.
|
ContactRole
The purpose of this contact.
|
CountryCode
The country code of origin of a postal code (ISO 3166-1 alpha-2 format).
|
Criteria
Some objects, like Subpopulations and the schedules in a CriteriaScheduleStrategy, are matched against user criteria in order to return the correct object.
|
CriteriaScheduleStrategy
Contains a list of schedules, each of which is associated to a specific [Criteria](/#Criteria) object.
|
CustomActivityEventRequest
Request object for creating a Custom Activity Event.
|
CustomEvent
A study can define one or more unique event identifiers against which a schedule can be designed.
|
DataGroups
A payload that contains a string array of data groups.
|
DataType
The data type of the answer to a question.
|
DateConstraints
A date without a time value (e.g.
|
DateRange
Model object representing a date range, which includes start date and end date as calendar dates (YYYY-MM-DD).
|
DateTimeConstraints
**UI hints:** datetimepicker.
|
DayRange
An object that provides a timestamp.
|
DecimalConstraints
A floating point value.
|
Demographic
A single demographic with a specific category for a specific user.
|
DemographicResponse
A single demographic with a specific category for a specific user.
|
DemographicUser
A collection of demographics associated with a user.
|
DemographicUserAssessment
A collection of demographics associated with a user (assessment format).
|
DemographicUserAssessmentAnswer
A single answer in a demographics assessment.
|
DemographicUserAssessmentAnswerAnswerType
The container for \"type\".
|
DemographicUserAssessmentAnswerCollection
A collection holding series of answers to demographics questions in an assessment format.
|
DemographicUserResponse
A collection of demographics associated with a user.
|
DemographicValueResponse
A single value for a demographic within a category.
|
DemographicValuesNumberRangeValidationRules
Validation for rules for validating numbers in demographics to ensure they fall within a specified range.
|
DemographicValuesValidationConfig
Configuration which configures the validation of app-level and study-level demographic values.
|
DemographicValuesValidationConfig.ValidationTypeEnum
The type of validation to perform.
|
DetailedAdherenceReportAssessmentRecord
Adherence record information related to one instance of an assessment from a participant's timeline.
|
DetailedAdherenceReportSessionRecord
Adherence record information related to one instance of a session or burst from a participant's timeline.
|
DurationConstraints
Deprecated.
|
EmailSignIn
Using a token supplied in an email to the participant, authenticate with the server.
|
EmailSignInRequest
Make a request to sign in through an email.
|
Enrollment
An enrollment of a user in a study
|
EnrollmentDetail
Details about the enrollment of a user in a study
|
EnrollmentFilter
Filter information about the enrollees in a study (these are people who consented to participate in the research, whether through Bridge or external to the system).
|
EnrollmentInfo
Details about an enrollment for the participant enrolled in the study.
|
EntityType
Types of entities with managed permissions.
|
Environment
This value should always be set to production.
|
EventStream
One stream of activities that should be performed during a study that are triggered by the presence of a single event in the participant’s map of events.
|
EventStreamDay
One day of activities to perform on day N from a specific event (combining all sessions that are triggered by the same event).
|
EventStreamWindow
A single session that starts on the day of the `EventStreamDay` it is included in, and ends on the day or date given by this entry.
|
ExportedRecordInfo
Information about records exported to Synapse, for use in sending notifications.
|
Exporter3Configuration
This class holds Exporter 3.0 configuration for a given app.
|
ExporterSubscriptionRequest
Represents a subscription request to be notified when a study is initialized for Exporter 3.0 in an app.
|
ExporterSubscriptionResult
The result of a subscription request to be notified when a study is initialized for Exporter 3.0 in an app.
|
ExportToAppNotification
Notification for when a health data is exported to an app-wide Synapse project for Exporter 3.0.
|
ExternalIdentifier
An external identifier assigned to a participant's account to allow external re-identification of the user by the study sponsor.
|
ExternalResource
An external identifier assigned to a participant's account to allow external re-identification of the user by the study sponsor.
|
FileDisposition
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.
|
FileMetadata
A descriptor of a static file resource (image, XML file, video file, etc.) that is hosted via the Bridge server
|
FileReference
A pointer to a file revision hosted for this app.
|
FileRevision
An object that tracks the existence of an individual revision of a file resource in S3.
|
FileRevisionStatus
|State|Description| |---|---| |pending|The client has requested and created a `FileRevision` object, and must now PUT the actual file resource to S3, using the `uploadURL` in the `FileRevision` object.| |available|The client has called the `finishFileRevision` endpoint and the server confirmed that the file is available.|
|
ForwardCursorPagedResourceList
One page of records from a source that only allows you to fetch the next page of resources (no random access via an index to anywhere in the set of records).
|
HealthDataDocumentation
The documentation to be associated with participant health data.
|
HealthDataRecord
See [Bridge Upload Data Format](/articles/study_design/upload_data_format.html) for details about this model object.
|
HealthDataRecordEx3
Represents the Health Data Record model for Exporter 3.
|
HealthDataSubmission
Used to submit health data to the synchronous health data API.
|
HeightConstraints
A floating point value.
|
Identifier
Payload object for an email address or phone number.
|
IdentifierUpdate
An update to the key identifier fields of an account (email, phone number, external ID or Synapse user ID).
|
Image
Image
|
ImageResource
An indicator for an image that should be displayed.
|
IntegerConstraints
This type can be used to collect a number, or with a unit, it can be used to collect a measure or a duration (e.g.
|
IntentToParticipate
For studies that wish to orchestrate an agreement to participate prior to signing up for a study, this API provides a way to store a consent under a phone number or email address.
|
IrbDecisionType
The outcome of IRB approval that allows this study to be executed on the Bridge platform.
|
Label
A localizable string value to show study participants.
|
MasterSchedulerConfig
Configurations to setup a report scheduler.
|
MimeType
Available MIME types: |Type|Description| |---|---| |text/plain|Plain text| |text/html|HTML| |application/pdf|PDF document|
|
MultiValueConstraints
A common question type where the participant is given a list of options to choose from.
|
NextActivity
For participants who do not have any activities for their current week, this object will be included in reports to provide information on when the participant will next be engaged by the study.
|
Notification
A notification to show to a participant as part of the execution of a scheduled session.
|
NotificationInfo
A notification to show to a participant as part of the execution of a scheduled session.
|
NotificationMessage
NotificationMessage
|
NotificationProtocol
Supported notification protocols.
|
NotificationRegistration
NotificationRegistration
|
NotificationTopic
NotificationTopic
|
NotificationType
They type of notification to provide relative to a session’s time window.
|
OAuthAuthorizationToken
OAuthAuthorizationToken
|
OAuthProvider
OAuthProvider
|
Operator
|Value|Operator meaning| |---|---| |eq|answer is equal to value| |ne|answer is not equal to value| |lt|answer is less than value| |gt|answer is greater than value| |le|answer is less than or equal to value| |ge|answer is greater than or equal to value| |de|user declines to answer this question (it is being skipped)| |always|always do this action after showing the question or screen| |any|one of the members of a data group set must be assigned to the survey taker| |all|all of the members of a data group set must be assigned to the survey taker|
|
Organization
Organization
|
PagedResourceList
PagedResourceList
|
ParticipantData
The JSON data for a non-time series participant data attribute.
|
ParticipantFile
A descriptor of a participant blob file
|
ParticipantRosterRequest
The JSON data for a participant roster download request.
|
ParticipantSchedule
The ParticipantSchedule is similar to the Timeline in structure, but includes the specific dates when this participant should perform each session, based on this participant’s events.
|
ParticipantStudyProgress
Based on an analysis of the participant’s schedule, including completed sessions and assessments, this is a marker of the participant’s overall progress in the study.
|
ParticipantVersion
Represents a de-identified snapshot of a study participant at a moment in time.
|
PasswordPolicy
The rules to enforce on the creation of passwords for Bridge accounts.
|
PasswordReset
Payload to send a new password to the Bridge server.
|
PerformanceOrder
The assessments in a session can be presented in a fixed and sequential order, in a randomized order the participant cannot choose, or the participant may be allowed to pick and choose the assessments to do them in an order of their choosing.
|
Permission
An object describing an individual user's level of access to an entity or group of items.
|
PermissionDetail
A detailed view of a permission record.
|
PermissionDetailEntity
A reference to an entity with access controlled through permissions.
|
Phone
The user's phone number.
|
PhoneSignIn
Using a token supplied in an SMS message authenticate with the server.
|
PhoneSignInRequest
Make a request to sign in using an SMS message.
|
PostalCodeConstraints
A data type for capturing partial postal code information.
|
PropertyInfo
PropertyInfo
|
RecordExportStatusRequest
A payload sending back the status of an export of one or more health data records to Synapse.
|
ReportData
The JSON data for one time point of a report (either a local date in the format YYYY-MM-DD, or an ISO 8601 timestamp; report records should all use one or the other format consistently).
|
ReportDataForWorker
The JSON data to submit a report record for a point in time (curently a day expressed in the format YYYY-MM-DD).
|
ReportIndex
An identifier to retrieve a series of report data (e.g.
|
ReportType
The type of report: |Type|Description| |---|---| |participant|Reports are scoped to an individual participant and can only be seen by the participant or a researcher| |study|Reports are available to all authenticated users in a study|
|
RequestInfo
Some basic information is captured when a participant makes a request to the Bridge server, mostly for the purpose of troubleshooting user issues with the app.
|
RequestParams
Type-safe object that returns request parameters submitted for a request.
|
ResourceCategory
A category of documentary resource link.
|
ResourceList
Lists from the Bridge server will be returned in a list payload that includes an `items` property with the list of objects, and a `requestParams` object that includes the values that were submitted to the server to generate the list.
|
Role
The roles assigned to this user.
|
Schedule
For more information about scheduling, see [Scheduling](/articles/study_design/scheduling.html).
|
Schedule2
A design-time representation of a schedule for participants to perform (for the v2 of our scheduling API).
|
ScheduleCriteria
In a [CriteriaScheduleStrategy](#CriteriaScheduleStrategy), a list of ScheduleCriteria objects relate each schedule to a set of criteria that needs to match the user's request in order to select that schedule for the user.
|
ScheduledActivity
Description of an activity (such as a task or survey) the study would like the participant to perform.
|
ScheduledAssessment
The `refKey` of this object will refer to the `key` value of an AssessmentInfo object in the assessments of the timeline.
|
ScheduledSession
An individual session instance the participant should perform as part of the study.
|
SchedulePlan
A schedule plan relates schedules to some specific strategies for using these schedules to create activities for participants.
|
ScheduleStatus
Status of this activity.
|
ScheduleStrategy
This is an interface for several implementations.
|
ScheduleType
Schedules come in three major flavors: |Type|Description| |---|---| |once|Activity happens once and only once, and then is never scheduled again.| |recurring|Activity recurrs periodically, either through the use of a cron schedule, or through the use of properties like `interval`, `times` and `expires`.| |persistent|Activity is always in the participant's list of tasks to do.
|
SchemaReference
A pointer to an upload schema defined for this survey.
|
SearchTermPredicate
How search criteria should be evaluated in a search.
|
Session
A group of activities to be performed together in a study by a participant.
|
SessionCompletionState
How search criteria should be evaluated in a search.
|
SessionInfo
Information about a session in order to render it in a UI prior to execution.
|
SharedModuleImportStatus
This struct contains the results of importing a shared module into the local app, including what type of module it is, and its key params (schema ID/revision or survey GUID/createdOn) in the local app.
|
SharedModuleMetadata
Metadata for shared modules in the shared module library.
|
SharedModuleType
Enum to tag shared module metadata as either a schema or a survey.
|
SharingScope
|Enum|Description| |---|---| |no_sharing| Do not share data generated by this participant with the study team;| |sponsors_and_partners|Share data with the study researchers and their researcher partners only;| |all_qualified_researchers|Share data with researchers who qualify under the specific governance qualifications to access the study's data set.
|
SharingScopeForm
SharingScopeForm
|
SignIn
Information to sign in to the Bridge server.
|
SignInType
|Enum|Description| |---|---| |email_password| Study expects participants to sign in with an email address and a password.
|
SignUp
The information necessary to sign up for a Bridge app.
|
SimpleScheduleStrategy
The SimpleScheduleStrategy uses the same schedule for every participant.
|
SmsMessage
Represents an SMS message that we sent to a phone number.
|
SmsTemplate
A template for one of the system SMS messages sent by Bridge.
|
SmsType
Represents whether an SMS message is a transactional or a promotional message.
|
SortOrder
|Enum|Description| |---|---| |asc| Sort so that the earliest startedOn time is the first record in the returned list.
|
StringConstraints
A string answer.
|
StringSearchPosition
How string-based search criteria will be compared to values in a record.
|
Study
A study (an outside organization providing participants for a study).
|
StudyActivityEvent
Activity event for a participant in a specific study, used for scheduling activities.
|
StudyActivityEventRequest
Request object for creating a Custom Activity Event.
|
StudyAdherenceReport
A report on one participant’s adherence to a study’s entire schedule protocol.
|
StudyBurst
The description of a repeating burst of events, against which a study can schedule repeating sets of activities.
|
StudyBurstInfo
Information about a study burst from which some of the timeline is being derived.
|
StudyConsent
For historical reasons, a revision of a consent document is known as a \"study consent\" (it would more accurate to call it a \"subpopulation consent\").
|
StudyParticipant
StudyParticipant
|
StudyPhase
A lifecycle phase for the study.
|
StudyReportWeek
One week of activities to be performed in this study by the participant, measuring weeks from the `studyStartEventId` of the study if it exists for the user (this defaults to `timeline_retrieved` for studies that do not define another event), or the first event the scheduler can find for the participant that is used by the schedule if `studyStartEventId` does not exist for the participant.
|
Subpopulation
A subpopulation in the Bridge server is a group of people who, for the purposes of the study, must agree to a specific consent in order to participate in a study.
|
SubscriptionRequest |
SubscriptionStatus
A participant will receive one of these records for every topic in an app, indicating whether or not the participant is subscribed to that topic.
|
Survey
The definition of a survey.
|
SurveyElement
A survey element (either an info screen or a question).
|
SurveyInfoScreen
A screen of a survey that presents information to the user: instructions, a thank you message, copyright notice, or anything similar.
|
SurveyQuestion
A question in the survey.
|
SurveyQuestionOption
For questions with a list of enumerated answers, this object represents one of those answers.
|
SurveyReference
A pointer to a survey defined for this app, and associated with a survey to be taken as part of the mobile application health study.
|
SurveyRule
An information screen or question may have one or more rules in an array: * Rules are evaluated before the screen is display, and afterward after the user answers a question, or triggers navigation away from the screen through a `next` or `decline to answer` response; * Rules are evaluated against the user's answer to the question (using the `value` property) or against the user's assigned data groups (using the `dataGroups` property); * If a rule matches, the action for that rule should be followed (e.g.
|
SynapseExporterStatus
The status of the job that exports the data of this upload to Synapse.
|
Tag
A tag.
|
TaskReference
A pointer to a task identifier defined for this app, and associated with a task to be performed as part of the mobile application health study (e.g.
|
Template
A template for messaging (SMS, email, etc.);
|
TemplateRevision
A revision of a template
|
TemplateType
The role a template plays in the messaging of the system.
|
TestFilter
What type of participants should be returned by this API? |Value|Description| |---|---| |test|Only return test accounts (for developers and study designers, this will always be test accounts)| |production|Only return production accounts| |both|Return both test and production accounts|
|
TimelineMetadata
TimelineMetadata
|
TimeWindow
A group of activities to be performed together in a study by a participant.
|
UIHint
A string \"hint\" to the user interface about the kind of user interface component that should be used to render the question (see values, above).
|
Unit
The unit of measurement being used for a numeric value when it is expressing something like a duration, weight, or length.
|
Upload
Upload
|
Upload.CompletedByEnum
Currently the API has an endpoint for the client to call and mark an upload completed.
|
UploadFieldDefinition
Note: For legacy reasons, this is the only model object returned from the API that does not have a type property reflecting the implementation structure of the JSON.
|
UploadFieldType
This class is unusual in the API in that the `type` attribute is not a constant `UploadFieldDefinition` string, it is one of the enumerated values and indicates the type of the field, not the type of the model object: |Type|Description| |---|---| |attachment_v2|Attachment.
|
UploadMetadata
Metadata for Bridge uploads.
|
UploadMetadata.CompletedByEnum
Currently the API has an endpoint for the client to call and mark an upload completed.
|
UploadRequest
**Important: Headers of the same values must be used when doing the upload against the pre-signed URL.**
|
UploadSchema
Represents the expected fields and types for a data upload.
|
UploadSchemaType
The type of data being uploaded.
|
UploadStatus
The status of the upload: |Status|Description| |---|---| |unknown|Upload status is unknown.
|
UploadValidationStrictness
Enumeration of upload validation strictness settings.
|
UserConsentHistory
A record of a complete consent (including both the dates of consent and withdrawal, if applicable);
|
Verification
A payload to sent the email or phone verification token back to the bridge server.
|
WeeklyAdherenceReport
A report on one participant’s adherence to a study’s schedule protocol for a specific week.
|
WeeklyAdherenceReportRow
Properties of the entries in the array under each day of the weekly adherence report (0-6).
|
WeeklyEventStreamDay
One day of activities to perform on day N from a specific event (combining all sessions that are triggered by the same event).
|
WeightConstraints
A floating point value.
|
Withdrawal
Withdrawal
|
YearConstraints
A year value (e.g.
|
YearMonthConstraints
A year and month without a date or time (e.g.
|
Copyright © 2023 Sage Bionetworks. All rights reserved.