...
Code Block |
---|
200 OK <entry xmlns:fd="http://schemas.frevvo.com/fdata/2008"> <id>_w218Ecm4EdyRdaUav2cgrg!admin</id> <title type="text">Professional Blue</title> <updated>2010-04-28T18:01:00.838-04:00</updated> <link type="application/atom+xml" href="/frevvo/web/tn/d/api/theme/_w218Ecm4EdyRdaUav2cgrg!admin"/> <link rel="self" type="application/atom+xml" href="/frevvo/web/tn/d/api/theme/_w218Ecm4EdyRdaUav2cgrg!admin"/> <link rel="edit" type="application/atom+xml" href="/frevvo/web/tn/d/api/theme/_w218Ecm4EdyRdaUav2cgrg!admin"/> <fd:owner id="admin"/> </entry> |
Note |
---|
Note that for this release it It is not possible to download the theme using the Data API for this release: support for that will be added in a subsequent release. |
...
Code Block |
---|
200 OK <entry xmlns="http://www.w3.org/2005/Atom" xmlns:fd="http://schemas.frevvo.com/fdata/2008" xml:lang="en" xml:base="http://localhost:8082"> <id>_0vNZwD8KEd6yc_ZDP21S1Q!_nv8uAT8KEd6yc_ZDP21S1Q!johndoe</id> <title type="text">Expense Report</title> <summary type="text">Edit the form to change this description.</summary> <updated>2009-05-12T12:48:11.509-04:00</updated> <link type="application/atom+xml" href="/frevvo/web/api/formtype/_0vNZwD8KEd6yc_ZDP21S1Q!_nv8uAT8KEd6yc_ZDP21S1Q!johndoe"/> <link rel="self" type="application/atom+xml" href="/frevvo/web/api/formtype/_0vNZwD8KEd6yc_ZDP21S1Q!_nv8uAT8KEd6yc_ZDP21S1Q!johndoe"/> <link rel="edit" type="application/atom+xml" href="/frevvo/web/api/formtype/_0vNZwD8KEd6yc_ZDP21S1Q!_nv8uAT8KEd6yc_ZDP21S1Q!johndoe"/> <link rel="formtype" type="text/html" href="/frevvo/web/user/johndoe/app/_nv8uAT8KEd6yc_ZDP21S1Q/formtype/_0vNZwD8KEd6yc_ZDP21S1Q? embed=true&_method=post&apikey=1VeRclWJogwX2lUlGuLo9kglWN%252BUdNE9c9UGI6z7sJuRnYBOrCjoAdZ8kBVHKkZC9j5Ss%252BQYVwv%252BsIxsxTIAqg%253D%253D" title="Link to the FormType Expense Report HTML"/> <link rel="formtype" type="text/javascript" href="/frevvo/web/user/johndoe/app/_nv8uAT8KEd6yc_ZDP21S1Q/formtype/_0vNZwD8KEd6yc_ZDP21S1Q/embed? apikey=1VeRclWJogwX2lUlGuLo9kglWN%252BUdNE9c9UGI6z7sJuRnYBOrCjoAdZ8kBVHKkZC9j5Ss%252BQYVwv%252BsIxsxTIAqg%253D%253D" title="Link to Javascript code that can be used to embed this FormType in an HTML page"/> <link rel="controltypes" type="application/atom+xml" href="/frevvo/web/api/controltypes?ownerId=_0vNZwD8KEd6yc_ZDP21S1Q!_nv8uAT8KEd6yc_ZDP21S1Q!johndoe" title="Expense Report's Control Types"/> <link rel="formtype-editor" type="text/html" href="/frevvo/web/user/johndoe/app/_nv8uAT8KEd6yc_ZDP21S1Q/formtype/_0vNZwD8KEd6yc_ZDP21S1Q? edit=true&embed=true&_method=post&apikey=1VeRclWJogwX2lUlGuLo9kglWN%252BUdNE9c9UGI6z7sJuRnYBOrCjoAdZ8kBVHKkZC9j5Ss%252BQYVwv%252BsIxsxTIAqg%253D%253D" title="Link to the FormType Designer Expense Report HTML"/> <link rel="formtype-editor" type="text/javascript" href="/frevvo/web/user/johndoe/app/_nv8uAT8KEd6yc_ZDP21S1Q/formtype/_0vNZwD8KEd6yc_ZDP21S1Q/embed? edit=true&apikey=1VeRclWJogwX2lUlGuLo9kglWN%252BUdNE9c9UGI6z7sJuRnYBOrCjoAdZ8kBVHKkZC9j5Ss%252BQYVwv%252BsIxsxTIAqg%253D%253D" title="Link to Javascript code that can be used to embed this FormType in an HTML page"/> <link rel="submissions" type="text/html" href="/frevvo/web/user/johndoe/app/_nv8uAT8KEd6yc_ZDP21S1Q/formtype/_0vNZwD8KEd6yc_ZDP21S1Q/submission? embed=true&apikey=1VeRclWJogwX2lUlGuLo9kglWN%252BUdNE9c9UGI6z7sJuRnYBOrCjoAdZ8kBVHKkZC9j5Ss%252BQYVwv%252BsIxsxTIAqg%253D%253D" title="Use FormType Expense Report"/> <link rel="submissions" type="text/javascript" href="/frevvo/web/user/johndoe/app/_nv8uAT8KEd6yc_ZDP21S1Q/formtype/_0vNZwD8KEd6yc_ZDP21S1Q/embedsubs? apikey=1VeRclWJogwX2lUlGuLo9kglWN%252BUdNE9c9UGI6z7sJuRnYBOrCjoAdZ8kBVHKkZC9j5Ss%252BQYVwv%252BsIxsxTIAqg%253D%253D" title="Link to Javascript code that can be used to embed this FormType's submissions in an HTML page"/> <link rel="schema" type="application/xml" href="/frevvo/web/user/johndoe/app/_nv8uAT8KEd6yc_ZDP21S1Q/formtype/_0vNZwD8KEd6yc_ZDP21S1Q/schema"/> <fd:owner id="_nv8uAT8KEd6yc_ZDP21S1Q!johndoe"/> <fd:visibility value="public"/> <content type="application/zip" src="/frevvo/web/user/johndoe/app/_nv8uAT8KEd6yc_ZDP21S1Q/formtype/_0vNZwD8KEd6yc_ZDP21S1Q/file/content.zip"/> </entry> |
...
<pre></pre>
...
Updating a FormTypeEntry
...
Updating a form using the Data API is not supported at this point.=====
Deleting a FormTypeEntry
...
Deleting a form using the Data API can be done by sending an HTTP DELETE request to the form type entry url.<pre>
Code Block |
---|
DELETE /frevvo/web/tn/{tenantId}/api/formtype/{id} |
...
And the server will respond with:<pre>
Code Block |
---|
200 OK |
...
...
SchemaFeed
...
The schema feed represents each XML Schema visible to the current logged in user.
The schema feed lists all uploaded schemas that are visible to the currently logged-in user. This includes schemas that were uploaded by the current user and all global schemas owned by the administrator user.=====
Getting the SchemaFeed
...
In order to get a list of all schemas, send the following request to the frevvo server:<pre>
Code Block |
---|
GET /frevvo/web/tn/{tenantId}/api/schemas |
</pre>The server will respond with:<pre>
Code Block |
---|
200 OK |
...
<feed xmlns="http://www.w3.org/2005/Atom" xml:base="http://localhost:8082"> |
...
<title>Schemas</title> |
...
<updated>2008-06-25T16:27:26.833-04:00</updated> |
...
<link rel="self" type="application/atom+xml" href="/frevvo/web/api/schemas"/> |
...
<link rel="edit" type="application/atom+xml" href="/frevvo/web/api/schemas"/> |
...
<entry xmlns:fd="http://schemas.frevvo.com/fdata/2008"> |
...
<id>_HAKo4UL1Ed2aiOHUWaF_bw!_Fyz6YUL0Ed2aiOHUWaF_bw!johndoe</id> |
...
<title type="text">Purchase Order</title> |
...
<summary type="text">The Purchase Order Schema</summary> |
...
<updated>2008-06-25T16:27:26.833-04:00</updated> |
...
<link rel="self" type="application/atom+xml" |
...
href="/frevvo/web/api/schema/_HAKo4UL1Ed2aiOHUWaF_bw!_Fyz6YUL0Ed2aiOHUWaF_bw!johndoe"/> |
...
<link rel="edit" type="application/atom+xml" |
...
href="/frevvo/web/api/schema/_HAKo4UL1Ed2aiOHUWaF_bw!_Fyz6YUL0Ed2aiOHUWaF_bw!johndoe"/> |
...
<fd:owner id="_Fyz6YUL0Ed2aiOHUWaF_bw!johndoe"/> |
...
</entry> |
...
</feed> |
...
The returned feed above shows one schema entry named '''Purchase Order''' that that is owned by the current user.
Note |
---|
...
For this release schema feeds are read-only and so it is not possible to upload new schemas using the Data API. Support for that will be added in a subsequent release. |
=====
Getting a SchemaEntry
...
It is also possible to directly get a specific schema entry as long as you know the theme id. In order to do that send the following request to the server:<pre>
Code Block |
---|
GET /frevvo/web/tn/{tenantId}/api/schema/{id} |
...
And the server will respond with:<pre>
Code Block |
---|
<entry xmlns:fd="http://schemas.frevvo.com/fdata/2008"> |
...
<id>_HAKo4UL1Ed2aiOHUWaF_bw!_Fyz6YUL0Ed2aiOHUWaF_bw!johndoe</id> |
...
<title type="text">Purchase Order</title> |
...
<summary type="text">The Purchase Order Schema</ |
...
summary> <updated>2008-06-25T16:27:26.833-04:00</updated> |
...
<link rel="self" type="application/atom+xml" |
...
href="/frevvo/web/api/schema/_HAKo4UL1Ed2aiOHUWaF_bw!_Fyz6YUL0Ed2aiOHUWaF_bw!johndoe"/> |
...
<link rel="edit" type="application/atom+xml" |
...
href="/frevvo/web/api/schema/_HAKo4UL1Ed2aiOHUWaF_bw!_Fyz6YUL0Ed2aiOHUWaF_bw!johndoe"/> |
...
<fd:owner id="_Fyz6YUL0Ed2aiOHUWaF_bw!johndoe"/> |
...
</entry> |
...
Note |
---|
It is not possible to download the theme using the Data API for this release: support for that will be added in a subsequent release. |
...
Inserting a new SchemaEntry
...
Inserting XML Schemas using the Data API is not supported at this point.=====
Updating a SchemaEntry
...
Updating an existing schema using the Data API is not supported at this point.=====
Deleting a SchemaEntry
...
Deleting a schema using the Data API can be done by sending an HTTP DELETE request to the schema entry url.<pre>
Code Block |
---|
DELETE /frevvo/web/tn/{tenantId}/api/schema/{id} |
</pre>And the server will respond with:<pre>
Code Block |
---|
200 OK |
...
==== ControlTypeFeed ====
...