public interface StudyReportsApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<Message> |
addStudyReportRecord(String identifier,
ReportData reportData)
Add a record to a study report
Any member of an organization sponsoring a study, or any app-scoped administrative user, can access a study report.
|
retrofit2.Call<Message> |
deleteAllStudyReportRecords(String identifier)
Delete a study report (all records)
|
retrofit2.Call<Message> |
deleteStudyReportRecord(String identifier,
LocalDate date)
Delete a record for a specific day of a study report
|
retrofit2.Call<ReportDataList> |
getPublicStudyReportRecords(String appId,
String identifier,
LocalDate startDate,
LocalDate endDate)
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).
|
retrofit2.Call<ReportIndex> |
getStudyReportIndex(String identifier)
Get a report index
Get the index (or metadata) for a set of report records.
|
retrofit2.Call<ReportIndexList> |
getStudyReportIndices()
Get list of report indices for studies
|
retrofit2.Call<ReportDataList> |
getStudyReportRecords(String identifier,
LocalDate startDate,
LocalDate endDate)
Get study report records
Any member of an organization sponsoring a study, or any app-scoped administrative user, can access a study report record.
|
retrofit2.Call<ForwardCursorReportDataList> |
getStudyReportRecordsV4(String identifier,
DateTime startTime,
DateTime endTime,
String offsetKey,
Integer pageSize)
Get study report records
Any member of an organization sponsoring a study, or any app-scoped administrative user, can access a study report.
|
retrofit2.Call<Message> |
updateStudyReportIndex(String identifier,
ReportIndex reportIndex)
Update an existing study report index
Update the index (or metadata) for a set of report records.
|
@Headers(value="Content-Type:application/json") @POST(value="v4/reports/{identifier}") retrofit2.Call<Message> addStudyReportRecord(@Path(value="identifier") String identifier, @Body ReportData reportData)
identifier
- identifier (required)reportData
- Report data (required)@Headers(value="Content-Type:application/json") @DELETE(value="v4/reports/{identifier}") retrofit2.Call<Message> deleteAllStudyReportRecords(@Path(value="identifier") String identifier)
identifier
- identifier (required)@Headers(value="Content-Type:application/json") @DELETE(value="v3/reports/{identifier}/{date}") retrofit2.Call<Message> deleteStudyReportRecord(@Path(value="identifier") String identifier, @Path(value="date") LocalDate date)
identifier
- identifier (required)date
- Date of records (required)@Headers(value="Content-Type:application/json") @GET(value="v1/apps/{appId}/reports/{identifier}") retrofit2.Call<ReportDataList> getPublicStudyReportRecords(@Path(value="appId") String appId, @Path(value="identifier") String identifier, @Query(value="startDate") LocalDate startDate, @Query(value="endDate") LocalDate endDate)
appId
- App ID (required)identifier
- identifier (required)startDate
- The first day to include in reports that are returned (required)endDate
- The last day to include in reports that are returned (required)@Headers(value="Content-Type:application/json") @GET(value="v3/reports/{identifier}/index") retrofit2.Call<ReportIndex> getStudyReportIndex(@Path(value="identifier") String identifier)
identifier
- identifier (required)@Headers(value="Content-Type:application/json") @GET(value="v3/reports") retrofit2.Call<ReportIndexList> getStudyReportIndices()
@Headers(value="Content-Type:application/json") @GET(value="v3/reports/{identifier}") retrofit2.Call<ReportDataList> getStudyReportRecords(@Path(value="identifier") String identifier, @Query(value="startDate") LocalDate startDate, @Query(value="endDate") LocalDate endDate)
identifier
- identifier (required)startDate
- The first day to include in reports that are returned (required)endDate
- The last day to include in reports that are returned (required)@Headers(value="Content-Type:application/json") @GET(value="v4/reports/{identifier}") retrofit2.Call<ForwardCursorReportDataList> getStudyReportRecordsV4(@Path(value="identifier") String identifier, @Query(value="startTime") DateTime startTime, @Query(value="endTime") DateTime endTime, @Query(value="offsetKey") String offsetKey, @Query(value="pageSize") Integer pageSize)
identifier
- identifier (required)startTime
- (required)endTime
- (required)offsetKey
- next page start key for pagination (optional)pageSize
- maximum number of records in each returned page (optional, default to 50)@Headers(value="Content-Type:application/json") @POST(value="v3/reports/{identifier}/index") retrofit2.Call<Message> updateStudyReportIndex(@Path(value="identifier") String identifier, @Body ReportIndex reportIndex)
identifier
- identifier (required)reportIndex
- Report index (required)Copyright © 2023 Sage Bionetworks. All rights reserved.