Package lumis.service.formbuilder

Class FormBuilderResource

  • @Path("/lumis/service/formbuilder/rest/forms/{formId:[A-F0-9]{32}}/answers")
public class FormBuilderResource
extends java.lang.Object
    Form builder related operations.
    Since:
    8.2.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      javax.ws.rs.core.Response getAnswersReport​(@NotNull java.lang.String formId)
      Returns the answers report of the given form.
      javax.ws.rs.core.Response getFormAnswers​(@NotNull java.lang.String formId, @Min(0L) @Max(1000L) java.lang.Integer maxResults, @javax.validation.constraints.Min(0L) int startAt, AnswerStatus answerStatus)
      Returns the list of answers of the given form.
      void postForm​(java.lang.String formId, javax.ws.rs.core.MultivaluedMap<java.lang.String,​java.lang.String> formParameters)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • FormBuilderResource

        public FormBuilderResource()

    • Method Detail

      • getAnswersReport

        @GET
@Path("/report.csv")
@Produces("text/csv")
public javax.ws.rs.core.Response getAnswersReport​(@PathParam("formId") @NotNull
                                                  @NotNull java.lang.String formId)
                                           throws java.lang.Exception
        Returns the answers report of the given form.
        Parameters:
        formId - the form identifier.
        Returns:
        the answers report of the given form.
        Throws:
        java.lang.Exception
        Since:
        8.2.0

      • getFormAnswers

        @GET
@Produces("application/json")
public javax.ws.rs.core.Response getFormAnswers​(@PathParam("formId") @NotNull
                                                @NotNull java.lang.String formId,
                                                @DefaultValue("1000") @Min(0L) @Max(1000L) @QueryParam("maxResults")
                                                @Min(0L) @Max(1000L) java.lang.Integer maxResults,
                                                @DefaultValue("0") @Min(0L) @QueryParam("startAt")
                                                @javax.validation.constraints.Min(0L) int startAt,
                                                @QueryParam("answerStatus")
                                                AnswerStatus answerStatus)
                                         throws PortalException
        Returns the list of answers of the given form.
        Parameters:
        formId - the form identifier
        maxResults - the maximum number of answers the response will contain
        startAt - skip this amount of answers
        answerStatus - the answer status for filtering results
        Returns:
        the response with the FormAnswerListResult as a JSON string
        Throws:
        PortalException

      • postForm

        @POST
@Consumes("application/x-www-form-urlencoded")
@Produces("application/json")
public void postForm​(@PathParam("formId")
                     java.lang.String formId,
                     javax.ws.rs.core.MultivaluedMap<java.lang.String,​java.lang.String> formParameters)
              throws PortalException,
                     org.json.simple.parser.ParseException
        Throws:
        PortalException
        org.json.simple.parser.ParseException