Updated on 2025-08-14 GMT+08:00
Querying a BPM by ID
Function
This API is used to query a BPM by ID.
URI
GET Huawei Cloud Astro Zero domain name/u-route/baas/bp/v2.0/metadata/definitions/{bpm_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
bpm_id |
Yes |
String |
Explanation BPM instance ID, which can be queried by calling the API of Querying BPMs by Condition (id in the response message). Constraints None Value None Default value None |
Request Parameters
None
Response
|
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, the BPM instance information is returned. |
Example Request
Query a BPM object instance.
GET https://Huawei Cloud Astro Zero domain name/u-route/baas/bp/v2.0/metadata/definitions/001L000000Peuw1Q318a
Example Response
{
"resCode": "0",
"resMsg": "Success",
"result": {
"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\"]}",
"connectors": [
],
"description": "",
"label": "Data Mapper",
"locationX": 575,
"locationY": 125,
"name": "dataMapper"
}
],
"description": "",
"id": "001L000000Peuw1Q318a",
"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": [
{
"actions": [
],
"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": ""
}
],
"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\"]}",
"description": "",
"document": "",
"label": "Start",
"locationX": 125,
"locationY": 100,
"name": "start",
"render": "",
"renderType": "",
"startType": "",
"type": "Start"
}
],
"startStage": null,
"startType": "",
"status": "Warning",
"status.name": "Warning",
"userTasks": [
{
"approvalType": "Single",
"boundaryEvents": [
],
"connector": "userTask1",
"connectorPoint": "{\"fromPort\":\"R1\",\"toPort\":\"L1\",\"points\":[\"794 100\",\"818 100\",\"875 100\",\"875 100\",\"932 100\",\"956 100\"]}",
"description": "wuli desc",
"document": "",
"faultConnector": "",
"groupAsSingleParticipant": false,
"inputAssignments": [
{
"input": "$Task.Title",
"name": "",
"value": "{!$GlobalConstant.EmptyString}",
"valueType": ""
}
],
"label": "User Task",
"locationX": 750,
"locationY": 100,
"name": "userTask",
"outputAssignments": [
],
"participants": [
{
"type": "user",
"value": "ecommerce6"
}
],
"preActions": [
{
"action": "{!$GlobalConstant.EmptyString}",
"criteria": "",
"name": "action",
"type": "Set Status"
}
],
"priority": 3,
"render": "SimpleBP$Form1$form",
"renderType": "Form",
"routeTo": "",
"routeType": "Name and Expressions",
"router": {
"defaultRouteTo": "",
"defaultRouteType": "",
"name": ""
},
"title": "wu li tu cao",
"usingSLA": "userTask_sla"
},
{
"approvalType": "Single",
"boundaryEvents": [
],
"connector": "",
"description": "",
"document": "",
"faultConnector": "",
"groupAsSingleParticipant": false,
"inputAssignments": [
],
"label": "User Task",
"locationX": 1000,
"locationY": 100,
"name": "userTask1",
"outputAssignments": [
],
"priority": 3,
"render": "SimpleBP$ut1$form",
"renderType": "Form",
"routeTo": "",
"routeType": "Last Assignee In Lane",
"router": {
"defaultRouteTo": "",
"defaultRouteType": "",
"name": ""
},
"title": "T2"
}
],
"usingSLA": "",
"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"
}
}
Status Code
See Status Codes.
Error Code
See Error Codes.
Parent topic: BPMs
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
The system is busy. Please try again later.
For any further questions, feel free to contact us through the chatbot.
Chatbot
