华为云用户手册

响应示例 { "resCode": "0", "resMsg": "成功", "result": [ { "id": "cust000000aKtFZpERvc", "keyPrefix": "c02W", "name": "SmartCampus__OperatorOrganization__ CS T", "category": 3, "label": "OperatorOrganization", "pluralLabel": "OperatorOrganizations", "version": 7, "contextSetup": 0, "trackFieldHistory": false, "allowReports": false, "allowActivities": false, "allowChatter": false, "allowStreamingApiAccess": false, "allowBulkApiAccess": false, "allowSearch": false, "allowSharing": false, "sharingMode": 0, "deploymentStatus": 0, "properties": "", "status": 0, "createdBy": "10gd000000SDyqaQW6uu", "createdDate": "2020-03-12 15:14:56", "lastModifiedBy": "10gd000000SDyqaQW6uu", "lastModifiedDate": "2020-03-12 15:15:00", "description": "", "objectType": 0, "protectMode": 1, "installedPackage": "003L000000YGxJbahwps", "createdBy.name": "test0xx", "lastModifiedBy.name": "test0xx", "childObjects": null, "parentObjects": [ { "parentObject": "cust000000PeSg3hYOOG", "cascadeDelete": true }, { "parentObject": "stad00000000000000GD", "cascadeDelete": false }, { "parentObject": "stad00000000000000GG", "cascadeDelete": false }, { "parentObject": "stup000000000000002I", "cascadeDelete": false }, { "parentObject": "stup000000000000003L", "cascadeDelete": false } ] }, { "id": "cust000000aKoa6I4E6K", "keyPrefix": "cE6K", "name": "test__qw__CST", "category": 3, "label": "qw", "pluralLabel": "qws", "version": 3, "contextSetup": 0, "trackFieldHistory": false, "allowReports": false, "allowActivities": false, "allowChatter": false, "allowStreamingApiAccess": false, "allowBulkApiAccess": false, "allowSearch": false, "allowSharing": false, "sharingMode": 0, "deploymentStatus": 0, "properties": "", "status": 0, "createdBy": "10gd000000SDyqaQW6uu", "createdDate": "2020-05-28 15:55:42", "lastModifiedBy": "10gd000000SDyqaQW6uu", "lastModifiedDate": "2020-05-28 17:47:03", "description": "", "objectType": 0, "protectMode": 0, "installedPackage": "", "createdBy.name": "test0xx", "lastModifiedBy.name": "test0xx", "childObjects": null, "parentObjects": [ { "parentObject": "stad00000000000000GD", "cascadeDelete": false }, { "parentObject": "stad00000000000000GG", "cascadeDelete": false }, { "parentObject": "stup000000000000002I", "cascadeDelete": false }, { "parentObject": "stup000000000000003L", "cascadeDelete": false } ] } ] }

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

响应示例 { "resCode": "0", "resMsg": "成功", "result": { "belongTo": "", "content": { "name": "", "type": "", "view": { "fields": [ "name", "Test__xxx__CST", "Test__Field1__CST", "Test__Field11__CST", "Test__Field3__CST" ], "name": "__layout__Test__t1__CST__detail" } }, "createdBy": "10gd000001DHHEwmE1NQ", "createdBy.name": "test00xx", "createdDate": "2024-06-06 16:19:07", "custom": true, "description": "Object detail layout", "events": [], "id": "000D000001Dgez2PYjS4", "isBaseline": false, "label": "t1 Detail", "lastModifiedBy": "10gd000001DHHEwmE1NQ", "lastModifiedBy.name": "test00xx", "lastModifiedDate": "2024-06-07 11:05:50", "name": "t1 Detail", "objectId": "cust000001Dgez2L19N2", "owner": "10gd000001DHHEwmE1NQ", "owner.name": "test00xx", "params": [], "protectMode": 0, "type": "ObjectDetailLayout", "visibility": 0 } }

URI GET 华为云Astro轻应用 域名 /u-route/baas/metadata/v1.0/object/{object_id}/Layout/{layout_id} 表1 路径参数 参数 是否必选 参数类型 描述 object_Id 是 String 参数解释： 对象的ID值，可通过调用查询所有自定义对象接口查看（响应消息中的“id”）。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 layout_id 是 String 参数解释： 对象布局的ID值，可通过调用5.2.3.9-根据object_id查询layout接口查看（响应消息中的“id”）。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

