Search Flow¶
Search the basic information of workflows that meet the search criteria (including workflows of other users in the organization (OU)).
Prerequisite¶
The user must belong to the OU which the target workflows belong to.
Request Format¶
POST 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>> |
| action | Query | Mandatory | String | Fixed value: search |
Request Parameters (Body)¶
| Name | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| expression | 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). |
| pagination | Mandatory | Pagination Struct | Lists the paging requirements in a request. For more details, see Pagination Struct |
Pagination Struct¶
Sample¶
{
"pagination": {
"pageNo": 1,
"pageSize": 10,
"sorters": [{
"field": "start_time",
"order": "ASC"
}]
}
}
Parameters¶
| Name | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| pageNo | Mandatory | Integer | The request pages, starting from 1. |
| pageSize | Mandatory | Integer | The number of records in each page, which must be greater than 0. For optimal performance, it is recommended to have not more than 50 records per page. |
| sorters | Optional | jsonArray | The pagination sorting method.(The sorters struct contains two fields: sorter.field and sorter.order, see the sorters parameter below for details.) |
sorters¶
| Name | Mandatory/Optional | Data Type | Description |
|---|---|---|---|
| field | Mandatory | String | The pagination field name. Supported fields are: create_time, update_time, start_time. |
| order | Optional | String |
|
Response Parameters¶
| Name | Data Type | Description |
|---|---|---|
| data | Array of PageFlow Structs | The list of PageFlow structs, which contain the basic information of searched workflows. For more details, see PageFlow Struct |
Error Code¶
See Common Error Codes.
Samples¶
Request Sample¶
url: https://{apigw-address}/batch-processing-service/v2.1/flows?action=search&userId=yourUserId&orgId=yourOrgId
method: POST
requestBody:
{
"expression": "",
"pagination":{
"pageNo": 1,
"pageSize": 10,
"sorters": [{
"field": "update_time",
"order": "ASC"
}]
}
}
Return Sample¶
{
"code": 0,
"msg": "OK",
"data": [
{
"flowId": "20",
"flowName": "vd_text"
},
{
"flowId": "21",
"flowName": "dim_wtg_full"
},
{
"flowId": "22",
"flowName": "wenl_dim_fact_downtime"
}
]
}