Apps¶

Important

The API is a work in progress. GET requests have been implemented in the current version, but POST, UPDATE, and DELETE support is not yet complete.

Get list of applications¶

Description¶

This endpoint returns a list of all applications existing on the specified domain.

Request¶

GET /liveforms/api/domains/{domain}/apps

Parameter	Description
domain	The name of a domain

Response¶

Possible HTTP response codes:

Code	Description
200 OK	Success
401 UNAUTHORIZED	The username/password used for authentication was invalid.
404 NOT FOUND	The specified domain does not exist.
500 SERVER ERROR	The request failed due to an internal server error.

If the request is successful, a JSON (default) or XML payload will be returned containing the requested information.

Example JSON response

{
   "title": "Applications",
   "link": {
      "rel": "self",
      "href": "/liveforms/api/domains/demo/apps"
   },
   "entry": [{
      "id": "1",
      "name": "App 1",
      "description": "This is a demo app",
      "link": [{
            "rel": "self",
            "href": "/liveforms/api/domains/demo/apps/1"
         },
         {
            "rel": "forms",
            "href": "/liveforms/api/domains/demo/apps/1/forms"
         },
         {
            "rel": "flows",
            "href": "/liveforms/api/domains/demo/apps/1/flows"
         }
      ]
   }]
}

Example XML response

<?xml version="1.0" encoding="UTF-8"?>
<feed>
   <title>Applications</title>
   <link rel="self" href="/liveforms/api/domains/demo/apps"/>
   <entry>
      <id>1</id>
      <name>App 1</name>
      <description>This is a demo app</description>
      <link rel="self" href="/liveforms/api/domains/demo/apps/1"/>
      <link rel="forms" href="/liveforms/api/domains/demo/apps/1/forms"/>
      <link rel="flows" href="/liveforms/api/domains/demo/apps/1/flows"/>
   </entry>
</feed>

Get application by ID¶