Creating a BPM Instance

Updated on 2025-03-21 GMT+08:00

View PDF

Function

This API is used to create a BPM instance.

URI

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

Request Parameters

**Table 1** Request parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Explanation Name of a BPM instance. Constraints None Value range Start with a letter and can contain only letters, digits, and single underscores (_). There is no consecutive underscore (_) and the value cannot end with an underscore (_). A maximum of 64 characters are allowed. Default value None
label	Yes	String	Explanation Label of the BPM instance. Constraints None Value 1–80 characters Default value None
description	No	String	Explanation BPM description. Constraints None Value None Default value None
version	No	String	Explanation Version. Constraints None Value None Default value None
instanceLabel	No	String	Explanation Label of the BPM instance, which can contain system variables. Constraints None Value None Default value None
laneSet	No	object	Explanation Lanes. Constraints None
config	No	object	Explanation Configuration information. Constraints None
startEvents	No	Array of object	Explanation Start events. Constraints None
dataMappers	No	Array of object	Explanation Data mappings. Constraints None
userTasks	No	Array of object	Explanation User tasks. Constraints None
serviceTasks	No	Array of object	Explanation Service tasks. Constraints None
businessRuleTasks	No	Array of object	Explanation Business rule tasks. Constraints None
callActivities	No	Array of object	Explanation Call activities. Constraints None
subProcesses	No	Array of object	Explanation Embedded subprocesses. Constraints None
throwEvents	No	Array of object	Explanation Events to throw. Constraints None
catchEvents	No	Array of object	Explanation Events to catch. Constraints None
exclusiveGateways	No	Array of object	Explanation Exclusive gateways. Constraints None
parallelGateways	No	Array of object	Explanation Parallel gateways. Constraints None
eventGateways	No	Array of object	Explanation Event gateways. Constraints None
usingSLA	No	Array of object	Explanation SLA referenced by the BPM instance. Constraints None
slas	No	Array of object	Explanation SLA. Constraints None
constants	No	Array of object	Explanation Constants. Constraints None
variables	No	Array of object	Explanation Variables. Constraints 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	Object	Explanation If the request is successful, an ID of the BPM instance is returned. If the request fails, an error and alarm information is returned.

Example Request

To create a BPM instance, send the following request:

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

