public interface ForSuperadminsApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<Message> |
addTag(Tag tag)
Create a tag if it does not yet exist.
|
retrofit2.Call<UserSessionInfo> |
adminSignIn(SignIn signIn)
Sign in using an administrative account.
|
retrofit2.Call<VersionHolder> |
createApp(App app)
Create a new app
|
retrofit2.Call<VersionHolder> |
createAppAndUsers(AppAndUsers appAndUsers)
Create a new app with administrators and users
Create a new app along with the access team and project in Synapse to receive data collected through Bridge.
|
retrofit2.Call<MasterSchedulerConfig> |
createSchedulerConfig(MasterSchedulerConfig masterSchedulerConfig)
Create a scheduler config
|
retrofit2.Call<Message> |
deleteApp(String appId,
Boolean physical)
Delete a app
|
retrofit2.Call<Message> |
deleteCacheKeys(String cacheKey)
Get all the non-session Redis keys
|
retrofit2.Call<Message> |
deleteRecordsEx3ForUser(String appId,
String userId)
Deletes all health data records from the Exporter 3 implementation for the given user.
|
retrofit2.Call<Message> |
deleteSchedulerConfig(String scheduleId)
Delete a scheduler config
|
retrofit2.Call<Message> |
deleteSharedAssessment(String guid,
Boolean physical)
Delete an assessment revision.
|
retrofit2.Call<Message> |
deleteSharedAssessmentResource(String assessmentId,
String guid,
Boolean physical)
Delete an external resource link documenting a shared assessment
|
retrofit2.Call<Message> |
deleteTag(String tagValue)
Delete a tag
|
retrofit2.Call<MasterSchedulerConfigList> |
getAllSchedulerConfigs()
Get list of scheduler configs
|
retrofit2.Call<App> |
getApp(String appId)
Get an app
|
retrofit2.Call<AppList> |
getApps(Boolean summary)
Get all apps The summary must be true if this call is made without authentication.
|
retrofit2.Call<StringList> |
getCacheKeys()
Get all the non-session Redis keys
|
retrofit2.Call<MasterSchedulerConfig> |
getSchedulerConfig(String scheduleId)
Get a scheduler config
|
retrofit2.Call<Study> |
revertStudyToDesign(String studyId)
Transition a study’s phase to “design” disregarding the current phase of the study.
|
retrofit2.Call<VersionHolder> |
updateApp(String appId,
App app)
Update a app
|
retrofit2.Call<Message> |
updateParticipantRequestInfo(String userId,
RequestInfo requestInfo)
Superadmin API to update a participant's request info.
|
retrofit2.Call<MasterSchedulerConfig> |
updateSchedulerConfig(String scheduleId,
MasterSchedulerConfig masterSchedulerConfig)
Update a scheduler config
|
@Headers(value="Content-Type:application/json") @POST(value="v1/tags") retrofit2.Call<Message> addTag(@Body Tag tag)
tag
- New tag (required)@Headers(value="Content-Type:application/json") @POST(value="v3/auth/admin/signIn") retrofit2.Call<UserSessionInfo> adminSignIn(@Body SignIn signIn)
signIn
- Sign in information (required)@Headers(value="Content-Type:application/json") @POST(value="v1/apps") retrofit2.Call<VersionHolder> createApp(@Body App app)
app
- (required)@Headers(value="Content-Type:application/json") @POST(value="v1/apps/init") retrofit2.Call<VersionHolder> createAppAndUsers(@Body AppAndUsers appAndUsers)
appAndUsers
- (required)@Headers(value="Content-Type:application/json") @POST(value="v3/schedulerconfigs") retrofit2.Call<MasterSchedulerConfig> createSchedulerConfig(@Body MasterSchedulerConfig masterSchedulerConfig)
masterSchedulerConfig
- Master scheduler config (required)@Headers(value="Content-Type:application/json") @DELETE(value="v1/apps/{appId}") retrofit2.Call<Message> deleteApp(@Path(value="appId") String appId, @Query(value="physical") Boolean physical)
appId
- App ID (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json") @DELETE(value="v3/cache/{cacheKey}") retrofit2.Call<Message> deleteCacheKeys(@Path(value="cacheKey") String cacheKey)
cacheKey
- Cache key (required)@Headers(value="Content-Type:application/json") @DELETE(value="v1/apps/{appId}/participants/{userId}/exporter3/healthdata") retrofit2.Call<Message> deleteRecordsEx3ForUser(@Path(value="appId") String appId, @Path(value="userId") String userId)
appId
- App ID (required)userId
- User ID (required)@Headers(value="Content-Type:application/json") @DELETE(value="v3/schedulerconfigs/{scheduleId}") retrofit2.Call<Message> deleteSchedulerConfig(@Path(value="scheduleId") String scheduleId)
scheduleId
- Scheduler identifier (required)@Headers(value="Content-Type:application/json") @DELETE(value="v1/sharedassessments/{guid}") retrofit2.Call<Message> deleteSharedAssessment(@Path(value="guid") String guid, @Query(value="physical") Boolean physical)
guid
- A guid (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json") @DELETE(value="v1/sharedassessments/identifier:{assessmentId}/resources/{guid}") retrofit2.Call<Message> deleteSharedAssessmentResource(@Path(value="assessmentId") String assessmentId, @Path(value="guid") String guid, @Query(value="physical") Boolean physical)
assessmentId
- The identifier for a stream of assessment revisions (required)guid
- A guid (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json") @DELETE(value="v1/tags/{tagValue}") retrofit2.Call<Message> deleteTag(@Path(value="tagValue") String tagValue)
tagValue
- A tag value (required)@Headers(value="Content-Type:application/json") @GET(value="v3/schedulerconfigs") retrofit2.Call<MasterSchedulerConfigList> getAllSchedulerConfigs()
@Headers(value="Content-Type:application/json") @GET(value="v1/apps/{appId}") retrofit2.Call<App> getApp(@Path(value="appId") String appId)
appId
- App ID (required)@Headers(value="Content-Type:application/json") @GET(value="v1/apps") retrofit2.Call<AppList> getApps(@Query(value="summary") Boolean summary)
summary
- If true, anyone can call this endpoint and return a list of truncated app objects (name and ID only). Otherwise, caller must be an admin. (optional)@Headers(value="Content-Type:application/json") @GET(value="v3/cache") retrofit2.Call<StringList> getCacheKeys()
@Headers(value="Content-Type:application/json") @GET(value="v3/schedulerconfigs/{scheduleId}") retrofit2.Call<MasterSchedulerConfig> getSchedulerConfig(@Path(value="scheduleId") String scheduleId)
scheduleId
- Scheduler identifier (required)@Headers(value="Content-Type:application/json") @POST(value="v5/studies/{studyId}/reverttodesign") retrofit2.Call<Study> revertStudyToDesign(@Path(value="studyId") String studyId)
studyId
- Study identifier (required)@Headers(value="Content-Type:application/json") @POST(value="v1/apps/{appId}") retrofit2.Call<VersionHolder> updateApp(@Path(value="appId") String appId, @Body App app)
appId
- App ID (required)app
- (required)@Headers(value="Content-Type:application/json") @POST(value="v3/participants/{userId}/requestInfo") retrofit2.Call<Message> updateParticipantRequestInfo(@Path(value="userId") String userId, @Body RequestInfo requestInfo)
userId
- User ID (required)requestInfo
- Request info to update (required)@Headers(value="Content-Type:application/json") @POST(value="v3/schedulerconfigs/{scheduleId}") retrofit2.Call<MasterSchedulerConfig> updateSchedulerConfig(@Path(value="scheduleId") String scheduleId, @Body MasterSchedulerConfig masterSchedulerConfig)
scheduleId
- Scheduler identifier (required)masterSchedulerConfig
- (required)Copyright © 2023 Sage Bionetworks. All rights reserved.