Flow
Each Flow that has been assigned is represented by a Flow Resource. It is the result of the POST request to the Flows Resource.
The following methods are supported: GET, PUT, DELETE.
GET /api/flows/flow-id/flow-version
Returns a Flow Object containing the last state of the Flow.
Example Request:
RequestResponse
GET http://<hostname>/api/flows/flow-id/flow-version
Host: hostname
Accept: application/json/json
Example Response:
RequestResponse
HTTP/1.1 200 OK
Content-Length: content length
Content-Type: application/json; charset=utf-8
{
"flow": ...
}
PUT /api/flows/flow-id/flow-version
Updates the Flow to reflect the updated state passed by the Agent as a Flow Object in the body.
Example Request:
RequestResponse
PUT http://<hostname>/api/flows/flow-id/flow-version
Host: hostname
Content-Type: application/json
{
"flow": ...
}
Example Response
RequestResponse
HTTP/1.1 204 No Content
DELETE /api/flows/flow-id/flow-version
Yields the specified Flow. After this request has completed succesfully, the Flow is no longer available using this resource.
Example Request:
RequestResponse
DELETE http://<hostname>/api/flows/flow-id/flow-version
Host: hostname
Example Response:
RequestResponse
HTTP/1.1 204 No Content