public interface AppConfigsApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<GuidVersionHolder> |
createAppConfig(AppConfig appConfig)
Create a new app config
Create a new app configuration object.
|
retrofit2.Call<VersionHolder> |
createAppConfigElement(AppConfigElement appConfigElement)
Create a new app config element
Create a new app configuration element.
|
retrofit2.Call<Message> |
deleteAllAppConfigElementRevisions(String id,
Boolean physical)
Delete all revisions of an app config element
Delete all revisions of an app config element.
|
retrofit2.Call<Message> |
deleteAppConfig(String guid,
Boolean physical)
Delete an app config
Delete an existing configuration object.
|
retrofit2.Call<Message> |
deleteAppConfigElement(String id,
Long revision,
Boolean physical)
Delete an app config element
Delete an existing configuration element.
|
retrofit2.Call<AppConfigElementList> |
getAllAppConfigElementRevisions(String id,
Boolean includeDeleted)
Get all revisions for an app config element
Get all revisions for an app config element.
|
retrofit2.Call<AppConfig> |
getAppConfig(String guid)
Get an app config
Get an configuration object for this app.
|
retrofit2.Call<AppConfigElement> |
getAppConfigElement(String id,
Long revision)
Get an app config element
Get an app configuration element for this app.
|
retrofit2.Call<AppConfigList> |
getAppConfigs(Boolean includeDeleted)
Get a list of the app's configurations
Get all the configuration objects for this app.
|
retrofit2.Call<AppConfigElement> |
getMostRecentAppConfigElement(String id)
Get most recent app config element
Get most recently app config element.
|
retrofit2.Call<AppConfigElementList> |
getMostRecentAppConfigElements(Boolean includeDeleted)
Get a list of the most recent revision of each configuration element in the app
Get a list of the app configuration elements in the app, returning the highest revision number for each element in the app.
|
retrofit2.Call<GuidVersionHolder> |
updateAppConfig(String guid,
AppConfig appConfig)
Update an existing app config
Update an existing app configuration.
|
retrofit2.Call<VersionHolder> |
updateAppConfigElement(String id,
Long revision,
AppConfigElement appConfigElement)
Update an existing app config element
Update an existing app configuration element.
|
@Headers(value="Content-Type:application/json") @POST(value="v3/appconfigs") retrofit2.Call<GuidVersionHolder> createAppConfig(@Body AppConfig appConfig)
appConfig
- New app configuration (required)@Headers(value="Content-Type:application/json") @POST(value="v3/appconfigs/elements") retrofit2.Call<VersionHolder> createAppConfigElement(@Body AppConfigElement appConfigElement)
appConfigElement
- New app configuration element (required)@Headers(value="Content-Type:application/json") @DELETE(value="v3/appconfigs/elements/{id}") retrofit2.Call<Message> deleteAllAppConfigElementRevisions(@Path(value="id") String id, @Query(value="physical") Boolean physical)
id
- An identifier (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json") @DELETE(value="v3/appconfigs/{guid}") retrofit2.Call<Message> deleteAppConfig(@Path(value="guid") String guid, @Query(value="physical") Boolean physical)
guid
- A 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") @DELETE(value="v3/appconfigs/elements/{id}/revisions/{revision}") retrofit2.Call<Message> deleteAppConfigElement(@Path(value="id") String id, @Path(value="revision") Long revision, @Query(value="physical") Boolean physical)
id
- An identifier (required)revision
- Revision number (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/appconfigs/elements/{id}") retrofit2.Call<AppConfigElementList> getAllAppConfigElementRevisions(@Path(value="id") String id, @Query(value="includeDeleted") Boolean includeDeleted)
id
- An identifier (required)includeDeleted
- Should deleted items be returned in results? (optional, default to false)@Headers(value="Content-Type:application/json") @GET(value="v3/appconfigs/{guid}") retrofit2.Call<AppConfig> getAppConfig(@Path(value="guid") String guid)
guid
- A guid (required)@Headers(value="Content-Type:application/json") @GET(value="v3/appconfigs/elements/{id}/revisions/{revision}") retrofit2.Call<AppConfigElement> getAppConfigElement(@Path(value="id") String id, @Path(value="revision") Long revision)
id
- An identifier (required)revision
- Revision number (required)@Headers(value="Content-Type:application/json") @GET(value="v3/appconfigs") retrofit2.Call<AppConfigList> getAppConfigs(@Query(value="includeDeleted") Boolean includeDeleted)
includeDeleted
- Should deleted items be returned in results? (optional, default to false)@Headers(value="Content-Type:application/json") @GET(value="v3/appconfigs/elements/{id}/recent") retrofit2.Call<AppConfigElement> getMostRecentAppConfigElement(@Path(value="id") String id)
id
- An identifier (required)@Headers(value="Content-Type:application/json") @GET(value="v3/appconfigs/elements") retrofit2.Call<AppConfigElementList> getMostRecentAppConfigElements(@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/appconfigs/{guid}") retrofit2.Call<GuidVersionHolder> updateAppConfig(@Path(value="guid") String guid, @Body AppConfig appConfig)
guid
- A guid (required)appConfig
- Updated app configuration (required)@Headers(value="Content-Type:application/json") @POST(value="v3/appconfigs/elements/{id}/revisions/{revision}") retrofit2.Call<VersionHolder> updateAppConfigElement(@Path(value="id") String id, @Path(value="revision") Long revision, @Body AppConfigElement appConfigElement)
id
- An identifier (required)revision
- Revision number (required)appConfigElement
- Updated app configuration element (required)Copyright © 2023 Sage Bionetworks. All rights reserved.