Package de.xima.fc.api.rest.services

Class FormRecordService

java.lang.Object

de.xima.fc.api.rest.services.FormRecordService

@Produces({"application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8","application/json; charset=utf-8"})
@Path("/form-records")
@FcSecurity(authorizers="isFullyAuthenticated")
public class FormRecordService
extends Object

REST service providing endpoints for FormRecordResources.

Since:

8.2.0

Author:

XIMA Media GmbH

Constructor Summary

Constructors

Constructor	Description
FormRecordService()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	downloadFormRecordAttachments(UUID formRecordUuid, org.pac4j.core.profile.CommonProfile profile)
javax.ws.rs.core.Response	executeTrigger(UUID formRecordUuid, UUID taskUuid, UUID triggerUuid, org.pac4j.core.profile.CommonProfile profile)
javax.ws.rs.core.Response	getFormRecordAttachments(UUID formRecordUuid, int pageSize, int page, org.pac4j.core.profile.CommonProfile profile)
javax.ws.rs.core.Response	getFormRecordChats(UUID formRecordUuid, int pageSize, int page, org.pac4j.core.profile.CommonProfile profile)
javax.ws.rs.core.Response	getFormRecords(int pageSize, int page, org.pac4j.core.profile.CommonProfile profile)
javax.ws.rs.core.Response	getFormRecordUserTriggers(UUID formRecordUuid, int pageSize, int page, org.pac4j.core.profile.CommonProfile profile)
javax.ws.rs.core.Response	getSingleFormRecord(UUID formRecordUuid, org.pac4j.core.profile.CommonProfile profile)
javax.ws.rs.core.Response	getSingleFormRecordUserTrigger(UUID formRecordUuid, UUID taskUuid, UUID triggerUuid, org.pac4j.core.profile.CommonProfile profile)

Methods inherited from class java.lang.Object

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

Constructor Detail

FormRecordService

public FormRecordService()

Method Detail

getFormRecords

@GET
@Produces({"application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8","application/json; charset=utf-8"})
public javax.ws.rs.core.Response getFormRecords(@QueryParam("size") @DefaultValue("10")
                                                int pageSize,
                                                @QueryParam("page") @DefaultValue("1")
                                                int page,
                                                @Pac4JProfile
                                                org.pac4j.core.profile.CommonProfile profile)

getSingleFormRecord

@GET
@Path("/{formRecordUuid}")
@Produces({"application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8","application/json; charset=utf-8"})
public javax.ws.rs.core.Response getSingleFormRecord(@PathParam("formRecordUuid")
                                                     UUID formRecordUuid,
                                                     @Pac4JProfile
                                                     org.pac4j.core.profile.CommonProfile profile)

getFormRecordChats

@GET
@Path("/{formRecordUuid}/chats")
public javax.ws.rs.core.Response getFormRecordChats(@PathParam("formRecordUuid")
                                                    UUID formRecordUuid,
                                                    @QueryParam("size") @DefaultValue("10")
                                                    int pageSize,
                                                    @QueryParam("page") @DefaultValue("1")
                                                    int page,
                                                    @Pac4JProfile
                                                    org.pac4j.core.profile.CommonProfile profile)

getFormRecordAttachments

@GET
@Path("/{formRecordUuid}/attachments")
public javax.ws.rs.core.Response getFormRecordAttachments(@PathParam("formRecordUuid")
                                                          UUID formRecordUuid,
                                                          @QueryParam("size") @DefaultValue("10")
                                                          int pageSize,
                                                          @QueryParam("page") @DefaultValue("1")
                                                          int page,
                                                          @Pac4JProfile
                                                          org.pac4j.core.profile.CommonProfile profile)

downloadFormRecordAttachments

@GET
@Path("/{formRecordUuid}/attachments/download")
@Produces({"application/vnd.xima.fc.api.rest.public+octet-stream; version=1.0; charset=utf-8","application/octet-stream; charset=utf-8"})
public javax.ws.rs.core.Response downloadFormRecordAttachments(@PathParam("formRecordUuid")
                                                               UUID formRecordUuid,
                                                               @Pac4JProfile
                                                               org.pac4j.core.profile.CommonProfile profile)

getFormRecordUserTriggers

@GET
@Path("/{formRecordUuid}/user-triggers")
public javax.ws.rs.core.Response getFormRecordUserTriggers(@PathParam("formRecordUuid")
                                                           UUID formRecordUuid,
                                                           @QueryParam("size") @DefaultValue("10")
                                                           int pageSize,
                                                           @QueryParam("page") @DefaultValue("1")
                                                           int page,
                                                           @Pac4JProfile
                                                           org.pac4j.core.profile.CommonProfile profile)

getSingleFormRecordUserTrigger

@GET
@Path("/{formRecordUuid}/tasks/{taskUuid}/triggers/{triggerUuid}")
@Produces({"application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8","application/json; charset=utf-8"})
public javax.ws.rs.core.Response getSingleFormRecordUserTrigger(@PathParam("formRecordUuid")
                                                                UUID formRecordUuid,
                                                                @PathParam("taskUuid")
                                                                UUID taskUuid,
                                                                @PathParam("triggerUuid")
                                                                UUID triggerUuid,
                                                                @Pac4JProfile
                                                                org.pac4j.core.profile.CommonProfile profile)

executeTrigger

@POST
@Path("/{formRecordUuid}/tasks/{taskUuid}/triggers/{triggerUuid}/execute")
public javax.ws.rs.core.Response executeTrigger(@PathParam("formRecordUuid")
                                                UUID formRecordUuid,
                                                @PathParam("taskUuid")
                                                UUID taskUuid,
                                                @PathParam("triggerUuid")
                                                UUID triggerUuid,
                                                @Pac4JProfile
                                                org.pac4j.core.profile.CommonProfile profile)