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) | 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>> |
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 | 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 |
|
flowName | String | The workflow name. |
cycle | String | The scheduling cycle.
|
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": "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"
}
]
}