public interface HealthDataDocumentationApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<HealthDataDocumentation> |
createOrUpdateHealthDataDocumentation(HealthDataDocumentation healthDataDocumentation)
Create or update health data documentation.
|
retrofit2.Call<Message> |
deleteAllHealthDataDocumentationForParentId(String parentId)
Delete all documentation associated with given parentId
|
retrofit2.Call<Message> |
deleteHealthDataDocumentationForIdentifier(String identifier)
Delete a health data documentation with the given identifier.
|
retrofit2.Call<HealthDataDocumentationList> |
getAllHealthDataDocumentationForParentId(String parentId,
String offsetKey,
Integer pageSize)
Get all health data documentation by parentId.
|
retrofit2.Call<HealthDataDocumentation> |
getHealthDataDocumentationForId(String identifier)
Get a health data documentation with the given identifier
This endpoint can be called by researchers and developers to get a specific documentation by identifier.
|
@Headers(value="Content-Type:application/json") @POST(value="v3/healthdatadocumentation") retrofit2.Call<HealthDataDocumentation> createOrUpdateHealthDataDocumentation(@Body HealthDataDocumentation healthDataDocumentation)
healthDataDocumentation
- Health data documentation submitted by the user (required)@Headers(value="Content-Type:application/json") @DELETE(value="v3/healthdatadocumentation") retrofit2.Call<Message> deleteAllHealthDataDocumentationForParentId(@Query(value="parentId") String parentId)
parentId
- The id used in place of appId, and in the future, studyId. (optional)@Headers(value="Content-Type:application/json") @DELETE(value="v3/healthdatadocumentation/{identifier}") retrofit2.Call<Message> deleteHealthDataDocumentationForIdentifier(@Path(value="identifier") String identifier)
identifier
- identifier (required)@Headers(value="Content-Type:application/json") @GET(value="v3/healthdatadocumentation") retrofit2.Call<HealthDataDocumentationList> getAllHealthDataDocumentationForParentId(@Query(value="parentId") String parentId, @Query(value="offsetKey") String offsetKey, @Query(value="pageSize") Integer pageSize)
parentId
- The id used in place of appId, and in the future, studyId. (optional)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") @GET(value="v3/healthdatadocumentation/{identifier}") retrofit2.Call<HealthDataDocumentation> getHealthDataDocumentationForId(@Path(value="identifier") String identifier)
identifier
- identifier (required)Copyright © 2023 Sage Bionetworks. All rights reserved.