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

Interface AnyTypeService

All Superinterfaces:
JAXRSService
@Path("anyTypes") public interface AnyTypeService extends JAXRSService
REST operations for any types.

  • Method Details

    • list

      @GET @Produces({"application/json","application/yaml","application/xml"}) List<org.apache.syncope.common.lib.to.AnyTypeTO> list()
      Returns a list of all anyTypes.
      Returns:
      list of all anyTypes.

    • read

      @GET @Path("{key}") @Produces({"application/json","application/yaml","application/xml"}) org.apache.syncope.common.lib.to.AnyTypeTO read(@NotNull @PathParam("key") @NotNull String key)
      Returns anyType with matching key.
      Parameters:
      key - anyType key to be read
      Returns:
      anyType with matching key

    • create

      @POST @Consumes({"application/json","application/yaml","application/xml"}) jakarta.ws.rs.core.Response create(@NotNull @NotNull org.apache.syncope.common.lib.to.AnyTypeTO anyTypeTO)
      Creates a new anyType.
      Parameters:
      anyTypeTO - anyType to be created
      Returns:
      Response object featuring Location header of created anyType

    • update

      @PUT @Path("{key}") @Consumes({"application/json","application/yaml","application/xml"}) void update(@NotNull @NotNull org.apache.syncope.common.lib.to.AnyTypeTO anyTypeTO)
      Updates the anyType matching the provided key.
      Parameters:
      anyTypeTO - anyType to be stored

    • delete

      @DELETE @Path("{key}") @Produces({"application/json","application/yaml","application/xml"}) void delete(@NotNull @PathParam("key") @NotNull String key)
      Deletes the anyType matching the provided key.
      Parameters:
      key - anyType key to be deleted