Versions Compared

Old Version 7

changes.mady.by.user Megan Ellis

Saved on

compared with

New Version Current

changes.mady.by.user Megan Ellis

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column

The Data API provides a simple protocol for viewing and managing resources such as forms, projects, styles, schemas, etc. The API extends the Google Data API framework, is HTTP and XML-based, and uses the Atom Syndication Format  with a few extensions following Atom's standard extension model. Java and .Net are the language-specific wrappers around the API.

Atom also provides the Atom Publishing Protocol (APP), an HTTP-based application protocol for publishing and editing resources on the web. The APP specification is an emerging standard being developed by the IETF that allows you to send an HTTP GET request to ask for a particular resource such as a form or schema; a representation of that resource is returned in the Atom Syndication format. You can also create, edit and delete resources using standard HTTP POST, PUT and DELETE methods, respectively. Atom provides a protocol in line with the REST approach to web service interfaces.

Note

In v9.1 and later 's "Applications" are known as "Projects." The API objects and methods still use the word Application.

Column
width240px

On this page:

Table of Contents
maxLevel2

...

  1. After logging in, edit the  URL in the browser address bar to insert api/formtypes immediately after the tenant name - which in this example is monahan.com.
  2. So in this example, we change the URL '' from: '' http://localhost:8082/frevvo/web/tn/monahan.com user/david/app
  3. toTo:  http://localhost:8082/frevvo/web/tn/monahan.com/api/formtypes, and press Enter.

...

This example shows how to use the controltypes feed to get a list of all the control types that belong to the currently logged-in user, regardless of which forms they 're are used in.

  1. After logging in, edit the  URL in the browser address bar to insert api/controltypes immediately after the tenant name - which in this example is monahan.com.
  2. So in In this example, we change the URL from: http://localhost:8082/frevvo/web/tn/monahan.com/user/david/app
  3. to: http://localhost:8082/frevvo/web/tn/monahan.com/api/controltypes, and press Enter.

...

This example shows how to use the controltypes?ownerId={formTypeId}  feed feed to get a list of the control types in a specific form - in this case the Address Book form in the example above.

...

The reset task API makes it possible to restart a completed submitted workflow. For example, imagine a sales person has reviewed a product order form on their task list and signed it and submitted it. This is the final form workflow step and the form is submitted to a document management system (ECM). All of the form data as well as and the PDF order form image is are stored in the ECM. While the order is processed someone notices that a product is out of stock and wants to return the order form back to the sales person's form workflow task list. The reset task API feature makes this possible. The demo.war contains a api/resetTask.jsp that demonstrates how to use this API feature: 

  1. Copy <frevvo-home>/ext/demo.war to <frevvo-home>/tomcat/webapps. It will auto-extract.
  2. Edit frevvo/tomcat/webapps/demo/api/resetTask.jsp
    1. Set the host:port to your frevvo server
    2. Set the username and password and tenant to the designer user how is the owner of the workflow you want to reset
  3. Enable the workflow's save property so the workflow data is stored in frevvo's submission repository. This is critial critical as frevvo needs to access this data in order to reset the workflow back to a task list.
  4. Restart the frevvo server.
  5. Use the workflow and complete/submit it.
    1. Save the frevvo.form.id POST parameter. It will be a GUID such as _udowHBy0EeCJpdjaAfsaSA  

...