public interface SubpopulationsApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<GuidVersionHolder> |
createSubpopulation(Subpopulation subpopulation)
Create a new subpopulation
|
retrofit2.Call<Message> |
deleteSubpopulation(String subpopulationGuid,
Boolean physical)
Delete a subpopulation
Delete a subpopulation unless it is a default subpopulation, which cannot be deleted.
|
retrofit2.Call<Subpopulation> |
getSubpopulation(String subpopulationGuid)
Get a subpopulation
|
retrofit2.Call<SubpopulationList> |
getSubpopulations(Boolean includeDeleted)
Get all subpopulations in this app.
|
retrofit2.Call<GuidVersionHolder> |
updateSubpopulation(String subpopulationGuid,
Subpopulation subpopulation)
Update an existing subpopulation
|
@Headers(value="Content-Type:application/json") @POST(value="v3/subpopulations") retrofit2.Call<GuidVersionHolder> createSubpopulation(@Body Subpopulation subpopulation)
subpopulation
- New subpopulation (required)@Headers(value="Content-Type:application/json") @DELETE(value="v3/subpopulations/{subpopulationGuid}") retrofit2.Call<Message> deleteSubpopulation(@Path(value="subpopulationGuid") String subpopulationGuid, @Query(value="physical") Boolean physical)
subpopulationGuid
- Subpopulation 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") @GET(value="v3/subpopulations/{subpopulationGuid}") retrofit2.Call<Subpopulation> getSubpopulation(@Path(value="subpopulationGuid") String subpopulationGuid)
subpopulationGuid
- Subpopulation GUID (required)@Headers(value="Content-Type:application/json") @GET(value="v3/subpopulations") retrofit2.Call<SubpopulationList> getSubpopulations(@Query(value="includeDeleted") Boolean includeDeleted)
includeDeleted
- Should deleted items be returned in results? (optional, default to false)@Headers(value="Content-Type:application/json") @POST(value="v3/subpopulations/{subpopulationGuid}") retrofit2.Call<GuidVersionHolder> updateSubpopulation(@Path(value="subpopulationGuid") String subpopulationGuid, @Body Subpopulation subpopulation)
subpopulationGuid
- Subpopulation GUID (required)subpopulation
- A subpopulation (required)Copyright © 2023 Sage Bionetworks. All rights reserved.