Flows

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 flows

Description

This endpoint returns a list of all flows existing in an application on the specified domain.

Request

GET /liveflows/api/domains/{domain}/apps/{appliation_id}/flows

Parameter

Description

domain

The name of a valid domain which the authenticated user has access to.

application_id

The id of an application in the 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 or application 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": "Flows",
   "link": {
      "rel": "self",
      "href": "/liveflows/api/domains/demo/apps/1/flows"
   },
   "entry": [{
      "id": "1",
      "name": "Flow 1",
      "description": "This is a demo flow",
      "modified": "2017-01-01 13:00:00",
      "link": [{
            "rel": "self",
            "href": "/liveflows/api/domains/demo/apps/1/flows/1"
         }
      ]
   }]
}

Example XML response

<?xml version="1.0" encoding="UTF-8"?>
<feed>
   <title>Flows</title>
   <link rel="self" href="/liveflows/api/domains/demo/apps/1/flows"/>
   <entry>
      <id>1</id>
      <name>Flow 1</name>
      <description>This is a demo flow</description>
      <modified>2017-01-01 13:00:00</modified>
      <link rel="self" href="/liveflows/api/domains/demo/apps/1/flows/1"/>
   </entry>
</feed>

Get flow by ID

Description

This endpoint returns information representing the requested flow provided the authenticated user has access to it.

Request

GET /liveflows/api/domains/{domain}/apps/{application_id}/flows/{flow_id}

Parameter

Description

domain

The name of a valid domain which the authenticated user has access to.

application_id

The id of an application in the domain.

flow_id

The id of an flow in the application.

Response

Possible HTTP response codes:

Code

Description

200 OK

Success

401 UNAUTHORIZED

The username/password used for authentication was invalid.

403 FORBIDDEN

The authenticated user does not have permission to access this flow.

404 NOT FOUND

The domain, application, or flow 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

{
   "id": "1",
   "name": "Flow 1",
   "description": "This is a demo flow",
   "modified": "2017-01-01 13:00:00",
   "link": [{
         "rel": "self",
         "href": "/liveflows/api/domains/demo/apps/1/flows/1"
      }
   ]
}

Example XML response

<?xml version="1.0" encoding="UTF-8"?>
<entry>
   <id>1</id>
   <name>Flow 1</name>
   <description>This is a demo flow</description>
   <modified>2017-01-01 13:00:00</modified>
   <link rel="self" href="/liveflows/api/domains/demo/apps/1/flows/1"/>
</entry>