logo
logo

Flows Resource

The Flows resource is the first endpoint for the Agent.

Only the POST method is supported.

POST /api/flows

Asks the Orchestrator for a new Flow to process. Returns Location header for the newly created Flow resource and a Flow Object with the contents of that Flow resource.

Example Request:

GET http://<hostname>/api/flows
Host: hostname
Accept: application/json

```json
{

}

This action is returning the number of flows that are pending and also the flows in progress.

Example Response:

HTTP/1.1 201 Created
Content-Length: content length
Content-Type: application/json; charset=utf-8
Location: http://<hostname>/api/flows/flow-id/flow-version

```json
{
    "flows_pending": 0,
    "flows_in_progress": 0,
    "self": {
        "href": "http://processing-api.customer.com:82/api/flows"
        }
}

Can we improve this article ? Provide feedback