API Documentation‎ > ‎Actions‎ > ‎Flow‎ > ‎

List

Contents

  1. 1 Description
  2. 2 ActionUrl
  3. 3 Request Parameter
  4. 4 Response Elements
  5. 5 Examples


Description

Lists all available Flow Graph  

Request Method    
GET

ActionUrl

/api/v1/flow

Request Parameter

 Name Description Required
 


Response Elements

 NameDescription 
  responseresponse status of the request
  data a list of available Flow Graph
 data[].uuid uuid of the Flow, this should be used to get the details of the Flow.
 data[].name the name of the Flow in the list.

Examples

Example Request

URL:
http://localhost:8080/api/v1/flow

Example Response
{
        "response" : {
                "status" : "ok",
                "message" : "",
                "requestID" : "b0921c50-4b31-11e1-8039-0023ae8ddf40"
        },
        "data" : [
                {
                        "uuid" : "afb86fb9-b0d4-4897-a34b-aa4859820851",
                        "name" : "simple copy"
                },
                {
                        "uuid" : "5b7c98b3-a28c-4c55-bf8b-3ba13b25e05f",
                        "name" : "new shiny encoding flow"
                }
              ]
}

Related Operations


Comments