{
    "config": {
        "cancelable": false,
        "noCancelAfterElem": ""
    },
    "dataMappers": [
        {
            "assignmentItems": [
                {
                    "assignTo": "dateList",
                    "name": "",
                    "operator": "add",
                    "value": "2019-03-04",
                    "valueType": ""
                },
                {
                    "assignTo": "dateList",
                    "name": "",
                    "operator": "add",
                    "value": "2020-01-02",
                    "valueType": ""
                }
            ],
            "connector": "userTask",
            "connectorPoint": "{\"fromPort\":\"R1\",\"toPort\":\"L1\",\"points\":[\"619 125\",\"643 125\",\"662.5 125\",\"662.5 100\",\"682 100\",\"706 100\"]}",
            "description": "",
            "label": "Data Mapper",
            "locationX": 575,
            "locationY": 125,
            "name": "dataMapper",
            "connectors": []
        }
    ],
    "description": "",
    "label": "SimpleBP",
    "laneSet": {
        "label": "",
        "lanes": [
            {
                "elements": [
                    "userTask",
                    "userTask1",
                    "dataMapper",
                    "start"
                ],
                "height": 201.35220031738282,
                "label": "lane",
                "name": "lane",
                "role": "LoanRequest.Applicant",
                "width": 1080
            }
        ],
        "name": ""
    },
    "name": "SimpleBP",
    "slas": [
        {
            "active": true,
            "criteria": "",
            "deadlineDays": 0,
            "deadlineHours": 0,
            "deadlineIncreaseUrgencyBy": 2,
            "deadlineMinutes": 0,
            "deadlineOnlyBusinessDays": false,
            "goalActions": [
                {
                    "action": "",
                    "criteria": "{!IsMatched} && {!Owner}",
                    "name": "sla-act",
                    "type": "Notify Manager"
                }
            ],
            "goalDays": 0,
            "goalHours": 0,
            "goalIncreaseUrgencyBy": 1,
            "goalMinutes": 0,
            "goalOnlyBusinessDays": false,
            "label": "userTask1_sla",
            "name": "userTask1_sla",
            "startWhen": "",
            "variable": "",
            "actions": []
        },
        {
            "active": true,
            "criteria": "",
            "deadlineDays": 0,
            "deadlineHours": 0,
            "deadlineIncreaseUrgencyBy": 2,
            "deadlineMinutes": 0,
            "deadlineOnlyBusinessDays": false,
            "goalActions": [
                {
                    "action": "NotifyBPManager",
                    "criteria": "",
                    "name": "sla-act1",
                    "type": "Notify Manager"
                }
            ],
            "goalDays": 1,
            "goalHours": 0,
            "goalIncreaseUrgencyBy": 1,
            "goalMinutes": 0,
            "goalOnlyBusinessDays": false,
            "label": "userTask_sla",
            "name": "userTask_sla",
            "startWhen": "",
            "variable": "",
            "actions": []
        }
    ],
    "startEvents": [
        {
            "connector": "dataMapper",
            "connectorPoint": "{\"fromPort\":\"R1\",\"toPort\":\"L0\",\"points\":[\"151.5 100\",\"175.5 100\",\"341.25 100\",\"341.25 110.5\",\"507 110.5\",\"531 110.5\"]}",
            "label": "Start",
            "locationX": 125,
            "locationY": 100,
            "name": "start",
            "type": "Start",
            "startType": "",
            "renderType": "",
            "render": "",
            "document": "",
            "description": ""
        }
    ],
    "startStage": null,
    "startType": "",
    "status": "Warning",
    "status.name": "Warning",
    "userTasks": [
        {
            "approvalType": "Single",
            "connector": "userTask1",
            "connectorPoint": "{\"fromPort\":\"R1\",\"toPort\":\"L1\",\"points\":[\"794 100\",\"818 100\",\"875 100\",\"875 100\",\"932 100\",\"956 100\"]}",
            "description": "wuli desc",
            "groupAsSingleParticipant": false,
            "inputAssignments": [
                {
                    "input": "$Task.Title",
                    "name": "",
                    "value": "{!$GlobalConstant.EmptyString}",
                    "valueType": ""
                }
            ],
            "label": "User Task",
            "locationX": 750,
            "locationY": 100,
            "name": "userTask",
            "participants": [
                {
                    "type": "user",
                    "value": "ecommerce6"
                }
            ],
            "preActions": [
                {
                    "action": "{!$GlobalConstant.EmptyString}",
                    "criteria": "",
                    "name": "action",
                    "type": "Set Status"
                }
            ],
            "render": "SimpleBP$Form1$form",
            "renderType": "Form",
            "routeType": "Name and Expressions",
            "router": {
                "defaultRouteTo": "",
                "defaultRouteType": "",
                "name": ""
            },
            "title": "wu li tu cao",
            "usingSLA": "userTask_sla",
            "routeTo": "",
            "faultConnector": "",
            "boundaryEvents": [],
            "outputAssignments": [],
            "document": "",
            "priority": 3
        },
        {
            "approvalType": "Single",
            "groupAsSingleParticipant": false,
            "label": "User Task",
            "locationX": 1000,
            "locationY": 100,
            "name": "userTask1",
            "priority": 3,
            "render": "SimpleBP$ut1$form",
            "renderType": "Form",
            "routeType": "Last Assignee In Lane",
            "router": {
                "defaultRouteTo": "",
                "defaultRouteType": "",
                "name": ""
            },
            "title": "T2",
            "routeTo": "",
            "connector": "",
            "faultConnector": "",
            "boundaryEvents": [],
            "inputAssignments": [],
            "outputAssignments": [],
            "document": "",
            "description": ""
        }
    ],
    "variables": [
        {
            "currencyFactor": 0,
            "dataType": "checkBox",
            "defaultValue": "{!$GlobalConstant.True}",
            "defaultValueType": "",
            "description": "",
            "extNS": "",
            "extType": "",
            "isCollection": false,
            "isInput": false,
            "isNested": false,
            "isOutput": false,
            "name": "IsMatched"
        },
        {
            "currencyFactor": 0,
            "dataType": "text",
            "defaultValue": "Hello",
            "defaultValueType": "",
            "description": "",
            "extNS": "",
            "extType": "",
            "isCollection": false,
            "isInput": false,
            "isNested": false,
            "isOutput": false,
            "name": "Owner"
        },
        {
            "currencyFactor": 0,
            "dataType": "date",
            "defaultValue": "",
            "defaultValueType": "",
            "description": "",
            "extNS": "",
            "extType": "",
            "isCollection": false,
            "isInput": false,
            "isNested": false,
            "isOutput": false,
            "name": "dateVar"
        },
        {
            "currencyFactor": 0,
            "dataType": "date",
            "defaultValue": "",
            "defaultValueType": "",
            "description": "",
            "extNS": "",
            "extType": "",
            "isCollection": true,
            "isInput": false,
            "isNested": false,
            "isOutput": false,
            "name": "dateList"
        },
        {
            "currencyFactor": 0,
            "dataType": "extStruct",
            "defaultValue": "",
            "defaultValueType": "",
            "description": "",
            "extNS": "SimpleBP",
            "extType": "Form1Form",
            "isCollection": false,
            "isInput": false,
            "isNested": false,
            "isOutput": false,
            "name": "Form1Form"
        }
    ],
    "version": "1.0.1",
    "webSite": null,
    "constants": [],
    "serviceTasks": [],
    "businessRuleTasks": [],
    "callActivities": [],
    "subProcesses": [],
    "endEvents": [],
    "sendEvents": [],
    "throwEvents": [],
    "catchEvents": [],
    "exclusiveGateways": [],
    "parallelGateways": [],
    "eventGateways": [],
    "usingSLA": ""
}

Example Response

{
    "resCode": "0",
    "resMsg": "Success",
    "result": {
        "errors": [],
        "id": "000y000000aM8XixTN0S",
        "warnings": []
    }
}