org.sagebionetworks.bridge.rest.api

Interface UploadsApi

public interface UploadsApi

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<UploadValidationStatus>	completeUploadSession(String uploadId, Boolean synchronous, Boolean redrive) Notify Bridge an upload is complete Notify Bridge an upload is complete.
retrofit2.Call<Upload>	getUploadById(String uploadId) Get an upload by ID
retrofit2.Call<Upload>	getUploadByRecordId(String recordId) Get an upload record by the health data record ID A superadmin or worker can retrieve any upload in any app.
retrofit2.Call<UploadList>	getUploads(DateTime startTime, DateTime endTime, Integer pageSize, String offsetKey) Get uploads for the app
retrofit2.Call<UploadValidationStatus>	getUploadStatus(String uploadId) Get status of a single upload attempt Caller must either be a participant getting a status of one of the participant's own uploads, or a reearcher.
retrofit2.Call<UploadSession>	requestUploadSession(UploadRequest uploadRequest) Request an upload session

Method Detail

completeUploadSession

@Headers(value="Content-Type:application/json")
 @POST(value="v3/uploads/{uploadId}/complete")
retrofit2.Call<UploadValidationStatus> completeUploadSession(@Path(value="uploadId")
                                                                                                                                                            String uploadId,
                                                                                                                                                            @Query(value="synchronous")
                                                                                                                                                            Boolean synchronous,
                                                                                                                                                            @Query(value="redrive")
                                                                                                                                                            Boolean redrive)

Notify Bridge an upload is complete Notify Bridge an upload is complete. Either a consented user or a worker process can access this endpoing, but failure to have the worker role will be treated like a consent error. In synchronous mode, this API will poll until upload validation is complete (or failed or is otherwise in a non-transient state), and return the upload validation status. In asynchronous mode, this API will return immediately and will also return the upload validation status, which is likely to be in \"validation_in_progress\".

Parameters:

uploadId - Upload ID (required)

synchronous - True if this API call should wait for upload validation to finish before returning. (optional, default to false)

redrive - True if this API call should allow completing uploads that are already complete. This is to allow redrives and backfills. (optional, default to false)

Returns:

Call<UploadValidationStatus>

getUploadById

@Headers(value="Content-Type:application/json")
 @GET(value="v3/uploads/{uploadId}")
retrofit2.Call<Upload> getUploadById(@Path(value="uploadId")
                                                                                                                          String uploadId)

Get an upload by ID

Parameters:

uploadId - Upload ID (required)

Returns:

Call<Upload>

getUploadByRecordId

@Headers(value="Content-Type:application/json")
 @GET(value="v3/uploads/recordId:{recordId}")
retrofit2.Call<Upload> getUploadByRecordId(@Path(value="recordId")
                                                                                                                                         String recordId)

Get an upload record by the health data record ID A superadmin or worker can retrieve any upload in any app. An Admin can retrieve any upload in their own app. A developer can retrieve an upload generated from their own account in an app.

Parameters:

recordId - Health data record ID (required)

Returns:

Call<Upload>

getUploadStatus

@Headers(value="Content-Type:application/json")
 @GET(value="v3/uploadstatuses/{uploadId}")
retrofit2.Call<UploadValidationStatus> getUploadStatus(@Path(value="uploadId")
                                                                                                                                                   String uploadId)

Get status of a single upload attempt Caller must either be a participant getting a status of one of the participant's own uploads, or a reearcher.

Parameters:

uploadId - Upload ID (required)

Returns:

Call<UploadValidationStatus>

getUploads

@Headers(value="Content-Type:application/json")
 @GET(value="v1/apps/self/uploads")
retrofit2.Call<UploadList> getUploads(@Query(value="startTime")
                                                                                                                          DateTime startTime,
                                                                                                                          @Query(value="endTime")
                                                                                                                          DateTime endTime,
                                                                                                                          @Query(value="pageSize")
                                                                                                                          Integer pageSize,
                                                                                                                          @Query(value="offsetKey")
                                                                                                                          String offsetKey)

Get uploads for the app

Parameters:

startTime - (required)

endTime - (required)

pageSize - maximum number of records in each returned page (optional, default to 50)

offsetKey - next page start key for pagination (optional)

Returns:

Call<UploadList>

requestUploadSession

@Headers(value="Content-Type:application/json")
 @POST(value="v3/uploads")
retrofit2.Call<UploadSession> requestUploadSession(@Body
                                                                                                                              UploadRequest uploadRequest)

Request an upload session

Parameters:

uploadRequest - An upload request (required)

Returns:

Call<UploadSession>