Load Flow For Edit¶
Load the specified workflow to a temporary workflow to get the workflow information.
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 |
|---|---|---|---|---|
flowId |
Query |
Required |
Integer |
The workflow ID. |
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>> |
action |
Query |
Required |
String |
Fixed value: loadForEdit |
Response Parameters¶
For more information, see Flow Struct
Error Code¶
See Common Error Codes.
Samples¶
Request Sample¶
url: https://{apigw-address}/batch-processing-service/v2.1/flows?action=loadForEdit&flowId=2791&userId=yourUserId&orgId=yourOrgId
method: GET
Return Sample¶
url: https://{apigw-address}/batch-processing-service/v2.1/flows?action=loadForEdit&flowId=2515&userId={}&orgId={}
method: GET
返回示例¶
{
"code": 0,
"msg": "OK",
"data": {
"virtual": false,
"freq": "0 0 0 * * ? *",
"type": 1,
"cycle": "D",
"alertMode": 3,
"hasEditPri": true,
"startTime": "2019-07-23",
"locked": false,
"flowId": 2515,
"owner": "yourOwners",
"creator": "yourCreator",
"updateUser": "yourUpdateUser",
"active": 0,
"updateTime": "2019-08-08 05:51:43.0",
"flowName": "fpostm",
"graph": "{\"creator\":\"yourCreator\",\"freq\":\"0 0 0 * * ? *\",\"alert_mode\":3,\"active\":0,\"owners\":\"yourOwners\",\"type\":1,\"cycle\":\"D\",\"start_time\":\"2019-07-23\",\"visitors\":\"yourVisitors\",\"do_as\":\"yourDaAs\",\"flows\":[{\"is_virtual\":false,\"flow_id\":\"2788\",\"x\":0.0186,\"flow_name\":\"jin\",\"y\":0.0016999999046325683,\"node_id\":\"f_2788\"},{\"is_virtual\":true,\"flow_id\":\"2819\",\"x\":8.0E-4,\"flow_name\":\"104891(tass)\",\"y\":0.022100001525878907,\"node_id\":\"f_2819\"}],\"name\":\"fpostm\",\"relations\":[{\"cycle_gap\":\"D0\",\"source\":\"t_104575\",\"rerun\":true,\"target\":\"t_104590\"},{\"cycle_gap\":\"D0\",\"source\":\"f_2788\",\"rerun\":false,\"target\":\"t_104575\"},{\"cycle_gap\":\"D0\",\"source\":\"f_2819\",\"rerun\":false,\"target\":\"t_104590\"}],\"parameters\":\"[]\",\"queue\":\"\",\"tasks\":[{\"task_name\":\"tass\",\"x\":0.0132,\"y\":0.008100000381469727,\"task_id\":\"104575\",\"node_id\":\"t_104575\"},{\"task_name\":\"gg\",\"x\":0.0084,\"y\":0.014199999237060546,\"task_id\":\"104590\",\"node_id\":\"t_104590\"}],\"desc\":\"e\"}",
"isUserLocked": false,
"entry": 1,
"doAs": "your_bd_account",
"createTime": "2019-07-26 05:41:58.0",
"syncType": 1,
"visitor": "yourVisitors",
"parameters": "[]",
"queue": "",
"hasReadPri": true,
"desc": "e"
}
}