Get My Flow¶

Search workflows that meet the search criteria.

Prerequisite¶

The user must belong to the organization (OU) which the target workflow belongs to.

Request Format¶

GET https://{apigw-address}/dataflow-batch-service/v2.0/flows

Request Parameters (URI)¶

Name	Location (Path/Query)	Mandatory/Optional	Data Type	Description
userId	Query	Mandatory	String	The user ID. How to get userId>>
orgId	Query	Mandatory	String	The organization ID which the user belongs to. How to get orgId>>
searchValue	Query	Optional	String	The search criteria, supporting fuzzy matching query for the `flowId` and `flowName` parameters (if not specified, all workflows related to the user will be returned).
action	Query	Mandatory	String	Fixed value: getMyFlow

Response Parameters¶

Name	Data Type	Description
data	Array of FlowSimpInfo Structs	The list of searched workflows, with each element representing a FlowSimpleInfo Struct, which contains the basic information of a workflow.

FlowSimpleInfo Struct¶

Sample¶

{
    "flowId": "2526",
    "editable": true,
    "flowName": "testIns",
    "cycle": "mi"
}

Parameters¶

Name	Data Type	Description
flowId	String	The workflow ID.
editable	Boolean	true = the workflow is editable false = the workflow is not editable
flowName	String	The workflow name.
cycle	String	The scheduling cycle. M: Month W: Week D: Day H: Hour mi: Minute

Error Code¶

See Common Error Codes.

Samples¶

Request Sample¶

url: https://{apigw-address}/dataflow-batch-service/v2.0/flows?action=getMyFlow&searchValue={}&userId={}&orgId={}
method: GET

Return Sample¶

{
    "status": 0,
    "msg": "Success",
    "data": [
        {
            "flowId": "3318",
            "editable": true,
            "flowName": "reduce_entity",
            "cycle": "D"
        },
        {
            "flowId": "2809",
            "editable": true,
            "flowName": "map",
            "cycle": "D"
        },
        {
            "flowId": "3257",
            "editable": true,
            "flowName": "shell",
            "cycle": "D"
        },
        {
            "flowId": "2515",
            "editable": true,
            "flowName": "testWorkflow122",
            "cycle": "D"
        },
        {
            "flowId": "2980",
            "editable": true,
            "flowName": "8",
            "cycle": "D"
        },
        {
            "flowId": "2979",
            "editable": true,
            "flowName": "integrattt",
            "cycle": "D"
        }
    ]
}