华为云用户手册

  • 请求示例 更新“TestProject__testForObject__ CS T”对象中,满足name字段值为“newName”的记录,更新name字段值为“name3”。 PUT https://AstroZero 域名 /u-route/baas/data/v1.0/bobject/TestProject__testForObject__CST { "setValue": { "name": "name3" }, "condition": { "conjunction": "AND", "conditions": [ { "field": "name", "operator": "eq", "value": "newName" } ] } }
  • 请求示例 按object_id新增layout。 POST https://AstroZero域名/u-route/baas/metadata/v1.0/Object/cust000000aKoa6I4E6K/Layout { "name": "dsaf", "existingPageLayout": "000D000000aKoa6OJOxl", "viewName": "dsaf" }
  • 响应参数 响应参数如表3所示。 表3 响应参数 参数 参数类型 描述 resCode String 参数解释: 返回码。 取值范围: 如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 如果成功状态,通常会返回“Success”,其他情况会返回具体的错误信息。 result string 参数解释: 成功返回,会返回一个ID字符串。 取值范围: 不涉及。
  • 请求参数 表2 请求Body体参数 参数 是否必选 参数类型 描述 name 是 String 参数解释: 创建表对象时的名称,一旦创建不可修改。 约束限制: 不涉及。 取值范围: 名称必须以字母或中文开头,没有特殊字符,下划线和连续的空格,且长度不能超过64个字符。 默认取值: 不涉及。 viewName 否 String 参数解释: 对象的别名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 existingPageLayout 是 String 参数解释: 现有页面布局的ID,获取方法如下: 进入已创建的应用。 在模块树中,单击已创建的对象。 在“布局”页签,即可获取页面布局的ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • URI GET AstroZero域名/u-route/baas/metadata/v1.0/object/{object_id}/Field/{field_id} 表1 路径参数 参数 是否必选 参数类型 描述 object_Id 是 String 参数解释: 对象的ID值,可通过调用查询所有自定义对象接口查看(响应消息中的“id”)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 field_id 是 String 参数解释: Field的ID值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 响应示例 { "resCode": "0", "resMsg": "成功", "result": { "name": "CNAME1__test__CST", "col": "D0.V4", "objectId": "cust000001Dgez2L19N2", "id": "cust000001DoWciUWMaG", "label": "test", "dataType": "Text", "category": 4, "isRequired": true, "isUnique": true, "isIndexed": true, "isUnionIndexed": false, "dataLength": 255, "scale": 0, "status": 0, "encryptType": 0, "caseSensitive": true, "enableFilter": true, "enableSort": true, "visibleLines": 3, "populateRows": 1, "startingNumber": 0, "defaultValue": "vfdsg", "createdBy": "10gd000001DHHEwmE1NQ", "createdDate": "2024-06-11 10:02:59", "lastModifiedBy": "10gd000001DHHEwmE1NQ", "lastModifiedDate": "2024-06-11 10:02:59", "inlineHelpText": "dsf", "description": "fsdf", "sequenceNo": 1005, "protectMode": 0, "installedPackage": "", "isSearchable": true, "visibility": 0, "belongTo": "", "minEncryptedSearchableLength": 0, "rollbackType": false, "autoType": "", "resetUnit": "", "autoExpand": false, "createdBy.name": "hw065922111", "lastModifiedBy.name": "hw065922111" } }
  • 请求示例 删除两个记录,例如删除“TestProject__testForObject__CST”对象,记录ID为“cfw0000000aKmGskAsDo”和“cfw0000000aKmGskAsDp”的数据。 DELETE https://AstroZero域名/u-route/baas/data/v1.0/bobject/TestProject__testForObject__CST?records=cfw0000000aKmGskAsDo,cfw0000000aKmGskAsDp
  • 响应参数 表3 响应参数 参数 参数类型 描述 resCode String 参数解释: 返回码。 取值范围: 如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 如果成功状态,通常会返回“Success”,其他情况会返回具体的错误信息。 result Number 参数解释: 删除记录的个数,成功时携带。 取值范围: 0~100。
  • 请求示例 删除“TestProject__testForObject1__CST”对象中,name为“test”的记录数。 POST https://AstroZero域名/u-route/baas/data/v1.0/delete/TestProject__testForObject1__CST { "condition": { "conjunction": "AND", "conditions": [ { "field": "NAME", "operator": "eq", "value": "test" } ] } }
  • 请求参数 表2 请求参数 参数 是否必选 参数类型 描述 condition 是 Object 参数解释: 表示删除的条件。 约束限制: 其中包含以下三个元素,为空则表示删除所有对象数据。 conjunction:表示需要满足的条件个数。 AND:表示条件都要满足。 OR:表示至少要满足一个条件。 conditions:筛选条件的数组。如果参数为空,代表查询所有对象数据,若不为空,其中的每一个元素对象都包含如下三个字段。 field:类型string,字段名称。 operator:类型string,操作符。 value:类型string,对比值。 relation:数组中包含parents(向上查询)和children(向下查询)两个元素,两者分别对应相应的数组。 其中,parents包含condition数组和relatedField(关联字段名称)。children包含condition数组和relationName(关联字段名称)。 condition数组包含: conjunction:取值为AND或OR。 conditions:同上conditions参数。 relation:同上relation参数。
  • 连接器 预置连接器接口,包括上传、下载、删除文件和目录等接口。通过这些接口,您可以实现文件的上传、下载和列举目录下文件等。 表7 连接器接口 API 说明 上传文件 将本地文件上传到存储中。使用该API上传文件,默认只会上传到连接器下配置的第一个桶中。 下载文件 从存储中下载文件。 删除文件 从存储中删除无用的文件。 删除目录 从存储中删除某目录。如果目录下不为空,删除目录的同时也会删除该目录下文件。 列举目录下文件 列举存储中某目录下文件。 分段上传 对于较大文件上传,可以切分成段上传。用户可以在如下的应用场景内(但不仅限于此),使用分段上传的模式: 上传超过100MB大小的文件。 网络条件较差,和OBS等存储服务端之间的连接经常断开。 上传前无法确定将要上传文件的大小。 获取endpoint,即文件存储地址的前缀 endpoint为文件存储地址的前缀,该前缀加上传对象的路径,是实际访问对象的全路径。上传文件中,返回的是上传文件在桶上的路径。通过调用本节接口,返回endpoint,组装起来才是文件完整的访问地址。 分享Token 通过调用获取分享Token,可以获取临时Token,用户只要使用该临时Token即可访问文件,不用再使用“access-token”进行鉴权。
  • BPM 工作流接口,包括启动、查询和删除工作流等接口。通过这些接口,您可以启动工作流实例、删除工作流实例和挂起/恢复/终止工作流实例等。 表5 BPM接口 API 说明 启动BPM实例 创建并启动一个BPM实例。 查询BPM实例 获取当前账号所有的BPM实例信息。 挂起/恢复/终止BPM实例 挂起/恢复/终止一个BPM实例。BPM实例被挂起后,不会在用户的待办任务列表中出现,流程SLA定时器停止,也不会进行任何跟催。恢复后,可继续进行操作。终止操作则强行结束一个BPM实例,可在历史任务中查看。 删除BPM实例 删除一个BPM实例。彻底删除一个BPM实例,仅当管理员清除过期数据时可以删除,其他情况不建议删除BPM实例数据。 配置或修改BPM实例中变量的值 设置或修改BPM实例中变量的值, 一次可以修改一个、多个或者所有变量的值。不存在的变量或者只读变量会被忽略。
  • 导入导出 对象数据导入导出接口,包括导入数据、导出数据和导入导出元数据等接口。通过这些接口,您可以导入导出对象数据或元数据,实现数据的迁移。 表6 导入导出接口 API 说明 导出数据 导出数据表中的具体数据。AstroZero中创建的对象,其内部的数据是支持导出的,该接口支持将对象中的数据按照设定的周期频率、筛选条件进行导出。 导入数据 导入数据。导入的数据源为zip包,包中的数据文件应为txt或csv格式,每个文件第一行为数据所属对象信息,第二行为字段名,第三行开始每一行为一条数据记录。 导出元数据 导出数据表的元数据,即将数据表的各个字段信息导出,但不包含具体的数据记录。 导入元数据 导入数据表的元数据。若已有数据表的元数据,可使用该功能快速根据元数据创建对象表。 使用模板导入数据 按照所使用的模板格式,导入数据。使用该功能前,需要创建好可使用的数据导入模板,在模板中定义数据的映射规则,调用接口时需指定模板名称,在该模板中,需要指定对应的操作脚本。
  • 数据模块 数据模块接口,包括按记录ID查询、删除和更新数据等接口。通过这些接口,您可以查询对象中的数据,为对象新增数据等。 表1 数据模块接口 API 说明 按记录ID查询数据 按记录ID查询数据。 按记录ID删除数据 按记录ID删除数据。 按记录ID更新数据 按记录ID更新数据。 按记录ID列表查询数据 按记录ID列表查询数据。 新增对象数据 新增对象数据。 按记录ID列表删除数据 按记录ID列表删除数据。 按条件更新数据 按条件更新数据。 按条件查询对象数据 按条件查询对象数据。 按条件删除对象数据 按条件删除对象数据。 按条件查询对象记录数 按条件查询对象记录数。 批量插入或修改对象数据 批量插入或修改对象数据,若数据包含id进行更新,若数据不含id进行插入。
  • 元数据 元数据接口,包括创建对象、服务编排和工作流等接口。通过这些接口,您可以新建对象、新建服务编排对象和新建工作流对象等。 表2 元数据接口 API 说明 创建自定义对象 添加一个Object对象。 查询所有自定义对象 查询所有Object对象。 按照object_id查询自定义对象 按照ID查询Object。 根据object_id添加字段 为object添加自定义字段。 根据object_id新增trigger 根据object_id新增trigger。 根据object_id新增校验validator 根据object_id新增校验validator。 根据object_id新增layout 按object_id新增layout。 根据field_id查询Field 按照field_id查询Field。 根据object_id查询layout 按照object_id查询layout。 根据layout_id查询layout 按照layout_id查询Layout。 根据object_id查询button 按照object_id查询button。 根据button_id查询button 按照button_id查询Button。 根据object_id查询trigger 按照object_id查询trigger。 根据trigger_id查询trigger 按照trigger_id查询Trigger。 根据object_id查询validator 按照object_id查询validator。 根据validator_id查询validator 按照validator_id查询validator。 创建Flow对象 添加一个flow对象。 查询Flow对象 获取匹配查询条件的flow列表。 按照flow_id查询/查询flow_id的入参出参信息 按flow_id查询Flow/查询flow_id的入参出参信息。 根据flow_id修改Flow对象 根据id修改flow对象。 按照flow_id删除flow 按flow_id删除Flow。 创建BPM对象 创建一个BPM对象。 按条件查询BPM对象 获取匹配查询条件的BPM列表。 按ID查询BPM对象 按bpm_id查询BPM对象。 根据ID修改BPM对象 根据id修改BPM对象。 按照ID删除BPM 按bpm_id删除BPM。 创建Picklist对象 创建一个Picklist对象。 查询选项列表值集 查询选项列表值集。 按ID增加选项列表值集的值 按picklist_id增加选项列表值集的值。 根据ID查询选项列表值集或引用该选项列表值集的对象字段列表 根据ID查询选项列表值集或引用该选项列表值集的对象字段列表。 根据ID修改选项列表值集的基本信息 根据id修改Picklist对象。 根据ID删除选项列表值集或选项列表值集的值 根据ID删除选项列表值集或选项列表值集的值。 列出所有应用 查询当前账号下所有应用。 根据ID查询应用 根据应用ID查询应用详细信息。 查询标准页面列表 查询标准页面的列表,仅包含基础信息,如果需要获取标准页面的内容,需要根据 ID 进行查询。 根据ID查询标准页面 按view_id查询标准页面。 查询Tab列表 查询应用页签的列表。
  • 响应参数 表3 响应参数 参数 参数类型 描述 resCode String 参数解释: 返回码。 取值范围: 如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 如果成功状态,通常会返回“Success”,其他情况会返回具体的错误信息。 result Array 参数解释: 查询返回的对象数据。 count number 参数解释: 对象中满足条件的总记录数。 取值范围: 不涉及。
  • 请求示例 查询“TestProject__testForObject1__CST”对象中,name值为“zhang”的记录数,且限制只返回3条,总记录数为5条,返回的记录按“TestProject__length__CST”字段降序排列,查询参数base为N表示按对象名称进行查询。 POST https://AstroZero域名/u-route/baas/data/v1.0/query/TestProject__testForObject1__CST?base=N {"condition": { "conjunction": "AND", "conditions": [ { "field": "name", "operator": "eq", "value": "zhang" } ] }, "options": { "orderby": [ { "field": "TestProject__length__CST", "order": "desc" } ], "limit": 3 } }
  • URI POST AstroZero域名/u-route/baas/data/v1.0/query/{objectName}?base=X&fields=f1,f2 表1 路径参数 参数 是否必选 参数类型 描述 objectName 是 String 参数解释: 数据对象的名称。 约束限制: 不涉及。 取值范围: 1~80个字符。 默认取值: 不涉及。 base 否 String 参数解释: 查询参数,用于区分objectName传入数据样式。 约束限制: 不涉及。 取值范围: 支持如下选项: I:对应对象的ID。 N:传入的对象名称。 默认取值: 不涉及。 fields 否 Array 参数解释: 对象显示的字段,多个字段则用逗号分隔。如果该字段不为空,则仅返回显示的字段和必要信息(如数据记录拥有者信息和id);为空则返回整个记录数据。 约束限制: 不涉及。
  • 请求参数 表2 请求参数 参数 是否必选 参数类型 描述 condition 否 Object 参数解释: 表示查询的条件。 约束限制: 包含以下元素,若为空则表示查询所有对象数据。 conjunction:表示需要满足的条件个数。 AND:表示条件都要满足。 OR:表示至少要满足一个条件。 conditions:筛选条件的数组。如果参数为空,代表查询所有对象数据,若不为空,其中的每一个元素对象都包含如下三个字段。 field:字段名称。 operator:操作符。例如,“eq”表示等于、“ne”表示不等于、“gt”表示大于、“lt”表示小于、“ge”表示大于等于、“le”表示小于等于。 value:对比值。 relation:数组中包含parents(向上查询)和children(向下查询)两个元素,两者分别对应相应的数组。 其中,parents包含condition数组和relatedField(关联字段名称)。children包含condition数组和relationName(关联字段名称)。 relation 否 Object 参数解释: 关联查询,包含parents(向上查询)和children(向下查询)两个元素,两者分别对应相应的数组。 约束限制: 其中,parents包含condition数组和relatedField(关联字段名称)。children包含condition数组和relationName(关联字段名称)。 condition数组包含conjunction、conditions和relation,参数解释同condition。 { //向上查询 parents: [ //第一级父对象 { relatedField: "CarHolder__CST", //当前对象的字段(Lookup/MasterDetail类型),据此确定父对象 options: { fields: ["id", "name", "Age__CST"] //父对象的待查字段 }, parents: [ //(可选)第二级父对象 { relatedField: "cust__CST", //父对象的字段(Lookup/MasterDetail类型),据此确定祖父对象 options: { fields: ["id", "name", "Email__CST"] //祖父对象的待查字段 } } ] } ], //向下查询 childs: [ //第一级子对象 { relationName: "Contacts", //子对象关系名(子对象定义Lookup/MasterDetail时指定),据此确定子对象 options: { fields: ["id", "name", "Age__CST", "cust__CST"] //子对象的待查字段 }, childs: [ //(可选)第二级子对象 { relationName: "ContactCars", //孙子对象关系名 options: { fields: ["id", "name", "Price__CST", "CarHolder__CST"] //孙子对象待查字段 } } ] } ] } options 否 Object 参数解释: 附加选项,对查询返回的结果进行一些操作。 约束限制: 可进行如下操作。 orderBy:按指定字段的值排序,取值为asc(升序)和desc(降序) options: { orderby: [ { field: "name", order: db.Order.desc } ], } groupby:按照指定字段进行分组 options: { groupby: [ { field: "name", } ], } distinct:去重 options: { distinct: true, } 限制查询返回的记录数:通过skip值指定从第多少条开始,limit指定总共返回多少条记录 { options: { skip: 100, limit: 100 } }
  • 响应示例 { "resCode": "0", "resMsg": "成功", "result": [ { "TestProject__age__CST": null, "TestProject__length__CST": "888", "TestProject__name__CST": null, "createdBy": "10gd000000SDzgxNSckK", "createdBy.__objectType": "User", "createdBy.name": "test0xx", "createdDate": "2020-05-29 12:50:59", "currencyIsoCode": "", "id": "cglE000000aMGHkvmhmb", "installedPackage": null, "lastModifiedBy": "10gd000000SDzgxNSckK", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test0xx", "lastModifiedDate": "2020-05-29 12:50:59", "name": "zhang", "owner": "10gd000000SDzgxNSckK", "owner.__objectType": "User", "owner.name": "test0xx" }, { "TestProject__age__CST": null, "TestProject__length__CST": "456", "TestProject__name__CST": null, "createdBy": "10gd000000SDzgxNSckK", "createdBy.__objectType": "User", "createdBy.name": "test0xx", "createdDate": "2020-05-29 12:50:59", "currencyIsoCode": "", "id": "cglE000000aMGHkvmhma", "installedPackage": null, "lastModifiedBy": "10gd000000SDzgxNSckK", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test0xx", "lastModifiedDate": "2020-05-29 12:50:59", "name": "zhang", "owner": "10gd000000SDzgxNSckK", "owner.__objectType": "User", "owner.name": "test0xx" }, { "TestProject__age__CST": null, "TestProject__length__CST": "17", "TestProject__name__CST": null, "createdBy": "10gd000000SDzgxNSckK", "createdBy.__objectType": "User", "createdBy.name": "test0xx", "createdDate": "2020-05-29 12:43:11", "currencyIsoCode": "", "id": "cglE000000aMFjB9ipAu", "installedPackage": null, "lastModifiedBy": "10gd000000SDzgxNSckK", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test0xx", "lastModifiedDate": "2020-05-29 12:43:11", "name": "zhang", "owner": "10gd000000SDzgxNSckK", "owner.__objectType": "User", "owner.name": "test0xx" } ], "count": 5 }
  • 响应示例 { "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 AstroZero域名/u-route/baas/metadata/v1.0/object/{object_id}/Layout/{layout_id} 表1 路径参数 参数 是否必选 参数类型 描述 object_Id 是 String 参数解释: 对象的ID值,可通过调用查询所有自定义对象接口查看(响应消息中的“id”)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 layout_id 是 String 参数解释: Layout的ID值,可通过调用5.2.3.9-根据object_id查询layout接口查看(响应消息中的“id”)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 响应示例 { "resCode": "0", "resMsg": "成功", "result": [ { "active": false, "belongTo": null, "createdBy": "10gd000001DHHEwmE1NQ", "createdBy.__objectType": "User", "createdBy.name": "test00xx", "createdDate": "2024-06-07 11:29:52", "custom": true, "description": "dasdas", "errorExpression": "CONTAINS(name, 'aa')!=true", "errorLocation": "topOfPage", "errorMessage": "name must contains 'aa'", "field": null, "id": "001j000001DhzDVw81Vw", "installedPackage": null, "label": "tbq1dasdasssssssssssssssssss", "lastModifiedBy": "10gd000001DHHEwmE1NQ", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test00xx", "lastModifiedDate": "2024-06-07 11:34:50", "name": "tbq1dadasdssssssssssssssssss", "objectId": "cust000001Dgez2L19N2", "objectId.__objectType": "Object", "objectId.name": "Test__t1__CST", "owner": "10gd000001DHHEwmE1NQ", "owner.__objectType": "User", "owner.name": "test00xx", "protectMode": 0, "visibility": 0 } ] }
  • 响应参数 表3 响应参数 参数 参数类型 描述 resCode String 参数解释: 返回码。 取值范围: 如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 如果成功状态,通常会返回“Success”,其他情况会返回具体的错误信息。 result string 参数解释: 成功返回会返回Object的一个ID值。 取值范围: 不涉及。
  • 请求示例 根据object_id为Object添加字段。 POST https://AstroZero域名/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" ] } } }
  • 请求参数 表2 请求body参数 参数 是否必选 参数类型 描述 name 是 String 参数解释: 新增字段的名称。 约束限制: 创建后不可修改。 取值范围: 必须以英文字母开头,只能由英文字母,数字和单下划线组成,不允许下划线结尾,且长度不能超过63个字符。 默认取值: 不涉及。 label 是 String 参数解释: 新增字段的标签。 约束限制: 不涉及。 取值范围: 1~80个字符。 默认取值: 不涉及。 inlineHelpText 否 String 参数解释: 新增字段的帮助说明。 约束限制: 不涉及。 取值范围: 1~255个字符。 默认取值: 不涉及。 dataLength 是 Int 参数解释: 新增字段的长度。 约束限制: 不涉及。 取值范围: 1~64个字符。 默认取值: 不涉及。 dataType 是 String 参数解释: 新增字段的类型。 约束限制: 创建后不可修改。 取值范围: 不涉及。 默认取值: 不涉及。 description 否 String 参数解释: 新增字段的描述信息。 约束限制: 不涉及。 取值范围: 1~80个字符。 默认取值: 不涉及。 defaultValue 否 String 参数解释: 新增字段的默认值。 约束限制: 格式需符合“字段类型”和“字段长度”的规则。 取值范围: 不涉及。 默认取值: 不涉及。 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。
  • 请求参数 表2 请求参数 参数 是否必选 参数类型 描述 condition 是 Object 参数解释: 表示查询的条件。 约束限制: 包含以下三个元素,若为空则表示查询所有对象数据。 conjunction:表示需要满足的条件个数。 AND:表示条件都要满足。 OR:表示至少要满足一个条件。 conditions:筛选条件的数组。如果参数为空,代表查询所有对象数据,若不为空,其中的每一个元素对象都包含三个字段: field:字段名称。 operator:操作符。例如,操作符“eq”表示等于,“ne”表示不等于,“gt”表示大于,“lt”表示小于,“ge”表示大于等于,“le”表示小于等于。 value:对比值。 relation:数组中包含parents(向上查询)和children(向下查询)两个元素,两者分别对应相应的数组。 其中,parents包含condition数组和relatedField(关联字段名称)。children包含condition数组和relationName(关联字段名称)。
  • 请求示例 查询“TestProject__testForObject1__CST”对象中,name为“lisi”的记录数。 POST https://AstroZero域名/u-route/baas/data/v1.0/count/TestProject__testForObject1__CST { "condition": { "conjunction": "AND", "conditions": [ { "field": "NAME", "operator": "eq", "value": "lisi" } ] } }
  • URI POST AstroZero域名/u-route/baas/data/v1.0/count/{objectName}?base=X 表1 路径参数 参数 是否必选 参数类型 描述 objectName 是 String 参数解释: 数据对象的名称。 约束限制: 不涉及。 取值范围: 1~80个字符。 默认取值: 不涉及。 base 否 String 参数解释: 查询参数,用于区分objectName传入数据样式。 约束限制: 不涉及。 取值范围: 支持如下选项: I:对应对象的ID。 N:传入的对象名称。 默认取值: 不涉及。
  • 响应示例 { "resCode": "0", "resMsg": "成功", "result": [ { "id": "cglE000000aMFjB9ipAu" }, { "id": "cglE000000aMFjB9ipAv" }, { "id": "cglE000000aMFjB9ipAw" } ] }
共100000条