public interface ActivitiesApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<ForwardCursorScheduledActivityList> |
getActivityHistory(String activityGuid,
DateTime scheduledOnStart,
DateTime scheduledOnEnd,
String offsetKey,
Integer pageSize)
Deprecated.
|
retrofit2.Call<ForwardCursorScheduledActivityList> |
getCompoundActivityHistory(String taskId,
DateTime scheduledOnStart,
DateTime scheduledOnEnd,
String offsetKey,
Integer pageSize)
Deprecated.
|
retrofit2.Call<ScheduledActivityList> |
getScheduledActivities(String offset,
Integer daysAhead,
Integer minimumPerSchedule)
Deprecated.
|
retrofit2.Call<ScheduledActivityListV4> |
getScheduledActivitiesByDateRange(DateTime startTime,
DateTime endTime)
Deprecated.
|
retrofit2.Call<ForwardCursorScheduledActivityList> |
getSurveyHistory(String surveyGuid,
DateTime scheduledOnStart,
DateTime scheduledOnEnd,
String offsetKey,
Integer pageSize)
Deprecated.
|
retrofit2.Call<ForwardCursorScheduledActivityList> |
getTaskHistory(String taskId,
DateTime scheduledOnStart,
DateTime scheduledOnEnd,
String offsetKey,
Integer pageSize)
Deprecated.
|
retrofit2.Call<Message> |
updateScheduledActivities(List<ScheduledActivity> scheduledActivity)
Deprecated.
|
@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v3/activities/{activityGuid}") retrofit2.Call<ForwardCursorScheduledActivityList> getActivityHistory(@Path(value="activityGuid") String activityGuid, @Query(value="scheduledOnStart") DateTime scheduledOnStart, @Query(value="scheduledOnEnd") DateTime scheduledOnEnd, @Query(value="offsetKey") String offsetKey, @Query(value="pageSize") Integer pageSize)
activityGuid
- Activity GUID (required)scheduledOnStart
- Activities returned are at or after the timestamp. If scheduledOnStart is provided, scheduledOnEnd must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional)scheduledOnEnd
- Activities returned are at or before the timestamp. If scheduledOnEnd is provided, scheduledOnStart must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional)offsetKey
- next page start key for pagination (optional)pageSize
- maximum number of records in each returned page (optional, default to 50)@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v4/activities/compoundactivities/{taskId}") retrofit2.Call<ForwardCursorScheduledActivityList> getCompoundActivityHistory(@Path(value="taskId") String taskId, @Query(value="scheduledOnStart") DateTime scheduledOnStart, @Query(value="scheduledOnEnd") DateTime scheduledOnEnd, @Query(value="offsetKey") String offsetKey, @Query(value="pageSize") Integer pageSize)
taskId
- Task ID (required)scheduledOnStart
- Activities returned are at or after the timestamp. If scheduledOnStart is provided, scheduledOnEnd must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional)scheduledOnEnd
- Activities returned are at or before the timestamp. If scheduledOnEnd is provided, scheduledOnStart must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional)offsetKey
- next page start key for pagination (optional)pageSize
- maximum number of records in each returned page (optional, default to 50)@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v3/activities") retrofit2.Call<ScheduledActivityList> getScheduledActivities(@Query(value="offset") String offset, @Query(value="daysAhead") Integer daysAhead, @Query(value="minimumPerSchedule") Integer minimumPerSchedule)
offset
- The user's time zone offset (e.g. +07:00). Scheduled activities will be returned in the timezone submitted at the time of the request. (required)daysAhead
- Retrieve activities that are scheduled in the future for the indicated number of days past today. (required)minimumPerSchedule
- Force a look-ahead on repeating activities until at least the indicated number of activities are scheduled (this is applied to the each schedule in the system that applies to this user). The system will then return either the activities for N days, or the minimum number of activities, whichever is the greatest in number. This setting can help to expose infrequent tasks (weekly, monthly, etc.) to users. (optional)@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v4/activities") retrofit2.Call<ScheduledActivityListV4> getScheduledActivitiesByDateRange(@Query(value="startTime") DateTime startTime, @Query(value="endTime") DateTime endTime)
startTime
- (required)endTime
- (required)@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v4/activities/surveys/{surveyGuid}") retrofit2.Call<ForwardCursorScheduledActivityList> getSurveyHistory(@Path(value="surveyGuid") String surveyGuid, @Query(value="scheduledOnStart") DateTime scheduledOnStart, @Query(value="scheduledOnEnd") DateTime scheduledOnEnd, @Query(value="offsetKey") String offsetKey, @Query(value="pageSize") Integer pageSize)
surveyGuid
- Survey GUID (required)scheduledOnStart
- Activities returned are at or after the timestamp. If scheduledOnStart is provided, scheduledOnEnd must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional)scheduledOnEnd
- Activities returned are at or before the timestamp. If scheduledOnEnd is provided, scheduledOnStart must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional)offsetKey
- next page start key for pagination (optional)pageSize
- maximum number of records in each returned page (optional, default to 50)@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v4/activities/tasks/{taskId}") retrofit2.Call<ForwardCursorScheduledActivityList> getTaskHistory(@Path(value="taskId") String taskId, @Query(value="scheduledOnStart") DateTime scheduledOnStart, @Query(value="scheduledOnEnd") DateTime scheduledOnEnd, @Query(value="offsetKey") String offsetKey, @Query(value="pageSize") Integer pageSize)
taskId
- Task ID (required)scheduledOnStart
- Activities returned are at or after the timestamp. If scheduledOnStart is provided, scheduledOnEnd must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional)scheduledOnEnd
- Activities returned are at or before the timestamp. If scheduledOnEnd is provided, scheduledOnStart must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional)offsetKey
- next page start key for pagination (optional)pageSize
- maximum number of records in each returned page (optional, default to 50)@Deprecated @Headers(value="Content-Type:application/json") @POST(value="v4/activities") retrofit2.Call<Message> updateScheduledActivities(@Body List<ScheduledActivity> scheduledActivity)
scheduledActivity
- (required)Copyright © 2023 Sage Bionetworks. All rights reserved.