public interface ParticipantFilesApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<ParticipantFile> |
createParticipantFile(String fileId,
ParticipantFile participantFile)
Create a new participant file
|
retrofit2.Call<Message> |
deleteParticipantFile(String fileId)
Delete a participant file
Delete a participant file
|
retrofit2.Call<okhttp3.ResponseBody> |
getParticipantFile(String fileId)
Get a participant file
|
retrofit2.Call<ParticipantFileList> |
getParticipantFiles(String offsetKey,
Integer pageSize)
Get a list of participant files from the user
|
@Headers(value="Content-Type:application/json") @POST(value="v3/participants/self/files/{fileId}") retrofit2.Call<ParticipantFile> createParticipantFile(@Path(value="fileId") String fileId, @Body ParticipantFile participantFile)
fileId
- (required)participantFile
- The participant file metadata (required)@Headers(value="Content-Type:application/json") @DELETE(value="v3/participants/self/files/{fileId}") retrofit2.Call<Message> deleteParticipantFile(@Path(value="fileId") String fileId)
fileId
- (required)@Headers(value="Content-Type:application/json") @GET(value="v3/participants/self/files/{fileId}") retrofit2.Call<okhttp3.ResponseBody> getParticipantFile(@Path(value="fileId") String fileId)
fileId
- (required)@Headers(value="Content-Type:application/json") @GET(value="v3/participants/self/files") retrofit2.Call<ParticipantFileList> getParticipantFiles(@Query(value="offsetKey") String offsetKey, @Query(value="pageSize") Integer pageSize)
offsetKey
- next page start key for pagination (optional)pageSize
- maximum number of records in each returned page (optional, default to 50)Copyright © 2023 Sage Bionetworks. All rights reserved.