响应示例 { "resCode": "0", "resMsg": "成功", "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" } }

响应示例 { "resCode": "0", "resMsg": "成功", "result": [{ "belongTo": null, "bpId": null, "createdBy": "10gd000001DHHEwmE1NQ", "createdBy.__objectType": "User", "createdBy.name": "test00xx", "createdDate": "2024-06-13 10:11:07", "custom": true, "description": "home tab", "id": "001g0000000000000000", "installedPackage": null, "kanbanId": null, "label": "Home", "lastModifiedBy": "10gd000001DHHEwmE1NQ", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test00xx", "lastModifiedDate": "2024-06-13 10:11:07", "layoutId": null, "logo": "home.logo", "name": "Home", "objectId": "", "openWay": 0, "owner": "10gd000001DHHEwmE1NQ", "owner.__objectType": "User", "owner.name": "test00xx", "pageId": null, "properties": "", "protectMode": 0, "reportId": null, "showDeviceType": null, "showRegion": 0, "type": "PortalTab", "type.name": "PortalTab", "visibility": null, "webURL": null, "websiteId": null }, { "belongTo": null, "bpId": null, "createdBy": "10gd000001DHHEwmE1NQ", "createdBy.__objectType": "User", "createdBy.name": "test00xx", "createdDate": "2024-06-12 17:12:34", "custom": true, "description": null, "id": "001g000001DqgE2h6vUO", "installedPackage": null, "kanbanId": null, "label": "管理t134", "lastModifiedBy": "10gd000001DHHEwmE1NQ", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test00xx", "lastModifiedDate": "2024-06-12 17:12:34", "layoutId": null, "logo": "menuicon icon-app", "name": "Test__asda_t1", "objectId": null, "openWay": 0, "owner": "10gd000001DHHEwmE1NQ", "owner.__objectType": "User", "owner.name": "test00xx", "pageId": null, "properties": null, "protectMode": 0, "reportId": null, "showDeviceType": "0", "showRegion": 0, "type": "ViewTab", "type.name": "ViewTab", "visibility": 0, "webURL": "Test__Managet1", "websiteId": null }, { "belongTo": null, "bpId": null, "createdBy": "10gd000001DHHEwmE1NQ", "createdBy.__objectType": "User", "createdBy.name": "test00xx", "createdDate": "2024-06-13 10:05:50", "custom": true, "description": null, "id": "001g000001DrqdSfgNXc", "installedPackage": null, "kanbanId": null, "label": "管理t1342", "lastModifiedBy": "10gd000001DHHEwmE1NQ", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test00xx", "lastModifiedDate": "2024-06-13 10:05:50", "layoutId": null, "logo": "menuicon icon-app", "name": "Test__asda_t11", "objectId": null, "openWay": 0, "owner": "10gd000001DHHEwmE1NQ", "owner.__objectType": "User", "owner.name": "test00xx", "pageId": null, "properties": null, "protectMode": 0, "reportId": null, "showDeviceType": "0", "showRegion": 0, "type": "ViewTab", "type.name": "ViewTab", "visibility": 0, "webURL": "Test__Managet12", "websiteId": null } ] }

URI POST 华为云Astro轻应用域名/u-route/baas/bulk/v1.0/template/xlsx?template={template}&filename={filename} 表1 路径参数 参数 是否必选 参数类型 描述 template 是 String 参数解释： 数据导入模板的名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 filename 是 String 参数解释： 上传的文件名称。 约束限制： 支持“xls”和“xlsx”格式的文件。 取值范围： 不涉及。 默认取值： 不涉及。

响应示例 { "resCode": "0", "resMsg": "成功", "result": { "active": true, "apiVersion": null, "belongTo": null, "createdBy": "10gd000001DHHEwmE1NQ", "createdBy.__objectType": "User", "createdBy.name": "hw065922111", "createdDate": "2024-06-11 11:27:02", "custom": true, "description": null, "event": "BeforeInsert", "event.name": "BeforeInsert", "id": "001i000001Docd70WYZU", "installedPackage": null, "jscode": "Hello, world;rn", "label": "Trigger 01", "lastModifiedBy": "10gd000001DHHEwmE1NQ", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "hw065922111", "lastModifiedDate": "2024-06-11 11:27:02", "name": "Trigger_01", "objectId": "cust000001Dgez2L19N2", "objectId.__objectType": "Object", "objectId.name": "HW_00644562__t1__CST", "owner": "10gd000001DHHEwmE1NQ", "owner.__objectType": "User", "owner.name": "hw065922111", "protectMode": 0, "script": "string", "sourceMap": null, "visibility": 0 } }

URI GET 华为云Astro轻应用域名/u-route/baas/metadata/v1.0/object/{object_id}/Trigger/{trigger_id} 表1 路径参数 参数 是否必选 参数类型 描述 object_Id 是 String 参数解释： 对象的ID值，可通过调用查询所有自定义对象接口查看（响应消息中的“id”）。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 trigger_id 是 String 参数解释： 触发器的ID值，可通过调用5.2.3.13-根据object_id查询trigger接口查看（响应消息中的“id”）。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

响应示例 { "resCode": "0", "resMsg": "成功", "result": { "tableInfo": { "id": "cust000000aKtFZpERvc", "keyPrefix": "cRvc", "name": "test__dfg__CST", "category": 3, "label": "dfg", "pluralLabel": "dfgs", "version": 0, "contextSetup": 0, "trackFieldHistory": false, "allowReports": false, "allowActivities": false, "allowChatter": false, "allowStreamingApiAccess": false, "allowBulkApiAccess": false, "allowSearch": false, "allowSharing": false, "sharingMode": 0, "deploymentStatus": 0, "properties": "", "status": 0, "createdBy": "10gd000000SDyqaQW6uu", "createdDate": "2020-05-28 17:01:02", "lastModifiedBy": "10gd000000SDyqaQW6uu", "lastModifiedDate": "2020-05-28 17:01:02", "description": "", "objectType": 0, "protectMode": 0, "installedPackage": "", "createdBy.name": "test0xx", "lastModifiedBy.name": "test0xx" }, "childObjects": null, "parentObjects": [ { "parentObject": "stad00000000000000GD", "cascadeDelete": false }, { "parentObject": "stad00000000000000GG", "cascadeDelete": false }, { "parentObject": "stup000000000000002I", "cascadeDelete": false }, { "parentObject": "stup000000000000003L", "cascadeDelete": false } ] } }

URI DELETE 华为云Astro轻应用域名/u-route/baas/metadata/v1.0/Picklist/{Picklist_id} 表1 路径参数 参数 是否必选 参数类型 描述 Picklist _id 是 String 参数解释： Picklist实例的ID，可通过调用查询选项列表值集接口查看（响应消息中的“id”）。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST 华为云Astro轻应用域名/u-route/baas/metadata/v1.0/Picklist/{Picklist_id} 表1 路径参数 参数 是否必选 参数类型 描述 Picklist _id 是 String 参数解释： Picklist实例的ID，可通过调用查询选项列表值集接口查看（响应消息中的“id”）。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 根据ID增加选项列表值集的值。 POST https://华为云Astro轻应用域名/u-route/baas/metadata/v1.0/Picklist/000y000000aM92DCu6hU { "picklistValues": [ { "value": "F", "label": "ff" } ] }

响应参数 响应参数如表3所示。 表3 响应参数 参数 参数类型 描述 resCode String 参数解释： 返回码。 取值范围： 如果返回“0”代表请求成功，其他错误码说明请参考错误码。 resMsg String 参数解释： 返回消息。 取值范围： 成功返回“成功”，其他情况会返回具体的错误信息。 result string 参数解释： 成功返回，会返回一个ID字符串。 取值范围： 不涉及。

请求示例 按object_id新增layout。 POST https://华为云Astro轻应用域名/u-route/baas/metadata/v1.0/Object/cust000000aKoa6I4E6K/Layout { "name": "dsaf", "existingPageLayout": "000D000000aKoa6OJOxl", "viewName": "dsaf" }

请求参数 表2 请求Body体参数 参数 是否必选 参数类型 描述 name 是 String 参数解释： 创建表对象时的名称。 约束限制： 创建后不可修改。 取值范围： 名称必须以字母或中文开头，没有特殊字符，下划线和连续的空格，且长度不能超过64个字符。 默认取值： 不涉及。 viewName 否 String 参数解释： 对象的别名，格式为“__layout__ +对象名+ __布局名”。其中，“布局名”为请求体中的name，“对象名”可通过调用查询所有自定义对象中接口查看（即响应消息中的“name”）。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 existingPageLayout 是 String 参数解释： 现有页面布局的ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

获取分享Token 功能介绍 用于获取临时Token，使用该Token可访问文件，不用再使用“access-token”进行鉴权。获取的Token是临时性的，存在有效期。 URI POST 华为云Astro轻应用域名/u-route/baas/sys/v1.1/connectors/{connector_type}/{connector_name}/sharetoken 表1 路径参数 参数 是否必选 参数类型 描述 connector_type 是 String 参数解释： 连接器的类型。 约束限制： 不涉及。 取值范围： obs：与OBS对接的连接器。 minio：与MINIO对接的连接器。 objectstorageproxy：对象存储代理类型。 默认取值： 不涉及。 connector_name 是 String 参数解释： 连接器实例的名称，即创建连接器时设置的连接器实例名。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 请求参数 表2 请求body参数 参数 是否必选 参数类型 描述 shareType 是 Integer 参数解释： 分享类型。 约束限制： 不涉及。 取值范围： 0：代表按文件分享。 1：代表按目录分享。 2：用字符数组表示多个文件路径。 默认取值： 不涉及。 key 否 String 参数解释： 分享的对象、目录。 约束限制： 如果是目录，必须以“/”结尾。 取值范围： 不涉及。 默认取值： 不涉及。 keys 否 String 参数解释： 多个文件路径。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 timeoutInMinutes 是 Integer 参数解释： 分享的有效期，单位为分钟。 约束限制： 不涉及。 取值范围： 1~1440，即最短1分钟，最长1440分钟。 默认取值： 不涉及 响应参数 表3 响应参数说明 参数 参数类型 描述 resCode String 参数解释： 返回码。 取值范围： 如果返回“0”代表请求成功，其他错误码说明请参考错误码。 resMsg String 参数解释： 返回消息。 取值范围： 成功返回“成功”，其他情况会返回具体的错误信息。 result Object 参数解释： 返回结果对象。对象中包含“shareToken”字段，表示临时Token。 请求示例 已创建好OBS类型连接器，连接器实例名称为“命名空间__TestOBS”。调用如下请求，获取某些文件的临时访问Token。 POST https://华为云Astro轻应用域名/u-route/baas/sys/v1.1/connectors/obs/命名空间__TestOBS/sharetoken { "shareType": 0, "key": "a/b/c/1.txt", "keys": [ "a/b/c/2.txt", "ROMAExchange.zip", "some/dir/c.jpg" ], "timeoutInMinutes": 60 } 使用者拿到URL后即可访问，请注意避免分享敏感文件。 响应示例 { "resCode": "0", "resMsg": "成功", "result": { "shareToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJz***tOejj6NEo" } } 请记录下“shareToken”的值，后续访问文件使用。

查看分享对象文件 功能介绍 使用获取分享Token，返回的临时Token查看文件。 URI GET 华为云Astro轻应用域名/u-route/baas/sys/v1.1/objectstorage/viewshareobject?object=X&shareToken=Y 表4 路径参数 参数 是否必选 参数类型 描述 object 是 String 参数解释： 文件所在桶的全路径，包含文件名。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 shareToken 是 String 参数解释： 获取分享Token中，返回的临时Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 请求参数 无 响应参数 只返回文件内容。 请求示例 已创建好OBS类型连接器，连接器实例名称为“命名空间__TestOBS”。调用如下请求，使用临时访问Token查看桶中的“a/b/c/1.txt”文件。 GET https://华为云Astro轻应用域名/u-route/baas/sys/v1.1/objectstorage/viewshareobject?object=a/b/c/1.txt&shareToken=eyJhbGciOiJIUzI1NiIsInR******W8FYgXTGTAtOejj6NEo 响应示例 test

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 参数解释： 新建自定义对象的名称。 约束限制： 创建后不可修改。 取值范围： 必须以英文字母开头，只能由英文字母，数字和单下划线组成，不允许下划线结尾，且长度不能超过63个字符。 默认取值： 不涉及。 label 否 String 参数解释： 对象的别名，创建后可以修改。 约束限制： 不涉及。 取值范围： 1~80个字符。 默认取值： 不涉及。 description 否 String 参数解释： 对象的描述信息。 约束限制： 不涉及。 取值范围： 1~80个字符。 默认取值： 不涉及。 fields 是 Array of field object 参数解释： 对象的字段列表，字段参数请参见表2。 约束限制： 不涉及。 view 是 Object of layout object 参数解释： 是一个对象，其中包含ObjectDetailLayout对象和ObjectRecordsLayout对象。创建自定义对象后，系统会自动创建对象的Detail和Records标准页面，ObjectDetailLayout对象和ObjectRecordsLayout对象分别对应这两个标准页面的对象信息。 约束限制： 不涉及。 表2 fields字段参数 参数 是否必选 参数类型 描述 label 是 String 参数解释： 新建字段的标签。 约束限制： 不涉及。 取值范围： 1~80个字符。 默认取值： 不涉及。 name 是 String 参数解释： 新建字段的名称。 约束限制： 创建后不可修改。 取值范围： 必须以英文字母开头，只能由英文字母，数字和单下划线组成，不允许下划线结尾，且长度不能超过63个字符。 默认取值： 不涉及。 dataType 是 String 参数解释： 新建字段的类型。 约束限制： 创建后不可修改。 取值范围： 文本：允许用户输入任何字母和数字的组合，最多可输入255个字符。 密文：允许用户输入任何字母和数字的组合，并且以加密格式存储，最多可输入111个字符。 文本区：允许用户输入多行文本，最多可输入1,048,576字符。 数字：允许用户输入任何数字，会删除前置零。 百分比：允许用户输入百分比数字（例如"10"），并自动向数字添加百分号。 电话：允许用户输入任何电话号码，系统会自动将其转换为电话号码格式。 币种金额：允许用户输入其他币种金额，并将字段自动转换为币种金额格式。此功能在将数据导出到Excel或其它电子表格时非常有用。 日期：允许用户输入日期或从弹出式日历中选择日期。 日期/时间：允许用户输入日期和时间，或从弹出式日历中选择日期。当用户单击弹出式日历中的某个日期后，该日期和当前时间将输入到“日期/时间”字段。 电子邮件：允许用户输入电子邮件地址，对其进行验证以确保格式正确。如果对一个联系人和潜在客户指定了此字段，则用户单击“发送电子邮件”时可以选择地址。自定义电子邮件地址无法用于批量电子邮件。 复选框：允许用户选择“真”（选取）或“假”（不选取）值。 选项列表：允许用户从定义的列表中选择值。 选项列表（多项选择）：允许用户从定义的列表中选择多个值。 URL：允许用户输入任何有效的网址。当用户单击该字段时，该 URL 将在单独的浏览器窗口中打开。 查找关系：创建一个将此对象链接到另一对象的关系。 自动编号：使用用户定义的格式生成序列编号。该编号对于每条新记录会自动递增。 公式：使用用户定义的公式表达式生成只读字段。任何表达式中使用的源字段有所更改，本字段值将更新。 主从关系类型：在一个对象和另一个对象之间创建一种特殊类型的父子关系。详细记录的所有权是由主记录决定的。当用户删除主记录时，所有详细记录都将被删除。 多语言：允许用户从自定义资源表中选择多种语言内容。 附件：允许用户保存多个上传文件的地址，支持图片、文档等类型。 默认取值： 不涉及。

请求示例 创建Object对象实例。 POST https://华为云Astro轻应用域名/u-route/baas/metadata/v1.0/Object { "label": "VehicleType", "name": "VehicleType__CST", "description": "", "fields": [ { "label": "Name", "name": "name", "dataType": "Name" } ], "view": { "ObjectDetailLayout": { "name": "__layout__VehicleType__CST__detail", "fields": [ "name" ] }, "ObjectRecordsLayout": { "name": "__layout__VehicleType__CST__records", "fields": [ "name" ] } } }

请求参数 表2 请求body参数 参数 是否必选 参数类型 描述 name 是 String 参数解释： 新增字段的名称。 约束限制： 创建后不可修改。 取值范围： 必须以英文字母开头，只能由英文字母，数字和单下划线组成，不允许下划线结尾，且长度不能超过63个字符。 默认取值： 不涉及。 label 是 String 参数解释： 新增字段的标签。 约束限制： 不涉及。 取值范围： 1~80个字符。 默认取值： 不涉及。 inlineHelpText 否 String 参数解释： 新增字段的帮助说明。 约束限制： 不涉及。 取值范围： 1~255个字符。 默认取值： 不涉及。 dataLength 是 Int 参数解释： 新增字段的长度。 约束限制： 不涉及。 取值范围： 1~64个字符。 默认取值： 不涉及。 dataType 是 String 参数解释： 新增字段的类型。 约束限制： 创建后不可修改。 取值范围： 文本：允许用户输入任何字母和数字的组合，最多可输入255个字符。 密文：允许用户输入任何字母和数字的组合，并且以加密格式存储，最多可输入111个字符。 文本区：允许用户输入多行文本，最多可输入1,048,576字符。 数字：允许用户输入任何数字，会删除前置零。 百分比：允许用户输入百分比数字（例如"10"），并自动向数字添加百分号。 电话：允许用户输入任何电话号码，系统会自动将其转换为电话号码格式。 币种金额：允许用户输入其他币种金额，并将字段自动转换为币种金额格式。此功能在将数据导出到Excel或其他电子表格时非常有用。 日期：允许用户输入日期或从弹出式日历中选择日期。 日期/时间：允许用户输入日期和时间，或从弹出式日历中选择日期。当用户单击弹出式日历中的某个日期后，该日期和当前时间将输入到“日期/时间”字段。 电子邮件：允许用户输入电子邮件地址，对其进行验证以确保格式正确。如果对一个联系人和潜在客户指定了此字段，则用户单击“发送电子邮件”时可以选择地址。自定义电子邮件地址无法用于批量电子邮件。 复选框：允许用户选择“真”（选取）或“假”（不选取）值。 选项列表：允许用户从定义的列表中选择值。 选项列表（多项选择）：允许用户从定义的列表中选择多个值。 URL：允许用户输入任何有效的网址。当用户单击该字段时，该 URL 将在单独的浏览器窗口中打开。 查找关系：创建一个将此对象链接到另一对象的关系。 自动编号：使用用户定义的格式生成序列编号。该编号对于每条新记录会自动递增。 公式：使用用户定义的公式表达式生成只读字段。任何表达式中使用的源字段有所更改，本字段值将更新。 主从关系类型：在一个对象和另一个对象之间创建一种特殊类型的父子关系。详细记录的所有权是由主记录决定的。当用户删除主记录时，所有详细记录都将被删除。 多语言：允许用户从自定义资源表中选择多种语言内容。 附件：允许用户保存多个上传文件的地址，支持图片、文档等类型。 默认取值： 不涉及。 description 否 String 参数解释： 新增字段的描述信息。 约束限制： 不涉及。 取值范围： 1~80个字符。 默认取值： 不涉及。 defaultValue 否 String 参数解释： 新增字段的默认值。 约束限制： 格式需符合字段类型（dataType）中所配置类型的规则。 取值范围： 不涉及。 默认取值： 不涉及。 caseSensitive 否 Boolean 参数解释： 大小写是否敏感，例如，“ABC”和“abc”为相同值，表示大小写不敏感，“ABC”和“abc”为不同值，则表示大小写敏感。 约束限制： 不涉及。 取值范围： true：表示大小写敏感。 false：表示大小写不敏感。 默认取值： false。 isRequired 否 Boolean 参数解释： 字段是否必填。 约束限制： 不涉及。 取值范围： true：表示字段必填。 false：表示字段不必填。 默认取值： false。 isUnique 否 Boolean 参数解释： 字段中数据是否允许重复。 约束限制： 不涉及。 取值范围： true：表示字段唯一。 false：表示字段不唯一。 默认取值： false。 profiles 否 Array 参数解释： 权限分配。字段级安全配置，配置每个权限对该字段是否可见/可编辑。 约束限制： 不涉及。 layouts 否 Array 参数解释： 对象字段布局页面的名称。 约束限制： 不涉及。 view 否 Object 参数解释： 每项为一个String数组，名为包含该字段的Layout，内容为该Layout包含的字段。 约束限制： 不涉及。 isSearchable 否 Boolean 参数解释： 是否支持使用search语句搜索该字段。 约束限制： 不涉及。 取值范围： true：表示字段可搜。 false：表示字段不可搜索。 默认取值： false。

请求示例 根据object_id为Object添加字段。 POST https://华为云Astro轻应用域名/u-route/baas/metadata/v1.0/Object/cust000000aKoa6I4E6K/Field { "label":"test", "name":"CNAME1__test__CST", "inlineHelpText":"dsf", "description":"fsdf", "dataType":"text", "dataLength":255, "defaultValue":"vfdsg", "caseSensitive":true, "isRequired":true, "isUnique":true, "isSearchable":true, "profiles":[ { "profile":"000T0000000000000002", "readable":true, "editable":true }, { "profile":"000T0000000000000003", "readable":true, "editable":true }, { "profile":"000T0000000000000004", "readable":true, "editable":true }, { "profile":"000T0000000000000006", "readable":true, "editable":true }, { "profile":"000T000000Tiq6fUQhjK", "readable":true, "editable":true }, { "profile":"000T000000Tiq6lJCs2y", "readable":true, "editable":true }, { "profile":"000T000000W1a8iTFglU", "readable":true, "editable":true } ], "layouts":[ "000D000000aKoa6OJOxk" ], "view":{ "000D000000aKoa6OJOxk":{ "fields":[ "name", "test__df__CST", "test__sdadsd__CST", "test__sdd__CST" ] } } }

请求示例 更新一个记录，例如更新“TestProject__testForObject__CST”对象，记录ID为“cfw0000000aKin6AQgfQ”的数据。 PUT https://华为云Astro轻应用域名/u-route/baas/data/v1.0/bobject/TestProject__testForObject__CST/cfw0000000aKin6AQgfQ { "setValue": { "name": "newName" } }

自定义字段 根据请求URI和请求方法，明确请求如下，其中“cust000000aHYAsrPh4K”为对象ID： POST https://华为云Astro轻应用域名/u-route/baas/metadata/v1.0/object/cust000000aHYAsrPh4K/fields 设置请求消息头。 表2 请求消息头 消息头名称 描述 是否必选 Content-Type HTTP协议中设定的一个参数，用于标识返回的内容用什么格式去解析，此处必须配置为“application/json”。表示浏览器将返回内容解析为json对象。 是 access-token 当用户登录系统鉴权成功后，后台会生成一个token，在响应消息中携带，并存在浏览器中。下次再调用请求后，会带上这个token，表示这个用户已经被鉴权过。 是 构造请求消息体，创建“VehicleType”、“VehicleNumber”字段。 { "fields": [ { "label": "VehicleType", "name": "VehicleType__CST", "dataType": "text", "dataLength": 255, "caseSensitive": false, "isRequired": false, "isUnique": false, "isSearchable": false }, { "label": "VehicleNumber", "name": "VehicleNumber__CST", "dataType": "text", "dataLength": 255, "caseSensitive": true, "isRequired": false, "isUnique": true, "isSearchable": false } ] } 返回如下响应，表示成功创建字段。 { "resCode": "0", "resMsg": "成功", "result": [ "cust000000aHaE6S3mim", "cust000000aHaE6TlNVA" ] }

创建对象 根据请求URI和请求方法，明确请求如下： POST https://华为云Astro轻应用域名/u-route/baas/metadata/v1.0/object 设置请求消息头。 表1 请求消息头 消息头名称 描述 是否必选 Content-Type HTTP协议中设定的一个参数，用于标识返回的内容用什么格式去解析，此处必须配置为“application/json”。表示浏览器将返回内容解析为json对象。 是 access-token 当用户登录系统鉴权成功后，后台会生成一个token，在响应消息中携带，并存在浏览器中。下次再调用请求后，会带上这个token，表示这个用户已经被鉴权过。 是 构造请求消息体。 { "label": "VehicleType", "name": "VehicleType__CST", "description": "", "fields": [ { "label": "Name", "name": "name", "dataType": "Name" } ], "view": { "ObjectDetailLayout": { "name": "__layout__VehicleType__CST__detail", "fields": [ "name" ] }, "ObjectRecordsLayout": { "name": "__layout__VehicleType__CST__records", "fields": [ "name" ] } } } 返回如下响应，表示成功创建对象，记录“result”字段取值“cust000000aHYAsrPh4K”，为对象ID。 { "resCode": "0", "resMsg": "成功", "result": "cust000000aHYAsrPh4K" }

模型相关 获取data model= model_1实例的数据。 API：$model.ref("model_1").getData() 设置data model= model_1实例的数据，入参data和model_1定义结构一致，当改变整个模型数据时使用。 API：$model.ref("model_1").setData(data) 设置data model= model_1实例的字段值，只改变已有模型数据某个字段值时使用。 API：$model.ref("model_1").setValue(field, value)

Tab页相关 仅支持平台的运行态使用，可使用portal框架暴露的API来实现，平台运行态会暴露一个 bingo 全局变量供使用，标准页面由于在 iframe 内，需要使用 window.parent.bingo 访问： 打开tab页，返回tabId。 API：openTab(name, url) 切换tab页。 API：switchTab(tabId) 关闭指定Tab页。 API：removeTab(tabId) 当前Tab页。 API：getCurrentTab() 默认Tab页。 API：getDefaultTab() 打开指定Tab。 API：open({type:'Tab', id: tabId}) 打开指定Tab。 API：openTabByMenuName(menuName) 返回上一个路由。 API：back()

脚本操作 初始化Script API：context.script(scriptName) 入参：scriptName，表示Script名称。 出参：Script 示例： // 初始化脚本 let _script = context.script('{{ scriptName }}') 运行Script API：_script.run() 入参：无。 出参：Promise。 示例： // 初始化脚本 let _script = context.script('{{ scriptName }}') // 运行脚本 _script.run().then(function(response) { // TODO: Your business logic })

服务编排相关 初始化Flow API：context.flow(flowName) 入参：flowName表示Flow名称。 出参：Flow 示例： // 初始化Flow let _flow = context.flow("flowName") 设置Flow版本号 API：_flow.version(version: string) 入参：version表示flow版本号。 出参：Flow。 示例： // 设置Flow版本号 _flow.version("0.0.1") 运行Flow API：flow.run(params: Object) 入参：params，输入参数，如下示例： { param1: 'param1', param2: { param21: 'param21', param22: 'param22' } } 出参：Promise。 示例： // 适用于一次调用，Flow即完成的场景 // 运行Flow _flow.run({ param1: 'param1' }).then(function (res) { // TODO: Your business logic }) 启动Flow API：_flow.start(params: Object) 入参：params，输入参数，如下示例： { param1: 'param1', param2: { param21: 'param21', param22: 'param22' } } 出参：Promise。 示例： // 以下适用于多步操作的业务场景 _flow.start({ param1: 'param1' }).then(function (res) { // TODO: Your business logic }) 执行Flow下一步 API：_flow.next(interviewID: string, params: Object) 入参：interviewID为Flow运行实例ID，params为输入参数。 { param1: 'param1', param2: { param21: 'param21', param22: 'param22' } } 出参：Promise。 示例： // 下一步 _flow.next("{{ interviewID }}", { param1: 'param1' }).then(function (res) { // TODO: Your business logic }) 返回Flow上一步 API：_flow.back(interviewID: string, params: Object) 入参：interviewID为Flow运行实例ID，params为输入参数。 { param1: 'param1', param2: { param21: 'param21', param22: 'param22' } } 出参：Promise。 示例： // 上一步 _flow.back("{{ interviewID }}", { param1: 'param1' }).then(function (res) { // TODO: Your business logic }) 正常完成Flow API：_flow.finish(interviewID: string, params: Object) 入参：interviewID表示Flow运行实例ID；params：输入参数，如下示例： { param1: 'param1', param2: { param21: 'param21', param22: 'param22' } } 出参：Promise。 示例： // 完成Flow _flow.finish("{{ interviewID }}", { param1: 'param1' }).then(function (res) { // TODO: Your business logic }) 恢复Flow运行 API：_flow.resume(interviewID: string, params: Object) 入参：interviewID表示Flow运行实例ID；params：输入参数，如下示例： { param1: 'param1', param2: { param21: 'param21', param22: 'param22' } } 出参：Promise。 示例： // 恢复Flow _flow.resume("{{ interviewID }}", { param1: 'param1' }).then(function (res) { // TODO: Your business logic }) 删除Flow实例 API：_flow.terminate(interviewID: string, params: Object) 入参：interviewID表示Flow运行实例ID；params：输入参数，如下示例： { param1: 'param1', param2: { param21: 'param21', param22: 'param22' } } 出参：Promise。 示例： // 删除Flow _flow.terminate("{{ interviewID }}", { param1: 'param1', param2: { param21: 'param21', param22: 'param22' } }).then(function (res) { // TODO: Your business logic })

服务请求 调用服务的API API：context.service('{{url}}').run(_inputParams) 入参：“url”为服务接口的URL，在APP或者BO视图下单击“服务”，可查看到封装Flow、脚本或者对象操作接口的URL。“_inputParams”为输入参数。 示例： var _inputParams = {}; // 调用服务 context.service('{{ url }}').run(_inputParams).then(function(response) { // TODO: Your business logic });