Package org.apache.fineract.template.api

Class TemplatesApiResource

java.lang.Object

org.apache.fineract.template.api.TemplatesApiResource

@Path("/v1/templates")
@Consumes("application/json")
@Produces("application/json")
@Component
public class TemplatesApiResource
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENTITIES
static final String	ID
static final String	PARAM_TEMPLATE
static final String	TYPES

Constructor Summary

Constructors

Constructor	Description
TemplatesApiResource()

Method Summary

Modifier and Type	Method	Description
String	createTemplate(String apiRequestBodyAsJson)
String	deleteTemplate(Long templateId)
String	getTemplateByTemplate(Long templateId, jakarta.ws.rs.core.UriInfo uriInfo)
String	mergeTemplate(Long templateId, jakarta.ws.rs.core.UriInfo uriInfo, String apiRequestBodyAsJson)
String	retrieveAll(int typeId, int entityId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveOne(Long templateId, jakarta.ws.rs.core.UriInfo uriInfo)
String	saveTemplate(Long templateId, String apiRequestBodyAsJson)
String	template(jakarta.ws.rs.core.UriInfo uriInfo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

ENTITIES

public static final String ENTITIES

See Also:

• Constant Field Values

TYPES

public static final String TYPES

See Also:

• Constant Field Values

PARAM_TEMPLATE

public static final String PARAM_TEMPLATE

See Also:

• Constant Field Values

Constructor Details

TemplatesApiResource

public TemplatesApiResource()

Method Details

retrieveAll

@GET
public String retrieveAll(@DefaultValue("-1") @QueryParam("typeId")
 int typeId,
 @DefaultValue("-1") @QueryParam("entityId")
 int entityId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

template

@GET
@Path("template")
public String template(@Context
 jakarta.ws.rs.core.UriInfo uriInfo)

createTemplate

@POST
public String createTemplate(String apiRequestBodyAsJson)

retrieveOne

@GET
@Path("{templateId}")
public String retrieveOne(@PathParam("templateId")
 Long templateId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getTemplateByTemplate

@GET
@Path("{templateId}/template")
public String getTemplateByTemplate(@PathParam("templateId")
 Long templateId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

saveTemplate

@PUT
@Path("{templateId}")
public String saveTemplate(@PathParam("templateId")
 Long templateId,
 String apiRequestBodyAsJson)

deleteTemplate

@DELETE
@Path("{templateId}")
public String deleteTemplate(@PathParam("templateId")
 Long templateId)

mergeTemplate

@POST
@Path("{templateId}")
@Produces("text/html")
public String mergeTemplate(@PathParam("templateId")
 Long templateId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 String apiRequestBodyAsJson)
                     throws IOException

Throws:

IOException