Querying Flows

Function

This API is used to query flows by condition.

URI

GET Huawei Cloud Astro Zero domain name/u-route/baas/metadata/v1.0/Flow

Request Parameters

**Table 1** Request parameters
Parameter	Mandatory	Type	Description
like	No	String	Explanation If like is true, fuzzy match is used for names. Otherwise, exact match is used. Constraints None Value None Default value Exact match
name	No	String	Explanation Name of the flow, that is, the value of name in the request body when the flow is created in Creating a Flow. Constraints None Value None Default value None
processType	No	String	Explanation Type of the Flow instance. Constraints None Value Autolaunched Flow: a flow instance that is automatically started. After the API is called, the logic defined in the Flow model is immediately executed. Event Trigger: A flow that is triggered by an event. The logic defined in the flow model is executed only when the event is triggered. If this type is selected, you must configure events and condition rules. Default value None
active	No	String	Explanation Whether the flow is enabled. Constraints None Value None Default value None
baseline	No	String	Explanation Whether the Flow instance is preset in the system. Constraints None Value None Default value None
skip	No	String	Explanation ID of the first record from which the search starts. skip is greater than or equal to 0. Constraints None Value An integer greater than or equal to 0. Default value None
limit	No	String	Explanation The maximum number of records returned. limit is greater than or equal to 1. Constraints None Value An integer greater than or equal to 1. Default value None

Response Parameters

**Table 2** Response parameters
Parameter	Type	Description
resCode	String	Explanation Return code. Value If the request is successful, 0 is returned. For details about other error codes, see Error Codes.
resMsg	String	Explanation Message returned. Value If the request is successful, "Success" is returned. In other cases, an error message is returned.
result	array	Explanation If the operation is successful, the flow list that meet the conditions is returned.

Example Request

Query service orchestration instances by condition.

GET https://Huawei Cloud Astro Zero domain name/u-route/baas/metadata/v1.0/Flow?name=testName &processType=Autolaunched Flow&active=true

Example Response

{
    "resCode": "0",
    "resMsg": "Success",
    "result": [
        {
            "boID": null,
            "catalogue": "Out",
            "createdBy": "testUserId",
            "createdBy.__objectType": "User",
            "createdBy.name": "test0xx",
            "createdDate": "2019-08-04 16:21:58",
            "custom": true,
            "description": "Updated Description",
            "id": "000y000000aM8XixTN0S",
            "installedPackage": null,
            "lastModifiedBy": "testUserId",
            "lastModifiedBy.__objectType": "User",
            "lastModifiedBy.name": "test0xx",
            "lastModifiedDate": "2019-08-04 16:22:58",
            "name": "testName",
            "namespace": "testSpace",
            "owner": "testUserId",
            "owner.__objectType": "User",
            "owner.name": "test0xx",
            "protectMode": 0,
            "structMembers": [
                {
                    "createdBy": "testUserId",
                    "createdBy.__objectType": "User",
                    "createdBy.name": "test0xx",
                    "createdDate": "2019-08-04 16:21:58",
                    "currencyFactor": 1,
                    "custom": true,
                    "dataType": "text",
                    "defaultValue": null,
                    "defaultValueType": null,
                    "description": null,
                    "id": "000y000000bM2XixVA0P",
                    "ignoreNull": true,
                    "installedPackage": null,
                    "isCollection": true,
                    "isNested": false,
                    "lastModifiedBy": "testUserId",
                    "lastModifiedBy.__objectType": "User",
                    "lastModifiedBy.name": "test0xx",
                    "lastModifiedDate": "2019-08-04 16:21:58",
                    "name": "testName",
                    "namespace": null,
                    "owner": "testUserId",
                    "owner.__objectType": "User",
                    "owner.name": "test0xx",
                    "parent": "testId",
                    "parent.__objectType": "ExtStruct",
                    "parent.name": "TestName",
                    "picklistValues": null,
                    "protectMode": 0,
                    "required": true,
                    "structType": null
                }
            ]
        }
    ]
}