org.apache.syncope.common.rest.api.service

Interface ResourceHistoryService

All Superinterfaces:

JAXRSService

@Path(value="resourcesHistory")
public interface ResourceHistoryService
extends JAXRSService

REST operations for resource configuration versioning.

Field Summary

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

PARAM_ANYTYPE_KIND, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_RESOURCE, PARAM_SIZE

Method Summary

Modifier and Type	Method and Description
void	delete(String key) Deletes the resource configuration history matching the provided key.
List<ResourceHistoryConfTO>	list(String resourceKey) Returns a list of all resource configuration history for the given resource key.
void	restore(String key) Restores the resource configuration history matching the provided key.

Method Detail

list

@GET
 @Path(value="{resourceKey}")
 @Produces(value={"application/json","application/yaml","application/xml"})
List<ResourceHistoryConfTO> list(@NotNull @PathParam(value="resourceKey")
                                                                                                                                                String resourceKey)

Returns a list of all resource configuration history for the given resource key.

Parameters:

resourceKey - resource key

Returns:

list of all resource configuration history for the given resource key

restore

@POST
 @Path(value="{key}")
 @Produces(value={"application/json","application/yaml","application/xml"})
void restore(@NotNull @PathParam(value="key")
                                                                                                                     String key)

Restores the resource configuration history matching the provided key.

Parameters:

key - resource configuration history key to be restored

delete

@DELETE
 @Path(value="{key}")
 @Produces(value={"application/json","application/yaml","application/xml"})
void delete(@NotNull @PathParam(value="key")
                                                                                                                      String key)

Deletes the resource configuration history matching the provided key.

Parameters:

key - resource configuration history key to be deleted