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}/batch-processing-service/v2.1/flows

Request Parameters (URI)¶

Name	Location (Path/Query)	Required/Optional	Data Type	Description
userId	Query	Required	String	The user ID. How to get userId>>
orgId	Query	Required	String	The organization ID which the user belongs to. How to get orgId>>
expression	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	Required	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}/batch-processing-service/v2.1/flows?action=getMyFlow&expression={}&userId={}&orgId={}
method: GET

Return Sample¶

{
  "code": 0,
  "msg": "OK",
  "data": [
    {
      "flowId": "FLOW_001",
      "editable": true,
      "flowName": "data_processing",
      "cycle": "D"
    },
    {
      "flowId": "FLOW_002",
      "editable": true,
      "flowName": "data_mapping",
      "cycle": "D"
    },
    {
      "flowId": "FLOW_003",
      "editable": true,
      "flowName": "script_execution",
      "cycle": "D"
    },
    {
      "flowId": "FLOW_004",
      "editable": true,
      "flowName": "test_workflow",
      "cycle": "D"
    },
    {
      "flowId": "FLOW_005",
      "editable": true,
      "flowName": "batch_process",
      "cycle": "D"
    },
    {
      "flowId": "FLOW_006",
      "editable": true,
      "flowName": "data_integration",
      "cycle": "D"
    }
  ]
}