@Path(value="form")
public interface FormResource
| Modifier and Type | Method and Description |
|---|---|
FormResponse |
create(FormModel form)
Create a new form in the folder
|
GenericResponse |
delete(String formId)
Delete a form
|
javax.ws.rs.core.Response |
deleteData(String formId,
String dataId)
Permanently delete a single data entry from Mesh, which has been submitted to the form
|
javax.ws.rs.core.Response |
downloadDataBinaries(String formId)
Download binary data from Mesh, which has been submitted to the form
|
javax.ws.rs.core.Response |
downloadDataBinaryField(String formId,
String dataId,
String field)
Download the binary data for a single field in a data entry
|
javax.ws.rs.core.Response |
exportData(String formId,
FormDataExportParameterBean exportFormat,
FilterFormDataParameterBean filter)
Export data from Mesh, which has been submitted to the form
|
FormResponse |
get(String formId,
String stagingPackageName)
Load a form
|
javax.ws.rs.core.Response |
getData(String formId,
String dataId)
Load a single data entry from Mesh, which has been submitted to the form
|
PageUsageListResponse |
getPageUsageInfo(Integer skipCount,
Integer maxItems,
String sortBy,
String sortOrder,
List<Integer> formId,
Integer nodeId,
boolean returnPages,
PageModelParameterBean pageModel)
Get the pages using one of the given forms
|
TemplateUsageListResponse |
getTemplateUsageInfo(Integer skipCount,
Integer maxItems,
String sortBy,
String sortOrder,
List<Integer> formId,
Integer nodeId,
boolean returnTemplates)
Get the templates using one of the given forms
|
TotalUsageResponse |
getTotalUsage(List<Integer> formId,
Integer nodeId)
Get the total usage information of the given forms.
|
FormResponse |
getVersion(String formId,
String version)
Load a version of a form
|
FormListResponse |
list(InFolderParameterBean inFolder,
FilterParameterBean filter,
SortParameterBean sorting,
PagingParameterBean paging,
WastebinParameterBean wastebin,
PublishableParameterBean publishable)
List forms.
The result can be filtered by id
name
description
and sorted by
id
name
description
|
javax.ws.rs.core.Response |
listData(String formId,
FilterFormDataParameterBean filter,
PagingParameterBean paging)
List data entries from Mesh, which have been submitted to the form
|
ItemVersionListResponse |
listVersions(String formId)
Get the versions of a form
|
FormResponse |
lock(String formId)
Lock the form
|
FormResponse |
move(String formId,
String folderId)
Move the form to the given folder
|
String |
preview(String formId,
String language)
Render a preview of the form in the given language
|
String |
preview(String formId,
String language,
FormModel formModel)
Render a preview of the form in the given language
|
FormResponse |
publish(String formId,
int at,
boolean keepVersion)
Publish a form
|
GenericResponse |
removeFromWastebin(String formId)
Remove a form from the wastebin
|
FormResponse |
removeOfflineAt(String formId)
Remove the time for scheduled taking offline
|
FormResponse |
removePublishAt(String formId)
Remove the time for scheduled publishing
|
FormResponse |
restoreFromWastebin(String formId)
Restore a form from the wastebin
|
FormResponse |
restoreVersion(String formId,
String version)
Restore a version of the form
|
FormResponse |
takeOffline(String formId,
int at)
Take a form offline
|
FormResponse |
unlock(String formId)
Unlock the form
|
FormResponse |
update(String formId,
FormModel form)
Update a form
|
@GET FormListResponse list(@BeanParam InFolderParameterBean inFolder, @BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging, @BeanParam WastebinParameterBean wastebin, @BeanParam PublishableParameterBean publishable) throws Exception
idnamedescriptionidnamedescriptioninFolder - parameter beanfilter - parameter beansorting - parameter beanpaging - parameter beanwastebin - parameter beanpublishable - parameter beanException@POST FormResponse create(FormModel form) throws Exception
form - formException@GET
@Path(value="{id}")
FormResponse get(@PathParam(value="id")
String formId,
@QueryParam(value="package")
String stagingPackageName)
throws Exception
formId - form IDstagingPackageName - name of a content staging package, to check the form status in the packageException@PUT
@Path(value="{id}")
FormResponse update(@PathParam(value="id")
String formId,
FormModel form)
throws Exception
formId - form IDform - form data to updateException@DELETE
@Path(value="{id}")
GenericResponse delete(@PathParam(value="id")
String formId)
throws Exception
formId - form IDException@PUT
@Path(value="{id}/online")
FormResponse publish(@PathParam(value="id")
String formId,
@QueryParam(value="at") @DefaultValue(value="0")
int at,
@QueryParam(value="keepVersion") @DefaultValue(value="false")
boolean keepVersion)
throws Exception
formId - form IDat - timestamp for scheduled publishing (0 for publishing immediately)keepVersion - true to keep the currently scheduled version (if "at" is not 0 and a form version is currently scheduled to be published)Exception@DELETE
@Path(value="{id}/online")
FormResponse takeOffline(@PathParam(value="id")
String formId,
@QueryParam(value="at") @DefaultValue(value="0")
int at)
throws Exception
formId - form IDat - timestamp for scheduled taking offline (0 for taking offline immediately)Exception@DELETE
@Path(value="{id}/publish/at")
FormResponse removePublishAt(@PathParam(value="id")
String formId)
throws Exception
formId - form IDException@DELETE
@Path(value="{id}/offline/at")
FormResponse removeOfflineAt(@PathParam(value="id")
String formId)
throws Exception
formId - form IDException@PUT
@Path(value="{id}/lock")
FormResponse lock(@PathParam(value="id")
String formId)
throws Exception
formId - form IDException@DELETE
@Path(value="{id}/lock")
FormResponse unlock(@PathParam(value="id")
String formId)
throws Exception
formId - form IDException@GET
@Path(value="{id}/version")
ItemVersionListResponse listVersions(@PathParam(value="id")
String formId)
throws Exception
formId - form IDException@GET
@Path(value="{id}/version/{version}")
FormResponse getVersion(@PathParam(value="id")
String formId,
@PathParam(value="version")
String version)
throws Exception
formId - form IDversion - version numberException@POST
@Path(value="{id}/version/{version}/restore")
FormResponse restoreVersion(@PathParam(value="id")
String formId,
@PathParam(value="version")
String version)
throws Exception
formId - form IDversion - version numberException@DELETE
@Path(value="wastebin/{id}")
GenericResponse removeFromWastebin(@PathParam(value="id")
String formId)
throws Exception
formId - form IDException@POST
@Path(value="wastebin/{id}/restore")
FormResponse restoreFromWastebin(@PathParam(value="id")
String formId)
throws Exception
formId - form IDException@PUT
@Path(value="{id}/folder/{folderId}")
FormResponse move(@PathParam(value="id")
String formId,
@PathParam(value="folderId")
String folderId)
throws Exception
formId - form IDfolderId - target folder IDException@GET
@Path(value="{id}/preview/{language}")
@Produces(value="text/html")
String preview(@PathParam(value="id")
String formId,
@PathParam(value="language")
String language)
throws Exception
formId - form IDlanguage - language codeException@POST
@Path(value="{id}/preview/{language}")
@Produces(value="text/html")
String preview(@PathParam(value="id")
String formId,
@PathParam(value="language")
String language,
FormModel formModel)
throws Exception
formId - form IDlanguage - language codeformModel - form modelException@GET
@Path(value="{id}/data")
javax.ws.rs.core.Response listData(@PathParam(value="id")
String formId,
@BeanParam
FilterFormDataParameterBean filter,
@BeanParam
PagingParameterBean paging)
throws Exception
formId - form IDfilter - parameter beanpaging - parameter beanException@GET
@Path(value="{id}/data/{dataId}")
javax.ws.rs.core.Response getData(@PathParam(value="id")
String formId,
@PathParam(value="dataId")
String dataId)
throws Exception
formId - form IDException@DELETE
@Path(value="{id}/data/{dataId}")
javax.ws.rs.core.Response deleteData(@PathParam(value="id")
String formId,
@PathParam(value="dataId")
String dataId)
throws Exception
formId - form IDException@GET
@Path(value="{id}/data/{dataId}/binary/{field}")
@Produces(value="*/*")
javax.ws.rs.core.Response downloadDataBinaryField(@PathParam(value="id")
String formId,
@PathParam(value="dataId")
String dataId,
@PathParam(value="field")
String field)
throws Exception
formId - form IDdataId - data ID (uuid of the data node in Mesh)field - field nameException@GET
@Path(value="{id}/export")
javax.ws.rs.core.Response exportData(@PathParam(value="id")
String formId,
@BeanParam
FormDataExportParameterBean exportFormat,
@BeanParam
FilterFormDataParameterBean filter)
throws Exception
formId - form IDexportFormat - parameter beanfilter - filter beanException@GET
@Path(value="{id}/binaries")
@Produces(value="application/zip")
javax.ws.rs.core.Response downloadDataBinaries(@PathParam(value="id")
String formId)
throws Exception
formId - form IDException@GET @Path(value="/usage/total") TotalUsageResponse getTotalUsage(@QueryParam(value="id") List<Integer> formId, @QueryParam(value="nodeId") Integer nodeId) throws Exception
formId - list of form IDsnodeId - ID of the nodeException@GET @Path(value="/usage/page") PageUsageListResponse getPageUsageInfo(@QueryParam(value="skipCount") @DefaultValue(value="0") Integer skipCount, @QueryParam(value="maxItems") @DefaultValue(value="-1") Integer maxItems, @QueryParam(value="sortby") @DefaultValue(value="name") String sortBy, @QueryParam(value="sortorder") @DefaultValue(value="asc") String sortOrder, @QueryParam(value="id") List<Integer> formId, @QueryParam(value="nodeId") Integer nodeId, @QueryParam(value="pages") @DefaultValue(value="true") boolean returnPages, @BeanParam PageModelParameterBean pageModel) throws Exception
skipCount - number of items to be skipped, set to 0 for skipping no
itemsmaxItems - maximum number of items to be returned, set to -1 for
returning all itemssortBy - (optional) attribute to sort by. defaults to namesortOrder - (optional) result sort order - may be "asc" for ascending
or "desc" for descending other strings will be ignored.
defaults to "asc".formId - list of form IDs, for which the usage shall be fetchednodeId - ID of the nodereturnPages - true (default) if the pages shall be returned, false for
only returning the countspageModel - page model parametersException@GET @Path(value="/usage/template") TemplateUsageListResponse getTemplateUsageInfo(@QueryParam(value="skipCount") @DefaultValue(value="0") Integer skipCount, @QueryParam(value="maxItems") @DefaultValue(value="-1") Integer maxItems, @QueryParam(value="sortby") @DefaultValue(value="name") String sortBy, @QueryParam(value="sortorder") @DefaultValue(value="asc") String sortOrder, @QueryParam(value="id") List<Integer> formId, @QueryParam(value="nodeId") Integer nodeId, @QueryParam(value="templates") @DefaultValue(value="true") boolean returnTemplates) throws Exception
skipCount - number of items to be skipped, set to 0 for skipping
no itemsmaxItems - maximum number of items to be returned, set to -1 for
returning all itemssortBy - (optional) attribute to sort by. defaults to namesortOrder - (optional) result sort order - may be "asc" for
ascending or "desc" for descending other strings will
be ignored. defaults to "asc".formId - list of form ids, for which the usage shall be fetchednodeId - id of the nodereturnTemplates - true (default) if the templates shall be returned,
false for only returning the countsExceptionCopyright © 2024 Gentics Software. All rights reserved.