文档首页> 应用魔方 AppCube> API参考> 快速入门> 创建对象并定义字段
更新时间:2022-04-27 GMT+08:00
分享

创建对象并定义字段

场景描述

创建一个车辆类型对象VehicleType,并定义字段,用于保存车辆类型、类型编号信息。

下面介绍如何调用创建对象并定义字段API,API的调用方法请参见如何调用API

创建对象

  1. 根据请求URI和请求方法,明确请求如下:

    POST https://appcube.cn-north-4.huaweicloud.com/u-route/baas/metadata/v1.0/object

  2. 设置请求消息头。

    表1 请求消息头

    消息头名称

    描述

    是否必选

    Content-Type

    HTTP协议中设定的一个参数,用于标识返回的内容用什么格式去解析,此处必须配置为“application/json”。表示浏览器将返回内容解析为json对象。

    access-token

    当用户登录系统鉴权成功后,后台会生成一个token,在响应消息中携带,并存在浏览器中。下次再调用请求后,会带上这个token,表示这个用户已经被鉴权过。

  3. 构造请求消息体。

    {
        "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"
    }

自定义字段

  1. 根据请求URI和请求方法,明确请求如下,其中“cust000000aHYAsrPh4K”为对象ID:

    POST https://appcube.cn-north-4.huaweicloud.com/u-route/baas/metadata/v1.0/object/cust000000aHYAsrPh4K/fields

  2. 设置请求消息头。

    表2 请求消息头

    消息头名称

    描述

    是否必选

    Content-Type

    HTTP协议中设定的一个参数,用于标识返回的内容用什么格式去解析,此处必须配置为“application/json”。表示浏览器将返回内容解析为json对象。

    access-token

    当用户登录系统鉴权成功后,后台会生成一个token,在响应消息中携带,并存在浏览器中。下次再调用请求后,会带上这个token,表示这个用户已经被鉴权过。

  3. 构造请求消息体,创建“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"
        ]
    }

分享:

    相关文档

    相关产品

close