Help Center/ Huawei Cloud Astro Zero/ API Reference/ APIs/ BPMs/ Querying BPMs by Condition

Updated on 2025-08-14 GMT+08:00

View PDF

Querying BPMs by Condition

Function

This API is used to obtain the BPM list that matches the query criteria.

URI

GET Huawei Cloud Astro Zero domain name/u-route/baas/bp/v2.0/metadata/definitions

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 is used by default.
name	No	String	Explanation BPM name. Constraints None Value None Default value None
active	No	String	Explanation Whether the BPM is activated. 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 None Default value None
limit	No	String	Explanation The maximum number of records returned. limit is greater than or equal to 1. Constraints None Value None 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 request is successful, the BPM instances that meet the conditions are returned.

Example Request

To query BPM instances by condition, send the following request:

GET https://Huawei Cloud Astro Zero domain name/u-route/baas/bp/v2.0/metadata/definitions?name=BP&active=false

Example Response

{
    "resCode": "0",
    "resMsg": "Success",
    "result": [
        {
            "active": false,
            "config": "{\"cancelable\":false,\"noCancelAfterElem\":\"\",\"noCancelAfterElemLabel\":\"\"}",
            "description": "",
            "id": "001L000000Peuw1Q318a",
            "label": "SimpleBP",
            "name": "SimpleBP",
            "status": "Warning",
            "version": "1.0.1"
        }
    ]
}